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

# Functions

NewEnroll creates a new http.Handler for the enroll operation.
NewEnrollCa creates a new http.Handler for the enroll ca operation.
NewEnrollCaNotFound creates EnrollCaNotFound with default headers values.
NewEnrollCaOK creates EnrollCaOK with default headers values.
NewEnrollCaParams creates a new EnrollCaParams object There are no default values defined in the spec.
NewEnrollCaTooManyRequests creates EnrollCaTooManyRequests with default headers values.
NewEnrollErOtt creates a new http.Handler for the enroll er ott operation.
NewEnrollErOttOK creates EnrollErOttOK with default headers values.
NewEnrollErOttParams creates a new EnrollErOttParams object There are no default values defined in the spec.
NewEnrollErOttTooManyRequests creates EnrollErOttTooManyRequests with default headers values.
NewEnrollmentChallenge creates a new http.Handler for the enrollment challenge operation.
NewEnrollmentChallengeBadRequest creates EnrollmentChallengeBadRequest with default headers values.
NewEnrollmentChallengeOK creates EnrollmentChallengeOK with default headers values.
NewEnrollmentChallengeParams creates a new EnrollmentChallengeParams object There are no default values defined in the spec.
NewEnrollmentChallengeTooManyRequests creates EnrollmentChallengeTooManyRequests with default headers values.
NewEnrollNotFound creates EnrollNotFound with default headers values.
NewEnrollOK creates EnrollOK with default headers values.
NewEnrollOtt creates a new http.Handler for the enroll ott operation.
NewEnrollOttCa creates a new http.Handler for the enroll ott ca operation.
NewEnrollOttCaOK creates EnrollOttCaOK with default headers values.
NewEnrollOttCaParams creates a new EnrollOttCaParams object There are no default values defined in the spec.
NewEnrollOttCaTooManyRequests creates EnrollOttCaTooManyRequests with default headers values.
NewEnrollOttNotFound creates EnrollOttNotFound with default headers values.
NewEnrollOttOK creates EnrollOttOK with default headers values.
NewEnrollOttParams creates a new EnrollOttParams object There are no default values defined in the spec.
NewEnrollOttTooManyRequests creates EnrollOttTooManyRequests with default headers values.
NewEnrollParams creates a new EnrollParams object There are no default values defined in the spec.
NewEnrollTooManyRequests creates EnrollTooManyRequests with default headers values.
NewEnrollUpdb creates a new http.Handler for the enroll updb operation.
NewEnrollUpdbNotFound creates EnrollUpdbNotFound with default headers values.
NewEnrollUpdbOK creates EnrollUpdbOK with default headers values.
NewEnrollUpdbParams creates a new EnrollUpdbParams object There are no default values defined in the spec.
NewEnrollUpdbTooManyRequests creates EnrollUpdbTooManyRequests with default headers values.
NewExtendRouterEnrollment creates a new http.Handler for the extend router enrollment operation.
NewExtendRouterEnrollmentOK creates ExtendRouterEnrollmentOK with default headers values.
NewExtendRouterEnrollmentParams creates a new ExtendRouterEnrollmentParams object There are no default values defined in the spec.
NewExtendRouterEnrollmentTooManyRequests creates ExtendRouterEnrollmentTooManyRequests with default headers values.
NewExtendRouterEnrollmentUnauthorized creates ExtendRouterEnrollmentUnauthorized with default headers values.
NewGetEnrollmentJwks creates a new http.Handler for the get enrollment jwks operation.
NewGetEnrollmentJwksOK creates GetEnrollmentJwksOK with default headers values.
NewGetEnrollmentJwksParams creates a new GetEnrollmentJwksParams object There are no default values defined in the spec.

# Constants

EnrollCaNotFoundCode is the HTTP code returned for type EnrollCaNotFound.
EnrollCaOKCode is the HTTP code returned for type EnrollCaOK.
EnrollCaTooManyRequestsCode is the HTTP code returned for type EnrollCaTooManyRequests.
EnrollErOttOKCode is the HTTP code returned for type EnrollErOttOK.
EnrollErOttTooManyRequestsCode is the HTTP code returned for type EnrollErOttTooManyRequests.
EnrollmentChallengeBadRequestCode is the HTTP code returned for type EnrollmentChallengeBadRequest.
EnrollmentChallengeOKCode is the HTTP code returned for type EnrollmentChallengeOK.
EnrollmentChallengeTooManyRequestsCode is the HTTP code returned for type EnrollmentChallengeTooManyRequests.
EnrollNotFoundCode is the HTTP code returned for type EnrollNotFound.
EnrollOKCode is the HTTP code returned for type EnrollOK.
EnrollOttCaOKCode is the HTTP code returned for type EnrollOttCaOK.
EnrollOttCaTooManyRequestsCode is the HTTP code returned for type EnrollOttCaTooManyRequests.
EnrollOttNotFoundCode is the HTTP code returned for type EnrollOttNotFound.
EnrollOttOKCode is the HTTP code returned for type EnrollOttOK.
EnrollOttTooManyRequestsCode is the HTTP code returned for type EnrollOttTooManyRequests.
EnrollTooManyRequestsCode is the HTTP code returned for type EnrollTooManyRequests.
EnrollUpdbNotFoundCode is the HTTP code returned for type EnrollUpdbNotFound.
EnrollUpdbOKCode is the HTTP code returned for type EnrollUpdbOK.
EnrollUpdbTooManyRequestsCode is the HTTP code returned for type EnrollUpdbTooManyRequests.
ExtendRouterEnrollmentOKCode is the HTTP code returned for type ExtendRouterEnrollmentOK.
ExtendRouterEnrollmentTooManyRequestsCode is the HTTP code returned for type ExtendRouterEnrollmentTooManyRequests.
ExtendRouterEnrollmentUnauthorizedCode is the HTTP code returned for type ExtendRouterEnrollmentUnauthorized.
GetEnrollmentJwksOKCode is the HTTP code returned for type GetEnrollmentJwksOK.

# Structs

Enroll swagger:route POST /enroll Enroll enroll Enroll an identity via one-time-token present a OTT and CSR to receive a long-lived client certificate */.
EnrollCa swagger:route POST /enroll/ca Enroll enrollCa Enroll an identity with a pre-exchanged certificate For CA auto enrollment, an identity is not created beforehand.
EnrollCaNotFound The requested resource does not exist swagger:response enrollCaNotFound */.
EnrollCaOK Base empty response swagger:response enrollCaOK */.
EnrollCaParams contains all the bound params for the enroll ca operation typically these are obtained from a http.Request swagger:parameters enrollCa.
EnrollCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollCaTooManyRequests */.
EnrollCaURL generates an URL for the enroll ca operation.
EnrollErOtt swagger:route POST /enroll/erott Enroll enrollErOtt Enroll an edge-router Enrolls an edge-router via a one-time-token to establish a certificate based identity.
EnrollErOttOK A response containing the edge routers signed certificates (server chain, server cert, CAs).
EnrollErOttParams contains all the bound params for the enroll er ott operation typically these are obtained from a http.Request swagger:parameters enrollErOtt.
EnrollErOttTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollErOttTooManyRequests */.
EnrollErOttURL generates an URL for the enroll er ott operation.
EnrollmentChallenge swagger:route POST /enroll/challenge Enroll enrollmentChallenge Allows verification of a controller or cluster of controllers as being the valid target for enrollment.
EnrollmentChallengeBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
EnrollmentChallengeOK A nonce challenge response.
EnrollmentChallengeParams contains all the bound params for the enrollment challenge operation typically these are obtained from a http.Request swagger:parameters enrollmentChallenge.
EnrollmentChallengeTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollmentChallengeTooManyRequests */.
EnrollmentChallengeURL generates an URL for the enrollment challenge operation.
EnrollNotFound The requested resource does not exist swagger:response enrollNotFound */.
EnrollOK A response for multi-format legacy enrollment.
EnrollOtt swagger:route POST /enroll/ott Enroll enrollOtt Enroll an identity via one-time-token Enroll an identity via a one-time-token which is supplied via a query string parameter.
EnrollOttCa swagger:route POST /enroll/ottca Enroll enrollOttCa Enroll an identity via one-time-token with a pre-exchanged client certificate Enroll an identity via a one-time-token that also requires a pre-exchanged client certificate to match a Certificate Authority that has been added and verified (See POST /cas and POST /cas{id}/verify).
EnrollOttCaOK Base empty response swagger:response enrollOttCaOK */.
EnrollOttCaParams contains all the bound params for the enroll ott ca operation typically these are obtained from a http.Request swagger:parameters enrollOttCa.
EnrollOttCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollOttCaTooManyRequests */.
EnrollOttCaURL generates an URL for the enroll ott ca operation.
EnrollOttNotFound The requested resource does not exist swagger:response enrollOttNotFound */.
EnrollOttOK A response containing and identities client certificate chains swagger:response enrollOttOK */.
EnrollOttParams contains all the bound params for the enroll ott operation typically these are obtained from a http.Request swagger:parameters enrollOtt.
EnrollOttTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollOttTooManyRequests */.
EnrollOttURL generates an URL for the enroll ott operation.
EnrollParams contains all the bound params for the enroll operation typically these are obtained from a http.Request swagger:parameters enroll.
EnrollTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollTooManyRequests */.
EnrollUpdb swagger:route POST /enroll/updb Enroll enrollUpdb Enroll an identity via one-time-token Enrolls an identity via a one-time-token to establish an initial username and password combination */.
EnrollUpdbBody enroll updb body swagger:model EnrollUpdbBody.
EnrollUpdbNotFound The requested resource does not exist swagger:response enrollUpdbNotFound */.
EnrollUpdbOK Base empty response swagger:response enrollUpdbOK */.
EnrollUpdbParams contains all the bound params for the enroll updb operation typically these are obtained from a http.Request swagger:parameters enrollUpdb.
EnrollUpdbTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response enrollUpdbTooManyRequests */.
EnrollUpdbURL generates an URL for the enroll updb operation.
EnrollURL generates an URL for the enroll operation.
ExtendRouterEnrollment swagger:route POST /enroll/extend/router Enroll Extend Enrollment extendRouterEnrollment Extend the life of a currently enrolled router's certificates Allows a router to extend its certificates' expiration date by using its current and valid client certificate to submit a CSR.
ExtendRouterEnrollmentOK A response containing the edge routers new signed certificates (server chain, server cert, CAs).
ExtendRouterEnrollmentParams contains all the bound params for the extend router enrollment operation typically these are obtained from a http.Request swagger:parameters extendRouterEnrollment.
ExtendRouterEnrollmentTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response extendRouterEnrollmentTooManyRequests */.
ExtendRouterEnrollmentUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response extendRouterEnrollmentUnauthorized */.
ExtendRouterEnrollmentURL generates an URL for the extend router enrollment operation.
GetEnrollmentJwks swagger:route GET /enroll/jwks Enroll getEnrollmentJwks List JSON Web Keys associated with enrollment Returns a list of JSON Web Keys (JWKS) that are used for enrollment signing.
GetEnrollmentJwksOK A JWKS response for enrollment.
GetEnrollmentJwksParams contains all the bound params for the get enrollment jwks operation typically these are obtained from a http.Request swagger:parameters getEnrollmentJwks.
GetEnrollmentJwksURL generates an URL for the get enrollment jwks operation.

# Interfaces

EnrollCaHandler interface for that can handle valid enroll ca params.
EnrollErOttHandler interface for that can handle valid enroll er ott params.
EnrollHandler interface for that can handle valid enroll params.
EnrollmentChallengeHandler interface for that can handle valid enrollment challenge params.
EnrollOttCaHandler interface for that can handle valid enroll ott ca params.
EnrollOttHandler interface for that can handle valid enroll ott params.
EnrollUpdbHandler interface for that can handle valid enroll updb params.
ExtendRouterEnrollmentHandler interface for that can handle valid extend router enrollment params.
GetEnrollmentJwksHandler interface for that can handle valid get enrollment jwks params.

# Type aliases

EnrollCaHandlerFunc turns a function with the right signature into a enroll ca handler.
EnrollErOttHandlerFunc turns a function with the right signature into a enroll er ott handler.
EnrollHandlerFunc turns a function with the right signature into a enroll handler.
EnrollmentChallengeHandlerFunc turns a function with the right signature into a enrollment challenge handler.
EnrollOttCaHandlerFunc turns a function with the right signature into a enroll ott ca handler.
EnrollOttHandlerFunc turns a function with the right signature into a enroll ott handler.
EnrollUpdbHandlerFunc turns a function with the right signature into a enroll updb handler.
ExtendRouterEnrollmentHandlerFunc turns a function with the right signature into a extend router enrollment handler.
GetEnrollmentJwksHandlerFunc turns a function with the right signature into a get enrollment jwks handler.