package
0.26.33
Repository: https://github.com/openziti/edge-api.git
Documentation: pkg.go.dev

# Functions

NewAuthenticate creates a new http.Handler for the authenticate operation.
NewAuthenticateBadRequest creates AuthenticateBadRequest with default headers values.
NewAuthenticateMfa creates a new http.Handler for the authenticate mfa operation.
NewAuthenticateMfaOK creates AuthenticateMfaOK with default headers values.
NewAuthenticateMfaParams creates a new AuthenticateMfaParams object There are no default values defined in the spec.
NewAuthenticateMfaTooManyRequests creates AuthenticateMfaTooManyRequests with default headers values.
NewAuthenticateMfaUnauthorized creates AuthenticateMfaUnauthorized with default headers values.
NewAuthenticateOK creates AuthenticateOK with default headers values.
NewAuthenticateParams creates a new AuthenticateParams object There are no default values defined in the spec.
NewAuthenticateTooManyRequests creates AuthenticateTooManyRequests with default headers values.
NewAuthenticateUnauthorized creates AuthenticateUnauthorized with default headers values.

# Constants

AuthenticateBadRequestCode is the HTTP code returned for type AuthenticateBadRequest.
AuthenticateMfaOKCode is the HTTP code returned for type AuthenticateMfaOK.
AuthenticateMfaTooManyRequestsCode is the HTTP code returned for type AuthenticateMfaTooManyRequests.
AuthenticateMfaUnauthorizedCode is the HTTP code returned for type AuthenticateMfaUnauthorized.
AuthenticateOKCode is the HTTP code returned for type AuthenticateOK.
AuthenticateTooManyRequestsCode is the HTTP code returned for type AuthenticateTooManyRequests.
AuthenticateUnauthorizedCode is the HTTP code returned for type AuthenticateUnauthorized.

# Structs

Authenticate swagger:route POST /authenticate Authentication authenticate Authenticate via a method supplied via a query string parameter Allowed authentication methods include "password", "cert", and "ext-jwt" */.
AuthenticateBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
AuthenticateMfa swagger:route POST /authenticate/mfa Authentication MFA authenticateMfa Complete MFA authentication Completes MFA authentication by submitting a MFA time based one time token or backup code.
AuthenticateMfaOK Base empty response swagger:response authenticateMfaOK */.
AuthenticateMfaParams contains all the bound params for the authenticate mfa operation typically these are obtained from a http.Request swagger:parameters authenticateMfa.
AuthenticateMfaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response authenticateMfaTooManyRequests */.
AuthenticateMfaUnauthorized Base empty response swagger:response authenticateMfaUnauthorized */.
AuthenticateMfaURL generates an URL for the authenticate mfa operation.
AuthenticateOK The API session associated with the session used to issue the request swagger:response authenticateOK */.
AuthenticateParams contains all the bound params for the authenticate operation typically these are obtained from a http.Request swagger:parameters authenticate.
AuthenticateTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response authenticateTooManyRequests */.
AuthenticateUnauthorized The authentication request could not be processed as the credentials are invalid swagger:response authenticateUnauthorized */.
AuthenticateURL generates an URL for the authenticate operation.

# Interfaces

AuthenticateHandler interface for that can handle valid authenticate params.
AuthenticateMfaHandler interface for that can handle valid authenticate mfa params.

# Type aliases

AuthenticateHandlerFunc turns a function with the right signature into a authenticate handler.
AuthenticateMfaHandlerFunc turns a function with the right signature into a authenticate mfa handler.