well_known

package
v0.26.53 Latest Latest
Warning

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

Go to latest
Published: Feb 12, 2026 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAcceptApplicationJSON added in v0.26.53

func WithAcceptApplicationJSON(r *runtime.ClientOperation)

WithAcceptApplicationJSON sets the Accept header to "application/json".

func WithAcceptApplicationPkcs7Mime added in v0.26.53

func WithAcceptApplicationPkcs7Mime(r *runtime.ClientOperation)

WithAcceptApplicationPkcs7Mime sets the Accept header to "application/pkcs7-mime".

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for well known API

func (*Client) ListWellKnownCas

func (a *Client) ListWellKnownCas(params *ListWellKnownCasParams, opts ...ClientOption) (*ListWellKnownCasOK, error)
ListWellKnownCas gets c a cert store

This endpoint is used during enrollments to bootstrap trust between enrolling clients and the Ziti Edge API.

This endpoint returns a base64 encoded PKCS7 store. The content can be base64 decoded and parsed by any library that supports parsing PKCS7 stores.

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

func WithAccept added in v0.26.53

func WithAccept(mime string) ClientOption

WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService

type ClientService interface {
	ListWellKnownCas(params *ListWellKnownCasParams, opts ...ClientOption) (*ListWellKnownCasOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new well known API client.

func NewClientWithBasicAuth added in v0.26.53

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new well known API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken added in v0.26.53

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new well known API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type ListWellKnownCasOK

type ListWellKnownCasOK struct {
	Payload string
}

ListWellKnownCasOK describes a response with status code 200, with default header values.

A base64 encoded PKCS7 store

func NewListWellKnownCasOK

func NewListWellKnownCasOK() *ListWellKnownCasOK

NewListWellKnownCasOK creates a ListWellKnownCasOK with default headers values

func (*ListWellKnownCasOK) Code added in v0.26.53

func (o *ListWellKnownCasOK) Code() int

Code gets the status code for the list well known cas o k response

func (*ListWellKnownCasOK) Error

func (o *ListWellKnownCasOK) Error() string

func (*ListWellKnownCasOK) GetPayload

func (o *ListWellKnownCasOK) GetPayload() string

func (*ListWellKnownCasOK) IsClientError added in v0.26.53

func (o *ListWellKnownCasOK) IsClientError() bool

IsClientError returns true when this list well known cas o k response has a 4xx status code

func (*ListWellKnownCasOK) IsCode added in v0.26.53

func (o *ListWellKnownCasOK) IsCode(code int) bool

IsCode returns true when this list well known cas o k response a status code equal to that given

func (*ListWellKnownCasOK) IsRedirect added in v0.26.53

func (o *ListWellKnownCasOK) IsRedirect() bool

IsRedirect returns true when this list well known cas o k response has a 3xx status code

func (*ListWellKnownCasOK) IsServerError added in v0.26.53

func (o *ListWellKnownCasOK) IsServerError() bool

IsServerError returns true when this list well known cas o k response has a 5xx status code

func (*ListWellKnownCasOK) IsSuccess added in v0.26.53

func (o *ListWellKnownCasOK) IsSuccess() bool

IsSuccess returns true when this list well known cas o k response has a 2xx status code

func (*ListWellKnownCasOK) String added in v0.26.53

func (o *ListWellKnownCasOK) String() string

type ListWellKnownCasParams

type ListWellKnownCasParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListWellKnownCasParams contains all the parameters to send to the API endpoint

for the list well known cas operation.

Typically these are written to a http.Request.

func NewListWellKnownCasParams

func NewListWellKnownCasParams() *ListWellKnownCasParams

NewListWellKnownCasParams creates a new ListWellKnownCasParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewListWellKnownCasParamsWithContext

func NewListWellKnownCasParamsWithContext(ctx context.Context) *ListWellKnownCasParams

NewListWellKnownCasParamsWithContext creates a new ListWellKnownCasParams object with the ability to set a context for a request.

func NewListWellKnownCasParamsWithHTTPClient

func NewListWellKnownCasParamsWithHTTPClient(client *http.Client) *ListWellKnownCasParams

NewListWellKnownCasParamsWithHTTPClient creates a new ListWellKnownCasParams object with the ability to set a custom HTTPClient for a request.

func NewListWellKnownCasParamsWithTimeout

func NewListWellKnownCasParamsWithTimeout(timeout time.Duration) *ListWellKnownCasParams

NewListWellKnownCasParamsWithTimeout creates a new ListWellKnownCasParams object with the ability to set a timeout on a request.

func (*ListWellKnownCasParams) SetContext

func (o *ListWellKnownCasParams) SetContext(ctx context.Context)

SetContext adds the context to the list well known cas params

func (*ListWellKnownCasParams) SetDefaults

func (o *ListWellKnownCasParams) SetDefaults()

SetDefaults hydrates default values in the list well known cas params (not the query body).

All values with no default are reset to their zero value.

func (*ListWellKnownCasParams) SetHTTPClient

func (o *ListWellKnownCasParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list well known cas params

func (*ListWellKnownCasParams) SetTimeout

func (o *ListWellKnownCasParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list well known cas params

func (*ListWellKnownCasParams) WithContext

WithContext adds the context to the list well known cas params

func (*ListWellKnownCasParams) WithDefaults

WithDefaults hydrates default values in the list well known cas params (not the query body).

All values with no default are reset to their zero value.

func (*ListWellKnownCasParams) WithHTTPClient

func (o *ListWellKnownCasParams) WithHTTPClient(client *http.Client) *ListWellKnownCasParams

WithHTTPClient adds the HTTPClient to the list well known cas params

func (*ListWellKnownCasParams) WithTimeout

WithTimeout adds the timeout to the list well known cas params

func (*ListWellKnownCasParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ListWellKnownCasReader

type ListWellKnownCasReader struct {
	// contains filtered or unexported fields
}

ListWellKnownCasReader is a Reader for the ListWellKnownCas structure.

func (*ListWellKnownCasReader) ReadResponse

func (o *ListWellKnownCasReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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