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

# Functions

NewCreateEnrollment creates a new http.Handler for the create enrollment operation.
NewCreateEnrollmentBadRequest creates CreateEnrollmentBadRequest with default headers values.
NewCreateEnrollmentConflict creates CreateEnrollmentConflict with default headers values.
NewCreateEnrollmentCreated creates CreateEnrollmentCreated with default headers values.
NewCreateEnrollmentParams creates a new CreateEnrollmentParams object There are no default values defined in the spec.
NewCreateEnrollmentTooManyRequests creates CreateEnrollmentTooManyRequests with default headers values.
NewCreateEnrollmentUnauthorized creates CreateEnrollmentUnauthorized with default headers values.
NewDeleteEnrollment creates a new http.Handler for the delete enrollment operation.
NewDeleteEnrollmentBadRequest creates DeleteEnrollmentBadRequest with default headers values.
NewDeleteEnrollmentOK creates DeleteEnrollmentOK with default headers values.
NewDeleteEnrollmentParams creates a new DeleteEnrollmentParams object There are no default values defined in the spec.
NewDeleteEnrollmentTooManyRequests creates DeleteEnrollmentTooManyRequests with default headers values.
NewDeleteEnrollmentUnauthorized creates DeleteEnrollmentUnauthorized with default headers values.
NewDetailEnrollment creates a new http.Handler for the detail enrollment operation.
NewDetailEnrollmentNotFound creates DetailEnrollmentNotFound with default headers values.
NewDetailEnrollmentOK creates DetailEnrollmentOK with default headers values.
NewDetailEnrollmentParams creates a new DetailEnrollmentParams object There are no default values defined in the spec.
NewDetailEnrollmentTooManyRequests creates DetailEnrollmentTooManyRequests with default headers values.
NewDetailEnrollmentUnauthorized creates DetailEnrollmentUnauthorized with default headers values.
NewListEnrollments creates a new http.Handler for the list enrollments operation.
NewListEnrollmentsBadRequest creates ListEnrollmentsBadRequest with default headers values.
NewListEnrollmentsOK creates ListEnrollmentsOK with default headers values.
NewListEnrollmentsParams creates a new ListEnrollmentsParams object There are no default values defined in the spec.
NewListEnrollmentsTooManyRequests creates ListEnrollmentsTooManyRequests with default headers values.
NewListEnrollmentsUnauthorized creates ListEnrollmentsUnauthorized with default headers values.
NewRefreshEnrollment creates a new http.Handler for the refresh enrollment operation.
NewRefreshEnrollmentBadRequest creates RefreshEnrollmentBadRequest with default headers values.
NewRefreshEnrollmentOK creates RefreshEnrollmentOK with default headers values.
NewRefreshEnrollmentParams creates a new RefreshEnrollmentParams object There are no default values defined in the spec.
NewRefreshEnrollmentTooManyRequests creates RefreshEnrollmentTooManyRequests with default headers values.
NewRefreshEnrollmentUnauthorized creates RefreshEnrollmentUnauthorized with default headers values.

# Constants

CreateEnrollmentBadRequestCode is the HTTP code returned for type CreateEnrollmentBadRequest.
CreateEnrollmentConflictCode is the HTTP code returned for type CreateEnrollmentConflict.
CreateEnrollmentCreatedCode is the HTTP code returned for type CreateEnrollmentCreated.
CreateEnrollmentTooManyRequestsCode is the HTTP code returned for type CreateEnrollmentTooManyRequests.
CreateEnrollmentUnauthorizedCode is the HTTP code returned for type CreateEnrollmentUnauthorized.
DeleteEnrollmentBadRequestCode is the HTTP code returned for type DeleteEnrollmentBadRequest.
DeleteEnrollmentOKCode is the HTTP code returned for type DeleteEnrollmentOK.
DeleteEnrollmentTooManyRequestsCode is the HTTP code returned for type DeleteEnrollmentTooManyRequests.
DeleteEnrollmentUnauthorizedCode is the HTTP code returned for type DeleteEnrollmentUnauthorized.
DetailEnrollmentNotFoundCode is the HTTP code returned for type DetailEnrollmentNotFound.
DetailEnrollmentOKCode is the HTTP code returned for type DetailEnrollmentOK.
DetailEnrollmentTooManyRequestsCode is the HTTP code returned for type DetailEnrollmentTooManyRequests.
DetailEnrollmentUnauthorizedCode is the HTTP code returned for type DetailEnrollmentUnauthorized.
ListEnrollmentsBadRequestCode is the HTTP code returned for type ListEnrollmentsBadRequest.
ListEnrollmentsOKCode is the HTTP code returned for type ListEnrollmentsOK.
ListEnrollmentsTooManyRequestsCode is the HTTP code returned for type ListEnrollmentsTooManyRequests.
ListEnrollmentsUnauthorizedCode is the HTTP code returned for type ListEnrollmentsUnauthorized.
RefreshEnrollmentBadRequestCode is the HTTP code returned for type RefreshEnrollmentBadRequest.
RefreshEnrollmentOKCode is the HTTP code returned for type RefreshEnrollmentOK.
RefreshEnrollmentTooManyRequestsCode is the HTTP code returned for type RefreshEnrollmentTooManyRequests.
RefreshEnrollmentUnauthorizedCode is the HTTP code returned for type RefreshEnrollmentUnauthorized.

# Structs

CreateEnrollment swagger:route POST /enrollments Enrollment createEnrollment Create an outstanding enrollment for an identity Creates a new OTT, OTTCA, or UPDB enrollment for a specific identity.
CreateEnrollmentBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateEnrollmentConflict The request could not be completed due to a conflict of configuration or state swagger:response createEnrollmentConflict */.
CreateEnrollmentCreated The create request was successful and the resource has been added at the following location swagger:response createEnrollmentCreated */.
CreateEnrollmentParams contains all the bound params for the create enrollment operation typically these are obtained from a http.Request swagger:parameters createEnrollment.
CreateEnrollmentTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createEnrollmentTooManyRequests */.
CreateEnrollmentUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createEnrollmentUnauthorized */.
CreateEnrollmentURL generates an URL for the create enrollment operation.
DeleteEnrollment swagger:route DELETE /enrollments/{id} Enrollment deleteEnrollment Delete an outstanding enrollment Delete an outstanding enrollment by id.
DeleteEnrollmentBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteEnrollmentOK The delete request was successful and the resource has been removed swagger:response deleteEnrollmentOK */.
DeleteEnrollmentParams contains all the bound params for the delete enrollment operation typically these are obtained from a http.Request swagger:parameters deleteEnrollment.
DeleteEnrollmentTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteEnrollmentTooManyRequests */.
DeleteEnrollmentUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteEnrollmentUnauthorized */.
DeleteEnrollmentURL generates an URL for the delete enrollment operation.
DetailEnrollment swagger:route GET /enrollments/{id} Enrollment detailEnrollment Retrieves an outstanding enrollment Retrieves a single outstanding enrollment by id.
DetailEnrollmentNotFound The requested resource does not exist swagger:response detailEnrollmentNotFound */.
DetailEnrollmentOK A singular enrollment resource swagger:response detailEnrollmentOK */.
DetailEnrollmentParams contains all the bound params for the detail enrollment operation typically these are obtained from a http.Request swagger:parameters detailEnrollment.
DetailEnrollmentTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailEnrollmentTooManyRequests */.
DetailEnrollmentUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailEnrollmentUnauthorized */.
DetailEnrollmentURL generates an URL for the detail enrollment operation.
ListEnrollments swagger:route GET /enrollments Enrollment listEnrollments List outstanding enrollments Retrieves a list of outstanding enrollments; supports filtering, sorting, and pagination.
ListEnrollmentsBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListEnrollmentsOK A list of enrollments swagger:response listEnrollmentsOK */.
ListEnrollmentsParams contains all the bound params for the list enrollments operation typically these are obtained from a http.Request swagger:parameters listEnrollments.
ListEnrollmentsTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listEnrollmentsTooManyRequests */.
ListEnrollmentsUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listEnrollmentsUnauthorized */.
ListEnrollmentsURL generates an URL for the list enrollments operation.
RefreshEnrollment swagger:route POST /enrollments/{id}/refresh Enrollment refreshEnrollment Refreshes an enrollment record's expiration window For expired or unexpired enrollments, reset the expiration window.
RefreshEnrollmentBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
RefreshEnrollmentOK The create request was successful and the resource has been added at the following location swagger:response refreshEnrollmentOK */.
RefreshEnrollmentParams contains all the bound params for the refresh enrollment operation typically these are obtained from a http.Request swagger:parameters refreshEnrollment.
RefreshEnrollmentTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response refreshEnrollmentTooManyRequests */.
RefreshEnrollmentUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response refreshEnrollmentUnauthorized */.
RefreshEnrollmentURL generates an URL for the refresh enrollment operation.

# Interfaces

CreateEnrollmentHandler interface for that can handle valid create enrollment params.
DeleteEnrollmentHandler interface for that can handle valid delete enrollment params.
DetailEnrollmentHandler interface for that can handle valid detail enrollment params.
ListEnrollmentsHandler interface for that can handle valid list enrollments params.
RefreshEnrollmentHandler interface for that can handle valid refresh enrollment params.

# Type aliases

CreateEnrollmentHandlerFunc turns a function with the right signature into a create enrollment handler.
DeleteEnrollmentHandlerFunc turns a function with the right signature into a delete enrollment handler.
DetailEnrollmentHandlerFunc turns a function with the right signature into a detail enrollment handler.
ListEnrollmentsHandlerFunc turns a function with the right signature into a list enrollments handler.
RefreshEnrollmentHandlerFunc turns a function with the right signature into a refresh enrollment handler.