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

# Functions

NewCreateAuthenticator creates a new http.Handler for the create authenticator operation.
NewCreateAuthenticatorBadRequest creates CreateAuthenticatorBadRequest with default headers values.
NewCreateAuthenticatorCreated creates CreateAuthenticatorCreated with default headers values.
NewCreateAuthenticatorParams creates a new CreateAuthenticatorParams object There are no default values defined in the spec.
NewCreateAuthenticatorTooManyRequests creates CreateAuthenticatorTooManyRequests with default headers values.
NewCreateAuthenticatorUnauthorized creates CreateAuthenticatorUnauthorized with default headers values.
NewDeleteAuthenticator creates a new http.Handler for the delete authenticator operation.
NewDeleteAuthenticatorBadRequest creates DeleteAuthenticatorBadRequest with default headers values.
NewDeleteAuthenticatorOK creates DeleteAuthenticatorOK with default headers values.
NewDeleteAuthenticatorParams creates a new DeleteAuthenticatorParams object There are no default values defined in the spec.
NewDeleteAuthenticatorTooManyRequests creates DeleteAuthenticatorTooManyRequests with default headers values.
NewDeleteAuthenticatorUnauthorized creates DeleteAuthenticatorUnauthorized with default headers values.
NewDetailAuthenticator creates a new http.Handler for the detail authenticator operation.
NewDetailAuthenticatorNotFound creates DetailAuthenticatorNotFound with default headers values.
NewDetailAuthenticatorOK creates DetailAuthenticatorOK with default headers values.
NewDetailAuthenticatorParams creates a new DetailAuthenticatorParams object There are no default values defined in the spec.
NewDetailAuthenticatorTooManyRequests creates DetailAuthenticatorTooManyRequests with default headers values.
NewDetailAuthenticatorUnauthorized creates DetailAuthenticatorUnauthorized with default headers values.
NewListAuthenticators creates a new http.Handler for the list authenticators operation.
NewListAuthenticatorsBadRequest creates ListAuthenticatorsBadRequest with default headers values.
NewListAuthenticatorsOK creates ListAuthenticatorsOK with default headers values.
NewListAuthenticatorsParams creates a new ListAuthenticatorsParams object There are no default values defined in the spec.
NewListAuthenticatorsTooManyRequests creates ListAuthenticatorsTooManyRequests with default headers values.
NewListAuthenticatorsUnauthorized creates ListAuthenticatorsUnauthorized with default headers values.
NewPatchAuthenticator creates a new http.Handler for the patch authenticator operation.
NewPatchAuthenticatorBadRequest creates PatchAuthenticatorBadRequest with default headers values.
NewPatchAuthenticatorNotFound creates PatchAuthenticatorNotFound with default headers values.
NewPatchAuthenticatorOK creates PatchAuthenticatorOK with default headers values.
NewPatchAuthenticatorParams creates a new PatchAuthenticatorParams object There are no default values defined in the spec.
NewPatchAuthenticatorTooManyRequests creates PatchAuthenticatorTooManyRequests with default headers values.
NewPatchAuthenticatorUnauthorized creates PatchAuthenticatorUnauthorized with default headers values.
NewReEnrollAuthenticator creates a new http.Handler for the re enroll authenticator operation.
NewReEnrollAuthenticatorCreated creates ReEnrollAuthenticatorCreated with default headers values.
NewReEnrollAuthenticatorNotFound creates ReEnrollAuthenticatorNotFound with default headers values.
NewReEnrollAuthenticatorParams creates a new ReEnrollAuthenticatorParams object There are no default values defined in the spec.
NewReEnrollAuthenticatorTooManyRequests creates ReEnrollAuthenticatorTooManyRequests with default headers values.
NewReEnrollAuthenticatorUnauthorized creates ReEnrollAuthenticatorUnauthorized with default headers values.
NewUpdateAuthenticator creates a new http.Handler for the update authenticator operation.
NewUpdateAuthenticatorBadRequest creates UpdateAuthenticatorBadRequest with default headers values.
NewUpdateAuthenticatorNotFound creates UpdateAuthenticatorNotFound with default headers values.
NewUpdateAuthenticatorOK creates UpdateAuthenticatorOK with default headers values.
NewUpdateAuthenticatorParams creates a new UpdateAuthenticatorParams object There are no default values defined in the spec.
NewUpdateAuthenticatorTooManyRequests creates UpdateAuthenticatorTooManyRequests with default headers values.
NewUpdateAuthenticatorUnauthorized creates UpdateAuthenticatorUnauthorized with default headers values.

# Constants

CreateAuthenticatorBadRequestCode is the HTTP code returned for type CreateAuthenticatorBadRequest.
CreateAuthenticatorCreatedCode is the HTTP code returned for type CreateAuthenticatorCreated.
CreateAuthenticatorTooManyRequestsCode is the HTTP code returned for type CreateAuthenticatorTooManyRequests.
CreateAuthenticatorUnauthorizedCode is the HTTP code returned for type CreateAuthenticatorUnauthorized.
DeleteAuthenticatorBadRequestCode is the HTTP code returned for type DeleteAuthenticatorBadRequest.
DeleteAuthenticatorOKCode is the HTTP code returned for type DeleteAuthenticatorOK.
DeleteAuthenticatorTooManyRequestsCode is the HTTP code returned for type DeleteAuthenticatorTooManyRequests.
DeleteAuthenticatorUnauthorizedCode is the HTTP code returned for type DeleteAuthenticatorUnauthorized.
DetailAuthenticatorNotFoundCode is the HTTP code returned for type DetailAuthenticatorNotFound.
DetailAuthenticatorOKCode is the HTTP code returned for type DetailAuthenticatorOK.
DetailAuthenticatorTooManyRequestsCode is the HTTP code returned for type DetailAuthenticatorTooManyRequests.
DetailAuthenticatorUnauthorizedCode is the HTTP code returned for type DetailAuthenticatorUnauthorized.
ListAuthenticatorsBadRequestCode is the HTTP code returned for type ListAuthenticatorsBadRequest.
ListAuthenticatorsOKCode is the HTTP code returned for type ListAuthenticatorsOK.
ListAuthenticatorsTooManyRequestsCode is the HTTP code returned for type ListAuthenticatorsTooManyRequests.
ListAuthenticatorsUnauthorizedCode is the HTTP code returned for type ListAuthenticatorsUnauthorized.
PatchAuthenticatorBadRequestCode is the HTTP code returned for type PatchAuthenticatorBadRequest.
PatchAuthenticatorNotFoundCode is the HTTP code returned for type PatchAuthenticatorNotFound.
PatchAuthenticatorOKCode is the HTTP code returned for type PatchAuthenticatorOK.
PatchAuthenticatorTooManyRequestsCode is the HTTP code returned for type PatchAuthenticatorTooManyRequests.
PatchAuthenticatorUnauthorizedCode is the HTTP code returned for type PatchAuthenticatorUnauthorized.
ReEnrollAuthenticatorCreatedCode is the HTTP code returned for type ReEnrollAuthenticatorCreated.
ReEnrollAuthenticatorNotFoundCode is the HTTP code returned for type ReEnrollAuthenticatorNotFound.
ReEnrollAuthenticatorTooManyRequestsCode is the HTTP code returned for type ReEnrollAuthenticatorTooManyRequests.
ReEnrollAuthenticatorUnauthorizedCode is the HTTP code returned for type ReEnrollAuthenticatorUnauthorized.
UpdateAuthenticatorBadRequestCode is the HTTP code returned for type UpdateAuthenticatorBadRequest.
UpdateAuthenticatorNotFoundCode is the HTTP code returned for type UpdateAuthenticatorNotFound.
UpdateAuthenticatorOKCode is the HTTP code returned for type UpdateAuthenticatorOK.
UpdateAuthenticatorTooManyRequestsCode is the HTTP code returned for type UpdateAuthenticatorTooManyRequests.
UpdateAuthenticatorUnauthorizedCode is the HTTP code returned for type UpdateAuthenticatorUnauthorized.

# Structs

CreateAuthenticator swagger:route POST /authenticators Authenticator createAuthenticator Creates an authenticator Creates an authenticator for a specific identity.
CreateAuthenticatorBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateAuthenticatorCreated The create request was successful and the resource has been added at the following location swagger:response createAuthenticatorCreated */.
CreateAuthenticatorParams contains all the bound params for the create authenticator operation typically these are obtained from a http.Request swagger:parameters createAuthenticator.
CreateAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createAuthenticatorTooManyRequests */.
CreateAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createAuthenticatorUnauthorized */.
CreateAuthenticatorURL generates an URL for the create authenticator operation.
DeleteAuthenticator swagger:route DELETE /authenticators/{id} Authenticator deleteAuthenticator Delete an Authenticator Delete an authenticator by id.
DeleteAuthenticatorBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteAuthenticatorOK The delete request was successful and the resource has been removed swagger:response deleteAuthenticatorOK */.
DeleteAuthenticatorParams contains all the bound params for the delete authenticator operation typically these are obtained from a http.Request swagger:parameters deleteAuthenticator.
DeleteAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteAuthenticatorTooManyRequests */.
DeleteAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteAuthenticatorUnauthorized */.
DeleteAuthenticatorURL generates an URL for the delete authenticator operation.
DetailAuthenticator swagger:route GET /authenticators/{id} Authenticator detailAuthenticator Retrieves a single authenticator Retrieves a single authenticator by id.
DetailAuthenticatorNotFound The requested resource does not exist swagger:response detailAuthenticatorNotFound */.
DetailAuthenticatorOK A singular authenticator resource swagger:response detailAuthenticatorOK */.
DetailAuthenticatorParams contains all the bound params for the detail authenticator operation typically these are obtained from a http.Request swagger:parameters detailAuthenticator.
DetailAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailAuthenticatorTooManyRequests */.
DetailAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailAuthenticatorUnauthorized */.
DetailAuthenticatorURL generates an URL for the detail authenticator operation.
ListAuthenticators swagger:route GET /authenticators Authenticator listAuthenticators List authenticators Returns a list of authenticators associated to identities.
ListAuthenticatorsBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListAuthenticatorsOK A list of authenticators swagger:response listAuthenticatorsOK */.
ListAuthenticatorsParams contains all the bound params for the list authenticators operation typically these are obtained from a http.Request swagger:parameters listAuthenticators.
ListAuthenticatorsTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listAuthenticatorsTooManyRequests */.
ListAuthenticatorsUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listAuthenticatorsUnauthorized */.
ListAuthenticatorsURL generates an URL for the list authenticators operation.
PatchAuthenticator swagger:route PATCH /authenticators/{id} Authenticator patchAuthenticator Update the supplied fields on an authenticator Update the supplied fields on an authenticator by id.
PatchAuthenticatorBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchAuthenticatorNotFound The requested resource does not exist swagger:response patchAuthenticatorNotFound */.
PatchAuthenticatorOK The patch request was successful and the resource has been altered swagger:response patchAuthenticatorOK */.
PatchAuthenticatorParams contains all the bound params for the patch authenticator operation typically these are obtained from a http.Request swagger:parameters patchAuthenticator.
PatchAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchAuthenticatorTooManyRequests */.
PatchAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchAuthenticatorUnauthorized */.
PatchAuthenticatorURL generates an URL for the patch authenticator operation.
ReEnrollAuthenticator swagger:route POST /authenticators/{id}/re-enroll Authenticator reEnrollAuthenticator Reverts an authenticator to an enrollment Allows an authenticator to be reverted to an enrollment and allows re-enrollment to occur.
ReEnrollAuthenticatorCreated The create request was successful and the resource has been added at the following location swagger:response reEnrollAuthenticatorCreated */.
ReEnrollAuthenticatorNotFound The requested resource does not exist swagger:response reEnrollAuthenticatorNotFound */.
ReEnrollAuthenticatorParams contains all the bound params for the re enroll authenticator operation typically these are obtained from a http.Request swagger:parameters reEnrollAuthenticator.
ReEnrollAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response reEnrollAuthenticatorTooManyRequests */.
ReEnrollAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response reEnrollAuthenticatorUnauthorized */.
ReEnrollAuthenticatorURL generates an URL for the re enroll authenticator operation.
UpdateAuthenticator swagger:route PUT /authenticators/{id} Authenticator updateAuthenticator Update all fields on an authenticator Update all fields on an authenticator by id.
UpdateAuthenticatorBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateAuthenticatorNotFound The requested resource does not exist swagger:response updateAuthenticatorNotFound */.
UpdateAuthenticatorOK The update request was successful and the resource has been altered swagger:response updateAuthenticatorOK */.
UpdateAuthenticatorParams contains all the bound params for the update authenticator operation typically these are obtained from a http.Request swagger:parameters updateAuthenticator.
UpdateAuthenticatorTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateAuthenticatorTooManyRequests */.
UpdateAuthenticatorUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateAuthenticatorUnauthorized */.
UpdateAuthenticatorURL generates an URL for the update authenticator operation.

# Interfaces

CreateAuthenticatorHandler interface for that can handle valid create authenticator params.
DeleteAuthenticatorHandler interface for that can handle valid delete authenticator params.
DetailAuthenticatorHandler interface for that can handle valid detail authenticator params.
ListAuthenticatorsHandler interface for that can handle valid list authenticators params.
PatchAuthenticatorHandler interface for that can handle valid patch authenticator params.
ReEnrollAuthenticatorHandler interface for that can handle valid re enroll authenticator params.
UpdateAuthenticatorHandler interface for that can handle valid update authenticator params.

# Type aliases

CreateAuthenticatorHandlerFunc turns a function with the right signature into a create authenticator handler.
DeleteAuthenticatorHandlerFunc turns a function with the right signature into a delete authenticator handler.
DetailAuthenticatorHandlerFunc turns a function with the right signature into a detail authenticator handler.
ListAuthenticatorsHandlerFunc turns a function with the right signature into a list authenticators handler.
PatchAuthenticatorHandlerFunc turns a function with the right signature into a patch authenticator handler.
ReEnrollAuthenticatorHandlerFunc turns a function with the right signature into a re enroll authenticator handler.
UpdateAuthenticatorHandlerFunc turns a function with the right signature into a update authenticator handler.