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

# Functions

NewCreateMfaRecoveryCodes creates a new http.Handler for the create mfa recovery codes operation.
NewCreateMfaRecoveryCodesNotFound creates CreateMfaRecoveryCodesNotFound with default headers values.
NewCreateMfaRecoveryCodesOK creates CreateMfaRecoveryCodesOK with default headers values.
NewCreateMfaRecoveryCodesParams creates a new CreateMfaRecoveryCodesParams object There are no default values defined in the spec.
NewCreateMfaRecoveryCodesUnauthorized creates CreateMfaRecoveryCodesUnauthorized with default headers values.
NewDeleteMfa creates a new http.Handler for the delete mfa operation.
NewDeleteMfaNotFound creates DeleteMfaNotFound with default headers values.
NewDeleteMfaOK creates DeleteMfaOK with default headers values.
NewDeleteMfaParams creates a new DeleteMfaParams object There are no default values defined in the spec.
NewDeleteMfaUnauthorized creates DeleteMfaUnauthorized with default headers values.
NewDetailMfa creates a new http.Handler for the detail mfa operation.
NewDetailMfaNotFound creates DetailMfaNotFound with default headers values.
NewDetailMfaOK creates DetailMfaOK with default headers values.
NewDetailMfaParams creates a new DetailMfaParams object There are no default values defined in the spec.
NewDetailMfaQrCode creates a new http.Handler for the detail mfa qr code operation.
NewDetailMfaQrCodeNotFound creates DetailMfaQrCodeNotFound with default headers values.
NewDetailMfaQrCodeOK creates DetailMfaQrCodeOK with default headers values.
NewDetailMfaQrCodeParams creates a new DetailMfaQrCodeParams object There are no default values defined in the spec.
NewDetailMfaRecoveryCodes creates a new http.Handler for the detail mfa recovery codes operation.
NewDetailMfaRecoveryCodesNotFound creates DetailMfaRecoveryCodesNotFound with default headers values.
NewDetailMfaRecoveryCodesOK creates DetailMfaRecoveryCodesOK with default headers values.
NewDetailMfaRecoveryCodesParams creates a new DetailMfaRecoveryCodesParams object There are no default values defined in the spec.
NewDetailMfaRecoveryCodesUnauthorized creates DetailMfaRecoveryCodesUnauthorized with default headers values.
NewDetailMfaUnauthorized creates DetailMfaUnauthorized with default headers values.
NewEnrollMfa creates a new http.Handler for the enroll mfa operation.
NewEnrollMfaConflict creates EnrollMfaConflict with default headers values.
NewEnrollMfaCreated creates EnrollMfaCreated with default headers values.
NewEnrollMfaParams creates a new EnrollMfaParams object There are no default values defined in the spec.
NewEnrollMfaUnauthorized creates EnrollMfaUnauthorized with default headers values.
NewGetCurrentIdentity creates a new http.Handler for the get current identity operation.
NewGetCurrentIdentityEdgeRouters creates a new http.Handler for the get current identity edge routers operation.
NewGetCurrentIdentityEdgeRoutersOK creates GetCurrentIdentityEdgeRoutersOK with default headers values.
NewGetCurrentIdentityEdgeRoutersParams creates a new GetCurrentIdentityEdgeRoutersParams object There are no default values defined in the spec.
NewGetCurrentIdentityEdgeRoutersTooManyRequests creates GetCurrentIdentityEdgeRoutersTooManyRequests with default headers values.
NewGetCurrentIdentityEdgeRoutersUnauthorized creates GetCurrentIdentityEdgeRoutersUnauthorized with default headers values.
NewGetCurrentIdentityOK creates GetCurrentIdentityOK with default headers values.
NewGetCurrentIdentityParams creates a new GetCurrentIdentityParams object There are no default values defined in the spec.
NewGetCurrentIdentityUnauthorized creates GetCurrentIdentityUnauthorized with default headers values.
NewVerifyMfa creates a new http.Handler for the verify mfa operation.
NewVerifyMfaNotFound creates VerifyMfaNotFound with default headers values.
NewVerifyMfaOK creates VerifyMfaOK with default headers values.
NewVerifyMfaParams creates a new VerifyMfaParams object There are no default values defined in the spec.
NewVerifyMfaUnauthorized creates VerifyMfaUnauthorized with default headers values.

# Constants

CreateMfaRecoveryCodesNotFoundCode is the HTTP code returned for type CreateMfaRecoveryCodesNotFound.
CreateMfaRecoveryCodesOKCode is the HTTP code returned for type CreateMfaRecoveryCodesOK.
CreateMfaRecoveryCodesUnauthorizedCode is the HTTP code returned for type CreateMfaRecoveryCodesUnauthorized.
DeleteMfaNotFoundCode is the HTTP code returned for type DeleteMfaNotFound.
DeleteMfaOKCode is the HTTP code returned for type DeleteMfaOK.
DeleteMfaUnauthorizedCode is the HTTP code returned for type DeleteMfaUnauthorized.
DetailMfaNotFoundCode is the HTTP code returned for type DetailMfaNotFound.
DetailMfaOKCode is the HTTP code returned for type DetailMfaOK.
DetailMfaQrCodeNotFoundCode is the HTTP code returned for type DetailMfaQrCodeNotFound.
DetailMfaQrCodeOKCode is the HTTP code returned for type DetailMfaQrCodeOK.
DetailMfaRecoveryCodesNotFoundCode is the HTTP code returned for type DetailMfaRecoveryCodesNotFound.
DetailMfaRecoveryCodesOKCode is the HTTP code returned for type DetailMfaRecoveryCodesOK.
DetailMfaRecoveryCodesUnauthorizedCode is the HTTP code returned for type DetailMfaRecoveryCodesUnauthorized.
DetailMfaUnauthorizedCode is the HTTP code returned for type DetailMfaUnauthorized.
EnrollMfaConflictCode is the HTTP code returned for type EnrollMfaConflict.
EnrollMfaCreatedCode is the HTTP code returned for type EnrollMfaCreated.
EnrollMfaUnauthorizedCode is the HTTP code returned for type EnrollMfaUnauthorized.
GetCurrentIdentityEdgeRoutersOKCode is the HTTP code returned for type GetCurrentIdentityEdgeRoutersOK.
GetCurrentIdentityEdgeRoutersTooManyRequestsCode is the HTTP code returned for type GetCurrentIdentityEdgeRoutersTooManyRequests.
GetCurrentIdentityEdgeRoutersUnauthorizedCode is the HTTP code returned for type GetCurrentIdentityEdgeRoutersUnauthorized.
GetCurrentIdentityOKCode is the HTTP code returned for type GetCurrentIdentityOK.
GetCurrentIdentityUnauthorizedCode is the HTTP code returned for type GetCurrentIdentityUnauthorized.
VerifyMfaNotFoundCode is the HTTP code returned for type VerifyMfaNotFound.
VerifyMfaOKCode is the HTTP code returned for type VerifyMfaOK.
VerifyMfaUnauthorizedCode is the HTTP code returned for type VerifyMfaUnauthorized.

# Structs

CreateMfaRecoveryCodes swagger:route POST /current-identity/mfa/recovery-codes Current Identity MFA createMfaRecoveryCodes For a completed MFA enrollment regenerate the recovery codes Allows regeneration of recovery codes of an MFA enrollment.
CreateMfaRecoveryCodesNotFound The requested resource does not exist swagger:response createMfaRecoveryCodesNotFound */.
CreateMfaRecoveryCodesOK Base empty response swagger:response createMfaRecoveryCodesOK */.
CreateMfaRecoveryCodesParams contains all the bound params for the create mfa recovery codes operation typically these are obtained from a http.Request swagger:parameters createMfaRecoveryCodes.
CreateMfaRecoveryCodesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createMfaRecoveryCodesUnauthorized */.
CreateMfaRecoveryCodesURL generates an URL for the create mfa recovery codes operation.
DeleteMfa swagger:route DELETE /current-identity/mfa Current Identity MFA deleteMfa Disable MFA for the current identity Disable MFA for the current identity.
DeleteMfaNotFound The requested resource does not exist swagger:response deleteMfaNotFound */.
DeleteMfaOK Base empty response swagger:response deleteMfaOK */.
DeleteMfaParams contains all the bound params for the delete mfa operation typically these are obtained from a http.Request swagger:parameters deleteMfa.
DeleteMfaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteMfaUnauthorized */.
DeleteMfaURL generates an URL for the delete mfa operation.
DetailMfa swagger:route GET /current-identity/mfa Current Identity MFA detailMfa Returns the current status of MFA enrollment Returns details about the current MFA enrollment.
DetailMfaNotFound The requested resource does not exist swagger:response detailMfaNotFound */.
DetailMfaOK The details of an MFA enrollment swagger:response detailMfaOK */.
DetailMfaParams contains all the bound params for the detail mfa operation typically these are obtained from a http.Request swagger:parameters detailMfa.
DetailMfaQrCode swagger:route GET /current-identity/mfa/qr-code Current Identity MFA detailMfaQrCode Show a QR code for unverified MFA enrollments Shows an QR code image for unverified MFA enrollments.
DetailMfaQrCodeNotFound No MFA enrollment or MFA enrollment is completed swagger:response detailMfaQrCodeNotFound */.
DetailMfaQrCodeOK OK swagger:response detailMfaQrCodeOK */.
DetailMfaQrCodeParams contains all the bound params for the detail mfa qr code operation typically these are obtained from a http.Request swagger:parameters detailMfaQrCode.
DetailMfaQrCodeURL generates an URL for the detail mfa qr code operation.
DetailMfaRecoveryCodes swagger:route GET /current-identity/mfa/recovery-codes Current Identity MFA detailMfaRecoveryCodes For a completed MFA enrollment view the current recovery codes Allows the viewing of recovery codes of an MFA enrollment.
DetailMfaRecoveryCodesNotFound The requested resource does not exist swagger:response detailMfaRecoveryCodesNotFound */.
DetailMfaRecoveryCodesOK The recovery codes of an MFA enrollment swagger:response detailMfaRecoveryCodesOK */.
DetailMfaRecoveryCodesParams contains all the bound params for the detail mfa recovery codes operation typically these are obtained from a http.Request swagger:parameters detailMfaRecoveryCodes.
DetailMfaRecoveryCodesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailMfaRecoveryCodesUnauthorized */.
DetailMfaRecoveryCodesURL generates an URL for the detail mfa recovery codes operation.
DetailMfaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailMfaUnauthorized */.
DetailMfaURL generates an URL for the detail mfa operation.
EnrollMfa swagger:route POST /current-identity/mfa Current Identity MFA enrollMfa Initiate MFA enrollment Allows authenticator based MFA enrollment.
EnrollMfaConflict The identity is already enrolled in MFA swagger:response enrollMfaConflict */.
EnrollMfaCreated The create request was successful and the resource has been added at the following location swagger:response enrollMfaCreated */.
EnrollMfaParams contains all the bound params for the enroll mfa operation typically these are obtained from a http.Request swagger:parameters enrollMfa.
EnrollMfaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response enrollMfaUnauthorized */.
EnrollMfaURL generates an URL for the enroll mfa operation.
GetCurrentIdentity swagger:route GET /current-identity Current Identity getCurrentIdentity Return the current identity Returns the identity associated with the API sessions used to issue the current request */.
GetCurrentIdentityEdgeRouters swagger:route GET /current-identity/edge-routers Current Identity Edge Router getCurrentIdentityEdgeRouters Return this list of Edge Routers the identity has access to Lists the Edge Routers that the current identity has access to via policies.
GetCurrentIdentityEdgeRoutersOK A list of edge routers swagger:response getCurrentIdentityEdgeRoutersOK */.
GetCurrentIdentityEdgeRoutersParams contains all the bound params for the get current identity edge routers operation typically these are obtained from a http.Request swagger:parameters getCurrentIdentityEdgeRouters.
GetCurrentIdentityEdgeRoutersTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response getCurrentIdentityEdgeRoutersTooManyRequests */.
GetCurrentIdentityEdgeRoutersUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response getCurrentIdentityEdgeRoutersUnauthorized */.
GetCurrentIdentityEdgeRoutersURL generates an URL for the get current identity edge routers operation.
GetCurrentIdentityOK The identity associated with the API Session used to issue the request swagger:response getCurrentIdentityOK */.
GetCurrentIdentityParams contains all the bound params for the get current identity operation typically these are obtained from a http.Request swagger:parameters getCurrentIdentity.
GetCurrentIdentityUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response getCurrentIdentityUnauthorized */.
GetCurrentIdentityURL generates an URL for the get current identity operation.
VerifyMfa swagger:route POST /current-identity/mfa/verify Current Identity MFA verifyMfa Complete MFA enrollment by verifying a time based one time token Completes MFA enrollment by accepting a time based one time password as verification.
VerifyMfaNotFound The requested resource does not exist swagger:response verifyMfaNotFound */.
VerifyMfaOK Base empty response swagger:response verifyMfaOK */.
VerifyMfaParams contains all the bound params for the verify mfa operation typically these are obtained from a http.Request swagger:parameters verifyMfa.
VerifyMfaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response verifyMfaUnauthorized */.
VerifyMfaURL generates an URL for the verify mfa operation.

# Interfaces

CreateMfaRecoveryCodesHandler interface for that can handle valid create mfa recovery codes params.
DeleteMfaHandler interface for that can handle valid delete mfa params.
DetailMfaHandler interface for that can handle valid detail mfa params.
DetailMfaQrCodeHandler interface for that can handle valid detail mfa qr code params.
DetailMfaRecoveryCodesHandler interface for that can handle valid detail mfa recovery codes params.
EnrollMfaHandler interface for that can handle valid enroll mfa params.
GetCurrentIdentityEdgeRoutersHandler interface for that can handle valid get current identity edge routers params.
GetCurrentIdentityHandler interface for that can handle valid get current identity params.
VerifyMfaHandler interface for that can handle valid verify mfa params.

# Type aliases

CreateMfaRecoveryCodesHandlerFunc turns a function with the right signature into a create mfa recovery codes handler.
DeleteMfaHandlerFunc turns a function with the right signature into a delete mfa handler.
DetailMfaHandlerFunc turns a function with the right signature into a detail mfa handler.
DetailMfaQrCodeHandlerFunc turns a function with the right signature into a detail mfa qr code handler.
DetailMfaRecoveryCodesHandlerFunc turns a function with the right signature into a detail mfa recovery codes handler.
EnrollMfaHandlerFunc turns a function with the right signature into a enroll mfa handler.
GetCurrentIdentityEdgeRoutersHandlerFunc turns a function with the right signature into a get current identity edge routers handler.
GetCurrentIdentityHandlerFunc turns a function with the right signature into a get current identity handler.
VerifyMfaHandlerFunc turns a function with the right signature into a verify mfa handler.