Help us shape the future of Go! Take the 2026 Go Developer Survey

operations

package
v0.36.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 24 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ZitiEdgeClientAPI

type ZitiEdgeClientAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// ApplicationPkcs7Consumer registers a consumer for the following mime types:
	//   - application/pkcs7
	ApplicationPkcs7Consumer runtime.Consumer
	// ApplicationXPemFileConsumer registers a consumer for the following mime types:
	//   - application/x-pem-file
	ApplicationXPemFileConsumer runtime.Consumer
	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer
	// TxtConsumer registers a consumer for the following mime types:
	//   - text/plain
	TxtConsumer runtime.Consumer

	// ApplicationPkcs7MimeProducer registers a producer for the following mime types:
	//   - application/pkcs7-mime
	ApplicationPkcs7MimeProducer runtime.Producer
	// BinProducer registers a producer for the following mime types:
	//   - image/png
	BinProducer runtime.Producer
	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer
	// TextYamlProducer registers a producer for the following mime types:
	//   - text/yaml
	TextYamlProducer runtime.Producer

	// Oauth2Auth registers a function that takes an access token and a collection of required scopes and returns a principal
	// it performs authentication based on an oauth2 bearer token provided in the request
	Oauth2Auth func(string, []string) (any, error)

	// ZtSessionAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key zt-session provided in the header
	ZtSessionAuth func(string) (any, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// CurrentAPISessionDeleteCurrentAPISessionHandler sets the operation handler for the delete current API session operation
	CurrentAPISessionDeleteCurrentAPISessionHandler current_api_session.DeleteCurrentAPISessionHandler
	// AuthenticationAuthenticateHandler sets the operation handler for the authenticate operation
	AuthenticationAuthenticateHandler authentication.AuthenticateHandler
	// AuthenticationAuthenticateMfaHandler sets the operation handler for the authenticate mfa operation
	AuthenticationAuthenticateMfaHandler authentication.AuthenticateMfaHandler
	// CurrentAPISessionCreateCurrentAPISessionCertificateHandler sets the operation handler for the create current Api session certificate operation
	CurrentAPISessionCreateCurrentAPISessionCertificateHandler current_api_session.CreateCurrentAPISessionCertificateHandler
	// CurrentIdentityCreateMfaRecoveryCodesHandler sets the operation handler for the create mfa recovery codes operation
	CurrentIdentityCreateMfaRecoveryCodesHandler current_identity.CreateMfaRecoveryCodesHandler
	// PostureChecksCreatePostureResponseHandler sets the operation handler for the create posture response operation
	PostureChecksCreatePostureResponseHandler posture_checks.CreatePostureResponseHandler
	// PostureChecksCreatePostureResponseBulkHandler sets the operation handler for the create posture response bulk operation
	PostureChecksCreatePostureResponseBulkHandler posture_checks.CreatePostureResponseBulkHandler
	// SessionCreateSessionHandler sets the operation handler for the create session operation
	SessionCreateSessionHandler session.CreateSessionHandler
	// CurrentAPISessionCreateTotpTokenHandler sets the operation handler for the create totp token operation
	CurrentAPISessionCreateTotpTokenHandler current_api_session.CreateTotpTokenHandler
	// CurrentAPISessionDeleteCurrentAPISessionCertificateHandler sets the operation handler for the delete current Api session certificate operation
	CurrentAPISessionDeleteCurrentAPISessionCertificateHandler current_api_session.DeleteCurrentAPISessionCertificateHandler
	// CurrentIdentityDeleteMfaHandler sets the operation handler for the delete mfa operation
	CurrentIdentityDeleteMfaHandler current_identity.DeleteMfaHandler
	// ServiceDeleteServiceHandler sets the operation handler for the delete service operation
	ServiceDeleteServiceHandler service.DeleteServiceHandler
	// SessionDeleteSessionHandler sets the operation handler for the delete session operation
	SessionDeleteSessionHandler session.DeleteSessionHandler
	// CurrentAPISessionDetailCurrentAPISessionCertificateHandler sets the operation handler for the detail current Api session certificate operation
	CurrentAPISessionDetailCurrentAPISessionCertificateHandler current_api_session.DetailCurrentAPISessionCertificateHandler
	// CurrentAPISessionDetailCurrentIdentityAuthenticatorHandler sets the operation handler for the detail current identity authenticator operation
	CurrentAPISessionDetailCurrentIdentityAuthenticatorHandler current_api_session.DetailCurrentIdentityAuthenticatorHandler
	// CurrentIdentityDetailMfaHandler sets the operation handler for the detail mfa operation
	CurrentIdentityDetailMfaHandler current_identity.DetailMfaHandler
	// CurrentIdentityDetailMfaQrCodeHandler sets the operation handler for the detail mfa qr code operation
	CurrentIdentityDetailMfaQrCodeHandler current_identity.DetailMfaQrCodeHandler
	// CurrentIdentityDetailMfaRecoveryCodesHandler sets the operation handler for the detail mfa recovery codes operation
	CurrentIdentityDetailMfaRecoveryCodesHandler current_identity.DetailMfaRecoveryCodesHandler
	// ServiceDetailServiceHandler sets the operation handler for the detail service operation
	ServiceDetailServiceHandler service.DetailServiceHandler
	// SessionDetailSessionHandler sets the operation handler for the detail session operation
	SessionDetailSessionHandler session.DetailSessionHandler
	// InformationalDetailSpecHandler sets the operation handler for the detail spec operation
	InformationalDetailSpecHandler informational.DetailSpecHandler
	// InformationalDetailSpecBodyHandler sets the operation handler for the detail spec body operation
	InformationalDetailSpecBodyHandler informational.DetailSpecBodyHandler
	// EnrollEnrollHandler sets the operation handler for the enroll operation
	EnrollEnrollHandler enroll.EnrollHandler
	// EnrollEnrollCaHandler sets the operation handler for the enroll ca operation
	EnrollEnrollCaHandler enroll.EnrollCaHandler
	// EnrollEnrollErOttHandler sets the operation handler for the enroll er ott operation
	EnrollEnrollErOttHandler enroll.EnrollErOttHandler
	// CurrentIdentityEnrollMfaHandler sets the operation handler for the enroll mfa operation
	CurrentIdentityEnrollMfaHandler current_identity.EnrollMfaHandler
	// EnrollEnrollOttHandler sets the operation handler for the enroll ott operation
	EnrollEnrollOttHandler enroll.EnrollOttHandler
	// EnrollEnrollOttCaHandler sets the operation handler for the enroll ott ca operation
	EnrollEnrollOttCaHandler enroll.EnrollOttCaHandler
	// EnrollEnrollTokenHandler sets the operation handler for the enroll token operation
	EnrollEnrollTokenHandler enroll.EnrollTokenHandler
	// EnrollEnrollUpdbHandler sets the operation handler for the enroll updb operation
	EnrollEnrollUpdbHandler enroll.EnrollUpdbHandler
	// EnrollEnrollmentChallengeHandler sets the operation handler for the enrollment challenge operation
	EnrollEnrollmentChallengeHandler enroll.EnrollmentChallengeHandler
	// CurrentAPISessionExtendCurrentIdentityAuthenticatorHandler sets the operation handler for the extend current identity authenticator operation
	CurrentAPISessionExtendCurrentIdentityAuthenticatorHandler current_api_session.ExtendCurrentIdentityAuthenticatorHandler
	// EnrollExtendRouterEnrollmentHandler sets the operation handler for the extend router enrollment operation
	EnrollExtendRouterEnrollmentHandler enroll.ExtendRouterEnrollmentHandler
	// CurrentAPISessionExtendVerifyCurrentIdentityAuthenticatorHandler sets the operation handler for the extend verify current identity authenticator operation
	CurrentAPISessionExtendVerifyCurrentIdentityAuthenticatorHandler current_api_session.ExtendVerifyCurrentIdentityAuthenticatorHandler
	// CurrentAPISessionGetCurrentAPISessionHandler sets the operation handler for the get current API session operation
	CurrentAPISessionGetCurrentAPISessionHandler current_api_session.GetCurrentAPISessionHandler
	// CurrentIdentityGetCurrentIdentityHandler sets the operation handler for the get current identity operation
	CurrentIdentityGetCurrentIdentityHandler current_identity.GetCurrentIdentityHandler
	// CurrentIdentityGetCurrentIdentityEdgeRoutersHandler sets the operation handler for the get current identity edge routers operation
	CurrentIdentityGetCurrentIdentityEdgeRoutersHandler current_identity.GetCurrentIdentityEdgeRoutersHandler
	// EnrollGetEnrollmentJwksHandler sets the operation handler for the get enrollment jwks operation
	EnrollGetEnrollmentJwksHandler enroll.GetEnrollmentJwksHandler
	// ControllersListControllersHandler sets the operation handler for the list controllers operation
	ControllersListControllersHandler controllers.ListControllersHandler
	// CurrentAPISessionListCurrentAPISessionCertificatesHandler sets the operation handler for the list current Api session certificates operation
	CurrentAPISessionListCurrentAPISessionCertificatesHandler current_api_session.ListCurrentAPISessionCertificatesHandler
	// CurrentAPISessionListCurrentIdentityAuthenticatorsHandler sets the operation handler for the list current identity authenticators operation
	CurrentAPISessionListCurrentIdentityAuthenticatorsHandler current_api_session.ListCurrentIdentityAuthenticatorsHandler
	// InformationalListEnumeratedCapabilitiesHandler sets the operation handler for the list enumerated capabilities operation
	InformationalListEnumeratedCapabilitiesHandler informational.ListEnumeratedCapabilitiesHandler
	// InformationalListEnumeratedRouterCapabilitiesHandler sets the operation handler for the list enumerated router capabilities operation
	InformationalListEnumeratedRouterCapabilitiesHandler informational.ListEnumeratedRouterCapabilitiesHandler
	// ExternalJWTSignerListExternalJWTSignersHandler sets the operation handler for the list external Jwt signers operation
	ExternalJWTSignerListExternalJWTSignersHandler external_jwt_signer.ListExternalJWTSignersHandler
	// EnrollmentListNetworkJWTsHandler sets the operation handler for the list network j w ts operation
	EnrollmentListNetworkJWTsHandler enrollment.ListNetworkJWTsHandler
	// InformationalListProtocolsHandler sets the operation handler for the list protocols operation
	InformationalListProtocolsHandler informational.ListProtocolsHandler
	// InformationalListRootHandler sets the operation handler for the list root operation
	InformationalListRootHandler informational.ListRootHandler
	// ServiceListServiceEdgeRoutersHandler sets the operation handler for the list service edge routers operation
	ServiceListServiceEdgeRoutersHandler service.ListServiceEdgeRoutersHandler
	// ServiceListServiceTerminatorsHandler sets the operation handler for the list service terminators operation
	ServiceListServiceTerminatorsHandler service.ListServiceTerminatorsHandler
	// CurrentAPISessionListServiceUpdatesHandler sets the operation handler for the list service updates operation
	CurrentAPISessionListServiceUpdatesHandler current_api_session.ListServiceUpdatesHandler
	// ServiceListServicesHandler sets the operation handler for the list services operation
	ServiceListServicesHandler service.ListServicesHandler
	// SessionListSessionsHandler sets the operation handler for the list sessions operation
	SessionListSessionsHandler session.ListSessionsHandler
	// InformationalListSpecsHandler sets the operation handler for the list specs operation
	InformationalListSpecsHandler informational.ListSpecsHandler
	// InformationalListVersionHandler sets the operation handler for the list version operation
	InformationalListVersionHandler informational.ListVersionHandler
	// WellKnownListWellKnownCasHandler sets the operation handler for the list well known cas operation
	WellKnownListWellKnownCasHandler well_known.ListWellKnownCasHandler
	// CurrentAPISessionPatchCurrentIdentityAuthenticatorHandler sets the operation handler for the patch current identity authenticator operation
	CurrentAPISessionPatchCurrentIdentityAuthenticatorHandler current_api_session.PatchCurrentIdentityAuthenticatorHandler
	// ServicePatchServiceHandler sets the operation handler for the patch service operation
	ServicePatchServiceHandler service.PatchServiceHandler
	// CurrentAPISessionUpdateCurrentIdentityAuthenticatorHandler sets the operation handler for the update current identity authenticator operation
	CurrentAPISessionUpdateCurrentIdentityAuthenticatorHandler current_api_session.UpdateCurrentIdentityAuthenticatorHandler
	// ServiceUpdateServiceHandler sets the operation handler for the update service operation
	ServiceUpdateServiceHandler service.UpdateServiceHandler
	// CurrentIdentityVerifyMfaHandler sets the operation handler for the verify mfa operation
	CurrentIdentityVerifyMfaHandler current_identity.VerifyMfaHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...any)
	// contains filtered or unexported fields
}

ZitiEdgeClientAPI OpenZiti Edge Client API

func NewZitiEdgeClientAPI

func NewZitiEdgeClientAPI(spec *loads.Document) *ZitiEdgeClientAPI

NewZitiEdgeClientAPI creates a new ZitiEdgeClient instance

func (*ZitiEdgeClientAPI) AddMiddlewareFor

func (o *ZitiEdgeClientAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*ZitiEdgeClientAPI) AuthenticatorsFor

func (o *ZitiEdgeClientAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*ZitiEdgeClientAPI) Authorizer

func (o *ZitiEdgeClientAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*ZitiEdgeClientAPI) ConsumersFor

func (o *ZitiEdgeClientAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types.

MIME type parameters are ignored here.

func (*ZitiEdgeClientAPI) Context

func (o *ZitiEdgeClientAPI) Context() *middleware.Context

Context returns the middleware context for the ziti edge client API

func (*ZitiEdgeClientAPI) DefaultConsumes

func (o *ZitiEdgeClientAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*ZitiEdgeClientAPI) DefaultProduces

func (o *ZitiEdgeClientAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*ZitiEdgeClientAPI) Formats

func (o *ZitiEdgeClientAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*ZitiEdgeClientAPI) HandlerFor

func (o *ZitiEdgeClientAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*ZitiEdgeClientAPI) Init

func (o *ZitiEdgeClientAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*ZitiEdgeClientAPI) ProducersFor

func (o *ZitiEdgeClientAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types.

MIME type parameters are ignored here.

func (*ZitiEdgeClientAPI) RegisterConsumer

func (o *ZitiEdgeClientAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*ZitiEdgeClientAPI) RegisterFormat

func (o *ZitiEdgeClientAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*ZitiEdgeClientAPI) RegisterProducer

func (o *ZitiEdgeClientAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*ZitiEdgeClientAPI) Serve

func (o *ZitiEdgeClientAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*ZitiEdgeClientAPI) ServeErrorFor

func (o *ZitiEdgeClientAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*ZitiEdgeClientAPI) SetDefaultConsumes

func (o *ZitiEdgeClientAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*ZitiEdgeClientAPI) SetDefaultProduces

func (o *ZitiEdgeClientAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*ZitiEdgeClientAPI) SetSpec

func (o *ZitiEdgeClientAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*ZitiEdgeClientAPI) UseRedoc

func (o *ZitiEdgeClientAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*ZitiEdgeClientAPI) UseSwaggerUI

func (o *ZitiEdgeClientAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*ZitiEdgeClientAPI) Validate

func (o *ZitiEdgeClientAPI) Validate() error

Validate validates the registrations in the ZitiEdgeClientAPI

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL