oidc

package
v0.0.0-...-8db688c Latest Latest
Warning

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

 Go to latest Published: May 13, 2024 License: AGPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API interface {
	/*
	   PingOIDC tests the OIDC endpoint

	   Test the OIDC endpoint, the setting of the endpoint is provided in the request.  This API can only be called by system admin.
	*/
	PingOIDC(ctx context.Context, params *PingOIDCParams) (*PingOIDCOK, error)
}

API is the interface of the oidc client

type Client 

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

Client for oidc API

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry, authInfo runtime.ClientAuthInfoWriter) *Client

New creates a new oidc API client.

func (*Client) PingOIDC 

func (a *Client) PingOIDC(ctx context.Context, params *PingOIDCParams) (*PingOIDCOK, error)

PingOIDC tests the OIDC endpoint

Test the OIDC endpoint, the setting of the endpoint is provided in the request. This API can only be called by system admin.

type PingOIDCBadRequest 

type PingOIDCBadRequest struct {

	/* The ID of the corresponding request for the response
	 */
	XRequestID string

	Payload *models.Errors
}

PingOIDCBadRequest describes a response with status code 400, with default header values.

Bad request

func NewPingOIDCBadRequest 

func NewPingOIDCBadRequest() *PingOIDCBadRequest

NewPingOIDCBadRequest creates a PingOIDCBadRequest with default headers values

func (*PingOIDCBadRequest) Code 

func (o *PingOIDCBadRequest) Code() int

Code gets the status code for the ping Oidc bad request response

func (*PingOIDCBadRequest) Error 

func (o *PingOIDCBadRequest) Error() string

func (*PingOIDCBadRequest) GetPayload 

func (o *PingOIDCBadRequest) GetPayload() *models.Errors

func (*PingOIDCBadRequest) IsClientError 

func (o *PingOIDCBadRequest) IsClientError() bool

IsClientError returns true when this ping Oidc bad request response has a 4xx status code

func (*PingOIDCBadRequest) IsCode 

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

IsCode returns true when this ping Oidc bad request response a status code equal to that given

func (*PingOIDCBadRequest) IsRedirect 

func (o *PingOIDCBadRequest) IsRedirect() bool

IsRedirect returns true when this ping Oidc bad request response has a 3xx status code

func (*PingOIDCBadRequest) IsServerError 

func (o *PingOIDCBadRequest) IsServerError() bool

IsServerError returns true when this ping Oidc bad request response has a 5xx status code

func (*PingOIDCBadRequest) IsSuccess 

func (o *PingOIDCBadRequest) IsSuccess() bool

IsSuccess returns true when this ping Oidc bad request response has a 2xx status code

func (*PingOIDCBadRequest) String 

func (o *PingOIDCBadRequest) String() string

type PingOIDCBody 

type PingOIDCBody struct {

	// The URL of OIDC endpoint to be tested.
	URL string `json:"url,omitempty"`

	// Whether the certificate should be verified
	VerifyCert bool `json:"verify_cert,omitempty"`
}

PingOIDCBody ping OIDC body swagger:model PingOIDCBody

func (*PingOIDCBody) ContextValidate 

func (o *PingOIDCBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this ping OIDC body based on context it is used

func (*PingOIDCBody) MarshalBinary 

func (o *PingOIDCBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PingOIDCBody) UnmarshalBinary 

func (o *PingOIDCBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PingOIDCBody) Validate 

func (o *PingOIDCBody) Validate(formats strfmt.Registry) error

Validate validates this ping OIDC body

type PingOIDCForbidden 

type PingOIDCForbidden struct {

	/* The ID of the corresponding request for the response
	 */
	XRequestID string

	Payload *models.Errors
}

PingOIDCForbidden describes a response with status code 403, with default header values.

Forbidden

func NewPingOIDCForbidden 

func NewPingOIDCForbidden() *PingOIDCForbidden

NewPingOIDCForbidden creates a PingOIDCForbidden with default headers values

func (*PingOIDCForbidden) Code 

func (o *PingOIDCForbidden) Code() int

Code gets the status code for the ping Oidc forbidden response

func (*PingOIDCForbidden) Error 

func (o *PingOIDCForbidden) Error() string

func (*PingOIDCForbidden) GetPayload 

func (o *PingOIDCForbidden) GetPayload() *models.Errors

func (*PingOIDCForbidden) IsClientError 

func (o *PingOIDCForbidden) IsClientError() bool

IsClientError returns true when this ping Oidc forbidden response has a 4xx status code

func (*PingOIDCForbidden) IsCode 

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

IsCode returns true when this ping Oidc forbidden response a status code equal to that given

func (*PingOIDCForbidden) IsRedirect 

func (o *PingOIDCForbidden) IsRedirect() bool

IsRedirect returns true when this ping Oidc forbidden response has a 3xx status code

func (*PingOIDCForbidden) IsServerError 

func (o *PingOIDCForbidden) IsServerError() bool

IsServerError returns true when this ping Oidc forbidden response has a 5xx status code

func (*PingOIDCForbidden) IsSuccess 

func (o *PingOIDCForbidden) IsSuccess() bool

IsSuccess returns true when this ping Oidc forbidden response has a 2xx status code

func (*PingOIDCForbidden) String 

func (o *PingOIDCForbidden) String() string

type PingOIDCOK 

type PingOIDCOK struct {

	/* The ID of the corresponding request for the response
	 */
	XRequestID string
}

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

Success

func NewPingOIDCOK 

func NewPingOIDCOK() *PingOIDCOK

NewPingOIDCOK creates a PingOIDCOK with default headers values

func (*PingOIDCOK) Code 

func (o *PingOIDCOK) Code() int

Code gets the status code for the ping Oidc o k response

func (*PingOIDCOK) Error 

func (o *PingOIDCOK) Error() string

func (*PingOIDCOK) IsClientError 

func (o *PingOIDCOK) IsClientError() bool

IsClientError returns true when this ping Oidc o k response has a 4xx status code

func (*PingOIDCOK) IsCode 

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

IsCode returns true when this ping Oidc o k response a status code equal to that given

func (*PingOIDCOK) IsRedirect 

func (o *PingOIDCOK) IsRedirect() bool

IsRedirect returns true when this ping Oidc o k response has a 3xx status code

func (*PingOIDCOK) IsServerError 

func (o *PingOIDCOK) IsServerError() bool

IsServerError returns true when this ping Oidc o k response has a 5xx status code

func (*PingOIDCOK) IsSuccess 

func (o *PingOIDCOK) IsSuccess() bool

IsSuccess returns true when this ping Oidc o k response has a 2xx status code

func (*PingOIDCOK) String 

func (o *PingOIDCOK) String() string

type PingOIDCParams 

type PingOIDCParams struct {

	/* XRequestID.

	   An unique ID for the request
	*/
	XRequestID *string `js:"xRequestID"`

	/* Endpoint.

	   Request body for OIDC endpoint to be tested.
	*/
	Endpoint PingOIDCBody `js:"endpoint"`

	Context    context.Context `js:"context"`
	HTTPClient *http.Client    `js:"httpClient"`
	// contains filtered or unexported fields
}

PingOIDCParams contains all the parameters to send to the API endpoint 

for the ping OIDC operation.

Typically these are written to a http.Request.

func NewPingOIDCParams 

func NewPingOIDCParams() *PingOIDCParams

NewPingOIDCParams creates a new PingOIDCParams 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 NewPingOIDCParamsWithContext 

func NewPingOIDCParamsWithContext(ctx context.Context) *PingOIDCParams

NewPingOIDCParamsWithContext creates a new PingOIDCParams object with the ability to set a context for a request.

func NewPingOIDCParamsWithHTTPClient 

func NewPingOIDCParamsWithHTTPClient(client *http.Client) *PingOIDCParams

NewPingOIDCParamsWithHTTPClient creates a new PingOIDCParams object with the ability to set a custom HTTPClient for a request.

func NewPingOIDCParamsWithTimeout 

func NewPingOIDCParamsWithTimeout(timeout time.Duration) *PingOIDCParams

NewPingOIDCParamsWithTimeout creates a new PingOIDCParams object with the ability to set a timeout on a request.

func (*PingOIDCParams) SetContext 

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

SetContext adds the context to the ping OIDC params

func (*PingOIDCParams) SetDefaults 

func (o *PingOIDCParams) SetDefaults()

SetDefaults hydrates default values in the ping OIDC params (not the query body).

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

func (*PingOIDCParams) SetEndpoint 

func (o *PingOIDCParams) SetEndpoint(endpoint PingOIDCBody)

SetEndpoint adds the endpoint to the ping OIDC params

func (*PingOIDCParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the ping OIDC params

func (*PingOIDCParams) SetTimeout 

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

SetTimeout adds the timeout to the ping OIDC params

func (*PingOIDCParams) SetXRequestID 

func (o *PingOIDCParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId to the ping OIDC params

func (*PingOIDCParams) WithContext 

func (o *PingOIDCParams) WithContext(ctx context.Context) *PingOIDCParams

WithContext adds the context to the ping OIDC params

func (*PingOIDCParams) WithDefaults 

func (o *PingOIDCParams) WithDefaults() *PingOIDCParams

WithDefaults hydrates default values in the ping OIDC params (not the query body).

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

func (*PingOIDCParams) WithEndpoint 

func (o *PingOIDCParams) WithEndpoint(endpoint PingOIDCBody) *PingOIDCParams

WithEndpoint adds the endpoint to the ping OIDC params

func (*PingOIDCParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the ping OIDC params

func (*PingOIDCParams) WithTimeout 

func (o *PingOIDCParams) WithTimeout(timeout time.Duration) *PingOIDCParams

WithTimeout adds the timeout to the ping OIDC params

func (*PingOIDCParams) WithXRequestID 

func (o *PingOIDCParams) WithXRequestID(xRequestID *string) *PingOIDCParams

WithXRequestID adds the xRequestID to the ping OIDC params

func (*PingOIDCParams) WriteToRequest 

func (o *PingOIDCParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type PingOIDCReader 

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

PingOIDCReader is a Reader for the PingOIDC structure.

func (*PingOIDCReader) ReadResponse 

func (o *PingOIDCReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type PingOIDCUnauthorized 

type PingOIDCUnauthorized struct {

	/* The ID of the corresponding request for the response
	 */
	XRequestID string

	Payload *models.Errors
}

PingOIDCUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewPingOIDCUnauthorized 

func NewPingOIDCUnauthorized() *PingOIDCUnauthorized

NewPingOIDCUnauthorized creates a PingOIDCUnauthorized with default headers values

func (*PingOIDCUnauthorized) Code 

func (o *PingOIDCUnauthorized) Code() int

Code gets the status code for the ping Oidc unauthorized response

func (*PingOIDCUnauthorized) Error 

func (o *PingOIDCUnauthorized) Error() string

func (*PingOIDCUnauthorized) GetPayload 

func (o *PingOIDCUnauthorized) GetPayload() *models.Errors

func (*PingOIDCUnauthorized) IsClientError 

func (o *PingOIDCUnauthorized) IsClientError() bool

IsClientError returns true when this ping Oidc unauthorized response has a 4xx status code

func (*PingOIDCUnauthorized) IsCode 

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

IsCode returns true when this ping Oidc unauthorized response a status code equal to that given

func (*PingOIDCUnauthorized) IsRedirect 

func (o *PingOIDCUnauthorized) IsRedirect() bool

IsRedirect returns true when this ping Oidc unauthorized response has a 3xx status code

func (*PingOIDCUnauthorized) IsServerError 

func (o *PingOIDCUnauthorized) IsServerError() bool

IsServerError returns true when this ping Oidc unauthorized response has a 5xx status code

func (*PingOIDCUnauthorized) IsSuccess 

func (o *PingOIDCUnauthorized) IsSuccess() bool

IsSuccess returns true when this ping Oidc unauthorized response has a 2xx status code

func (*PingOIDCUnauthorized) String 

func (o *PingOIDCUnauthorized) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.