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

# Functions

NewCreateCa creates a new http.Handler for the create ca operation.
NewCreateCaBadRequest creates CreateCaBadRequest with default headers values.
NewCreateCaCreated creates CreateCaCreated with default headers values.
NewCreateCaParams creates a new CreateCaParams object There are no default values defined in the spec.
NewCreateCaTooManyRequests creates CreateCaTooManyRequests with default headers values.
NewCreateCaUnauthorized creates CreateCaUnauthorized with default headers values.
NewDeleteCa creates a new http.Handler for the delete ca operation.
NewDeleteCaBadRequest creates DeleteCaBadRequest with default headers values.
NewDeleteCaOK creates DeleteCaOK with default headers values.
NewDeleteCaParams creates a new DeleteCaParams object There are no default values defined in the spec.
NewDeleteCaTooManyRequests creates DeleteCaTooManyRequests with default headers values.
NewDeleteCaUnauthorized creates DeleteCaUnauthorized with default headers values.
NewDetailCa creates a new http.Handler for the detail ca operation.
NewDetailCaNotFound creates DetailCaNotFound with default headers values.
NewDetailCaOK creates DetailCaOK with default headers values.
NewDetailCaParams creates a new DetailCaParams object There are no default values defined in the spec.
NewDetailCaTooManyRequests creates DetailCaTooManyRequests with default headers values.
NewDetailCaUnauthorized creates DetailCaUnauthorized with default headers values.
NewGetCaJWT creates a new http.Handler for the get ca Jwt operation.
NewGetCaJWTNotFound creates GetCaJWTNotFound with default headers values.
NewGetCaJWTOK creates GetCaJWTOK with default headers values.
NewGetCaJWTParams creates a new GetCaJWTParams object There are no default values defined in the spec.
NewGetCaJWTTooManyRequests creates GetCaJWTTooManyRequests with default headers values.
NewGetCaJWTUnauthorized creates GetCaJWTUnauthorized with default headers values.
NewListCas creates a new http.Handler for the list cas operation.
NewListCasBadRequest creates ListCasBadRequest with default headers values.
NewListCasOK creates ListCasOK with default headers values.
NewListCasParams creates a new ListCasParams object There are no default values defined in the spec.
NewListCasTooManyRequests creates ListCasTooManyRequests with default headers values.
NewListCasUnauthorized creates ListCasUnauthorized with default headers values.
NewPatchCa creates a new http.Handler for the patch ca operation.
NewPatchCaBadRequest creates PatchCaBadRequest with default headers values.
NewPatchCaNotFound creates PatchCaNotFound with default headers values.
NewPatchCaOK creates PatchCaOK with default headers values.
NewPatchCaParams creates a new PatchCaParams object There are no default values defined in the spec.
NewPatchCaTooManyRequests creates PatchCaTooManyRequests with default headers values.
NewPatchCaUnauthorized creates PatchCaUnauthorized with default headers values.
NewUpdateCa creates a new http.Handler for the update ca operation.
NewUpdateCaBadRequest creates UpdateCaBadRequest with default headers values.
NewUpdateCaNotFound creates UpdateCaNotFound with default headers values.
NewUpdateCaOK creates UpdateCaOK with default headers values.
NewUpdateCaParams creates a new UpdateCaParams object There are no default values defined in the spec.
NewUpdateCaTooManyRequests creates UpdateCaTooManyRequests with default headers values.
NewUpdateCaUnauthorized creates UpdateCaUnauthorized with default headers values.
NewVerifyCa creates a new http.Handler for the verify ca operation.
NewVerifyCaBadRequest creates VerifyCaBadRequest with default headers values.
NewVerifyCaNotFound creates VerifyCaNotFound with default headers values.
NewVerifyCaOK creates VerifyCaOK with default headers values.
NewVerifyCaParams creates a new VerifyCaParams object There are no default values defined in the spec.
NewVerifyCaTooManyRequests creates VerifyCaTooManyRequests with default headers values.
NewVerifyCaUnauthorized creates VerifyCaUnauthorized with default headers values.

# Constants

CreateCaBadRequestCode is the HTTP code returned for type CreateCaBadRequest.
CreateCaCreatedCode is the HTTP code returned for type CreateCaCreated.
CreateCaTooManyRequestsCode is the HTTP code returned for type CreateCaTooManyRequests.
CreateCaUnauthorizedCode is the HTTP code returned for type CreateCaUnauthorized.
DeleteCaBadRequestCode is the HTTP code returned for type DeleteCaBadRequest.
DeleteCaOKCode is the HTTP code returned for type DeleteCaOK.
DeleteCaTooManyRequestsCode is the HTTP code returned for type DeleteCaTooManyRequests.
DeleteCaUnauthorizedCode is the HTTP code returned for type DeleteCaUnauthorized.
DetailCaNotFoundCode is the HTTP code returned for type DetailCaNotFound.
DetailCaOKCode is the HTTP code returned for type DetailCaOK.
DetailCaTooManyRequestsCode is the HTTP code returned for type DetailCaTooManyRequests.
DetailCaUnauthorizedCode is the HTTP code returned for type DetailCaUnauthorized.
GetCaJWTNotFoundCode is the HTTP code returned for type GetCaJWTNotFound.
GetCaJWTOKCode is the HTTP code returned for type GetCaJWTOK.
GetCaJWTTooManyRequestsCode is the HTTP code returned for type GetCaJWTTooManyRequests.
GetCaJWTUnauthorizedCode is the HTTP code returned for type GetCaJWTUnauthorized.
ListCasBadRequestCode is the HTTP code returned for type ListCasBadRequest.
ListCasOKCode is the HTTP code returned for type ListCasOK.
ListCasTooManyRequestsCode is the HTTP code returned for type ListCasTooManyRequests.
ListCasUnauthorizedCode is the HTTP code returned for type ListCasUnauthorized.
PatchCaBadRequestCode is the HTTP code returned for type PatchCaBadRequest.
PatchCaNotFoundCode is the HTTP code returned for type PatchCaNotFound.
PatchCaOKCode is the HTTP code returned for type PatchCaOK.
PatchCaTooManyRequestsCode is the HTTP code returned for type PatchCaTooManyRequests.
PatchCaUnauthorizedCode is the HTTP code returned for type PatchCaUnauthorized.
UpdateCaBadRequestCode is the HTTP code returned for type UpdateCaBadRequest.
UpdateCaNotFoundCode is the HTTP code returned for type UpdateCaNotFound.
UpdateCaOKCode is the HTTP code returned for type UpdateCaOK.
UpdateCaTooManyRequestsCode is the HTTP code returned for type UpdateCaTooManyRequests.
UpdateCaUnauthorizedCode is the HTTP code returned for type UpdateCaUnauthorized.
VerifyCaBadRequestCode is the HTTP code returned for type VerifyCaBadRequest.
VerifyCaNotFoundCode is the HTTP code returned for type VerifyCaNotFound.
VerifyCaOKCode is the HTTP code returned for type VerifyCaOK.
VerifyCaTooManyRequestsCode is the HTTP code returned for type VerifyCaTooManyRequests.
VerifyCaUnauthorizedCode is the HTTP code returned for type VerifyCaUnauthorized.

# Structs

CreateCa swagger:route POST /cas Certificate Authority createCa Creates a CA Creates a CA in an unverified state.
CreateCaBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateCaCreated The create request was successful and the resource has been added at the following location swagger:response createCaCreated */.
CreateCaParams contains all the bound params for the create ca operation typically these are obtained from a http.Request swagger:parameters createCa.
CreateCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createCaTooManyRequests */.
CreateCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createCaUnauthorized */.
CreateCaURL generates an URL for the create ca operation.
DeleteCa swagger:route DELETE /cas/{id} Certificate Authority deleteCa Delete a CA Delete a CA by id.
DeleteCaBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteCaOK The delete request was successful and the resource has been removed swagger:response deleteCaOK */.
DeleteCaParams contains all the bound params for the delete ca operation typically these are obtained from a http.Request swagger:parameters deleteCa.
DeleteCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteCaTooManyRequests */.
DeleteCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteCaUnauthorized */.
DeleteCaURL generates an URL for the delete ca operation.
DetailCa swagger:route GET /cas/{id} Certificate Authority detailCa Retrieves a single CA Retrieves a single CA by id.
DetailCaNotFound The requested resource does not exist swagger:response detailCaNotFound */.
DetailCaOK A singular Certificate Authority (CA) resource swagger:response detailCaOK */.
DetailCaParams contains all the bound params for the detail ca operation typically these are obtained from a http.Request swagger:parameters detailCa.
DetailCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailCaTooManyRequests */.
DetailCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailCaUnauthorized */.
DetailCaURL generates an URL for the detail ca operation.
GetCaJWT swagger:route GET /cas/{id}/jwt Certificate Authority getCaJwt Retrieve the enrollment JWT for a CA For CA auto enrollment, the enrollment JWT is static and provided on each CA resource.
GetCaJWTNotFound The requested resource does not exist swagger:response getCaJwtNotFound */.
GetCaJWTOK The result is the JWT text to validate the CA swagger:response getCaJwtOK */.
GetCaJWTParams contains all the bound params for the get ca Jwt operation typically these are obtained from a http.Request swagger:parameters getCaJwt.
GetCaJWTTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response getCaJwtTooManyRequests */.
GetCaJWTUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response getCaJwtUnauthorized */.
GetCaJWTURL generates an URL for the get ca Jwt operation.
ListCas swagger:route GET /cas Certificate Authority listCas List CAs Retrieves a list of CA resources; supports filtering, sorting, and pagination.
ListCasBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListCasOK A list of Certificate Authorities (CAs) swagger:response listCasOK */.
ListCasParams contains all the bound params for the list cas operation typically these are obtained from a http.Request swagger:parameters listCas.
ListCasTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listCasTooManyRequests */.
ListCasUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listCasUnauthorized */.
ListCasURL generates an URL for the list cas operation.
PatchCa swagger:route PATCH /cas/{id} Certificate Authority patchCa Update the supplied fields on a CA Update only the supplied fields on a CA by id.
PatchCaBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchCaNotFound The requested resource does not exist swagger:response patchCaNotFound */.
PatchCaOK The patch request was successful and the resource has been altered swagger:response patchCaOK */.
PatchCaParams contains all the bound params for the patch ca operation typically these are obtained from a http.Request swagger:parameters patchCa.
PatchCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchCaTooManyRequests */.
PatchCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchCaUnauthorized */.
PatchCaURL generates an URL for the patch ca operation.
UpdateCa swagger:route PUT /cas/{id} Certificate Authority updateCa Update all fields on a CA Update all fields on a CA by id.
UpdateCaBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateCaNotFound The requested resource does not exist swagger:response updateCaNotFound */.
UpdateCaOK The update request was successful and the resource has been altered swagger:response updateCaOK */.
UpdateCaParams contains all the bound params for the update ca operation typically these are obtained from a http.Request swagger:parameters updateCa.
UpdateCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateCaTooManyRequests */.
UpdateCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateCaUnauthorized */.
UpdateCaURL generates an URL for the update ca operation.
VerifyCa swagger:route POST /cas/{id}/verify Certificate Authority verifyCa Verify a CA Allows a CA to become verified by submitting a certificate in PEM format that has been signed by the target CA.
VerifyCaBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
VerifyCaNotFound The requested resource does not exist swagger:response verifyCaNotFound */.
VerifyCaOK Base empty response swagger:response verifyCaOK */.
VerifyCaParams contains all the bound params for the verify ca operation typically these are obtained from a http.Request swagger:parameters verifyCa.
VerifyCaTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response verifyCaTooManyRequests */.
VerifyCaUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response verifyCaUnauthorized */.
VerifyCaURL generates an URL for the verify ca operation.

# Interfaces

CreateCaHandler interface for that can handle valid create ca params.
DeleteCaHandler interface for that can handle valid delete ca params.
DetailCaHandler interface for that can handle valid detail ca params.
GetCaJWTHandler interface for that can handle valid get ca Jwt params.
ListCasHandler interface for that can handle valid list cas params.
PatchCaHandler interface for that can handle valid patch ca params.
UpdateCaHandler interface for that can handle valid update ca params.
VerifyCaHandler interface for that can handle valid verify ca params.

# Type aliases

CreateCaHandlerFunc turns a function with the right signature into a create ca handler.
DeleteCaHandlerFunc turns a function with the right signature into a delete ca handler.
DetailCaHandlerFunc turns a function with the right signature into a detail ca handler.
GetCaJWTHandlerFunc turns a function with the right signature into a get ca Jwt handler.
ListCasHandlerFunc turns a function with the right signature into a list cas handler.
PatchCaHandlerFunc turns a function with the right signature into a patch ca handler.
UpdateCaHandlerFunc turns a function with the right signature into a update ca handler.
VerifyCaHandlerFunc turns a function with the right signature into a verify ca handler.