Documentation
¶
Index ¶
- type AuthenticateBadRequest
- type AuthenticateMfaOK
- type AuthenticateMfaParams
- func NewAuthenticateMfaParams() *AuthenticateMfaParams
- func NewAuthenticateMfaParamsWithContext(ctx context.Context) *AuthenticateMfaParams
- func NewAuthenticateMfaParamsWithHTTPClient(client *http.Client) *AuthenticateMfaParams
- func NewAuthenticateMfaParamsWithTimeout(timeout time.Duration) *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) SetContext(ctx context.Context)
- func (o *AuthenticateMfaParams) SetDefaults()
- func (o *AuthenticateMfaParams) SetHTTPClient(client *http.Client)
- func (o *AuthenticateMfaParams) SetMfaAuth(mfaAuth *rest_model.MfaCode)
- func (o *AuthenticateMfaParams) SetTimeout(timeout time.Duration)
- func (o *AuthenticateMfaParams) WithContext(ctx context.Context) *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) WithDefaults() *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) WithHTTPClient(client *http.Client) *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) WithMfaAuth(mfaAuth *rest_model.MfaCode) *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) WithTimeout(timeout time.Duration) *AuthenticateMfaParams
- func (o *AuthenticateMfaParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AuthenticateMfaReader
- type AuthenticateMfaTooManyRequests
- type AuthenticateMfaUnauthorized
- type AuthenticateOK
- type AuthenticateParams
- func (o *AuthenticateParams) SetAuth(auth *rest_model.Authenticate)
- func (o *AuthenticateParams) SetContext(ctx context.Context)
- func (o *AuthenticateParams) SetDefaults()
- func (o *AuthenticateParams) SetHTTPClient(client *http.Client)
- func (o *AuthenticateParams) SetMethod(method string)
- func (o *AuthenticateParams) SetTimeout(timeout time.Duration)
- func (o *AuthenticateParams) WithAuth(auth *rest_model.Authenticate) *AuthenticateParams
- func (o *AuthenticateParams) WithContext(ctx context.Context) *AuthenticateParams
- func (o *AuthenticateParams) WithDefaults() *AuthenticateParams
- func (o *AuthenticateParams) WithHTTPClient(client *http.Client) *AuthenticateParams
- func (o *AuthenticateParams) WithMethod(method string) *AuthenticateParams
- func (o *AuthenticateParams) WithTimeout(timeout time.Duration) *AuthenticateParams
- func (o *AuthenticateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AuthenticateReader
- type AuthenticateTooManyRequests
- type AuthenticateUnauthorized
- type Client
- func (a *Client) Authenticate(params *AuthenticateParams, opts ...ClientOption) (*AuthenticateOK, error)
- func (a *Client) AuthenticateMfa(params *AuthenticateMfaParams, authInfo runtime.ClientAuthInfoWriter, ...) (*AuthenticateMfaOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientOption
- type ClientService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthenticateBadRequest ¶
type AuthenticateBadRequest struct {
Payload *rest_model.APIErrorEnvelope
}
AuthenticateBadRequest describes a response with status code 400, with default header values.
The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information
func NewAuthenticateBadRequest ¶
func NewAuthenticateBadRequest() *AuthenticateBadRequest
NewAuthenticateBadRequest creates a AuthenticateBadRequest with default headers values
func (*AuthenticateBadRequest) Error ¶
func (o *AuthenticateBadRequest) Error() string
func (*AuthenticateBadRequest) GetPayload ¶
func (o *AuthenticateBadRequest) GetPayload() *rest_model.APIErrorEnvelope
type AuthenticateMfaOK ¶
type AuthenticateMfaOK struct {
Payload *rest_model.Empty
}
AuthenticateMfaOK describes a response with status code 200, with default header values.
Base empty response
func NewAuthenticateMfaOK ¶
func NewAuthenticateMfaOK() *AuthenticateMfaOK
NewAuthenticateMfaOK creates a AuthenticateMfaOK with default headers values
func (*AuthenticateMfaOK) Error ¶
func (o *AuthenticateMfaOK) Error() string
func (*AuthenticateMfaOK) GetPayload ¶
func (o *AuthenticateMfaOK) GetPayload() *rest_model.Empty
type AuthenticateMfaParams ¶
type AuthenticateMfaParams struct {
/* MfaAuth.
An MFA validation request
*/
MfaAuth *rest_model.MfaCode
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
AuthenticateMfaParams contains all the parameters to send to the API endpoint
for the authenticate mfa operation. Typically these are written to a http.Request.
func NewAuthenticateMfaParams ¶
func NewAuthenticateMfaParams() *AuthenticateMfaParams
NewAuthenticateMfaParams creates a new AuthenticateMfaParams 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 NewAuthenticateMfaParamsWithContext ¶
func NewAuthenticateMfaParamsWithContext(ctx context.Context) *AuthenticateMfaParams
NewAuthenticateMfaParamsWithContext creates a new AuthenticateMfaParams object with the ability to set a context for a request.
func NewAuthenticateMfaParamsWithHTTPClient ¶
func NewAuthenticateMfaParamsWithHTTPClient(client *http.Client) *AuthenticateMfaParams
NewAuthenticateMfaParamsWithHTTPClient creates a new AuthenticateMfaParams object with the ability to set a custom HTTPClient for a request.
func NewAuthenticateMfaParamsWithTimeout ¶
func NewAuthenticateMfaParamsWithTimeout(timeout time.Duration) *AuthenticateMfaParams
NewAuthenticateMfaParamsWithTimeout creates a new AuthenticateMfaParams object with the ability to set a timeout on a request.
func (*AuthenticateMfaParams) SetContext ¶
func (o *AuthenticateMfaParams) SetContext(ctx context.Context)
SetContext adds the context to the authenticate mfa params
func (*AuthenticateMfaParams) SetDefaults ¶
func (o *AuthenticateMfaParams) SetDefaults()
SetDefaults hydrates default values in the authenticate mfa params (not the query body).
All values with no default are reset to their zero value.
func (*AuthenticateMfaParams) SetHTTPClient ¶
func (o *AuthenticateMfaParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the authenticate mfa params
func (*AuthenticateMfaParams) SetMfaAuth ¶
func (o *AuthenticateMfaParams) SetMfaAuth(mfaAuth *rest_model.MfaCode)
SetMfaAuth adds the mfaAuth to the authenticate mfa params
func (*AuthenticateMfaParams) SetTimeout ¶
func (o *AuthenticateMfaParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the authenticate mfa params
func (*AuthenticateMfaParams) WithContext ¶
func (o *AuthenticateMfaParams) WithContext(ctx context.Context) *AuthenticateMfaParams
WithContext adds the context to the authenticate mfa params
func (*AuthenticateMfaParams) WithDefaults ¶
func (o *AuthenticateMfaParams) WithDefaults() *AuthenticateMfaParams
WithDefaults hydrates default values in the authenticate mfa params (not the query body).
All values with no default are reset to their zero value.
func (*AuthenticateMfaParams) WithHTTPClient ¶
func (o *AuthenticateMfaParams) WithHTTPClient(client *http.Client) *AuthenticateMfaParams
WithHTTPClient adds the HTTPClient to the authenticate mfa params
func (*AuthenticateMfaParams) WithMfaAuth ¶
func (o *AuthenticateMfaParams) WithMfaAuth(mfaAuth *rest_model.MfaCode) *AuthenticateMfaParams
WithMfaAuth adds the mfaAuth to the authenticate mfa params
func (*AuthenticateMfaParams) WithTimeout ¶
func (o *AuthenticateMfaParams) WithTimeout(timeout time.Duration) *AuthenticateMfaParams
WithTimeout adds the timeout to the authenticate mfa params
func (*AuthenticateMfaParams) WriteToRequest ¶
func (o *AuthenticateMfaParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AuthenticateMfaReader ¶
type AuthenticateMfaReader struct {
// contains filtered or unexported fields
}
AuthenticateMfaReader is a Reader for the AuthenticateMfa structure.
func (*AuthenticateMfaReader) ReadResponse ¶
func (o *AuthenticateMfaReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type AuthenticateMfaTooManyRequests ¶ added in v0.26.7
type AuthenticateMfaTooManyRequests struct {
Payload *rest_model.APIErrorEnvelope
}
AuthenticateMfaTooManyRequests describes a response with status code 429, with default header values.
The resource requested is rate limited and the rate limit has been exceeded
func NewAuthenticateMfaTooManyRequests ¶ added in v0.26.7
func NewAuthenticateMfaTooManyRequests() *AuthenticateMfaTooManyRequests
NewAuthenticateMfaTooManyRequests creates a AuthenticateMfaTooManyRequests with default headers values
func (*AuthenticateMfaTooManyRequests) Error ¶ added in v0.26.7
func (o *AuthenticateMfaTooManyRequests) Error() string
func (*AuthenticateMfaTooManyRequests) GetPayload ¶ added in v0.26.7
func (o *AuthenticateMfaTooManyRequests) GetPayload() *rest_model.APIErrorEnvelope
type AuthenticateMfaUnauthorized ¶
type AuthenticateMfaUnauthorized struct {
}
AuthenticateMfaUnauthorized describes a response with status code 401, with default header values.
Base empty response
func NewAuthenticateMfaUnauthorized ¶
func NewAuthenticateMfaUnauthorized() *AuthenticateMfaUnauthorized
NewAuthenticateMfaUnauthorized creates a AuthenticateMfaUnauthorized with default headers values
func (*AuthenticateMfaUnauthorized) Error ¶
func (o *AuthenticateMfaUnauthorized) Error() string
func (*AuthenticateMfaUnauthorized) GetPayload ¶
func (o *AuthenticateMfaUnauthorized) GetPayload() *rest_model.Empty
type AuthenticateOK ¶
type AuthenticateOK struct {
Payload *rest_model.CurrentAPISessionDetailEnvelope
}
AuthenticateOK describes a response with status code 200, with default header values.
The API session associated with the session used to issue the request
func NewAuthenticateOK ¶
func NewAuthenticateOK() *AuthenticateOK
NewAuthenticateOK creates a AuthenticateOK with default headers values
func (*AuthenticateOK) Error ¶
func (o *AuthenticateOK) Error() string
func (*AuthenticateOK) GetPayload ¶
func (o *AuthenticateOK) GetPayload() *rest_model.CurrentAPISessionDetailEnvelope
type AuthenticateParams ¶
type AuthenticateParams struct {
// Auth.
Auth *rest_model.Authenticate
// Method.
Method string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
AuthenticateParams contains all the parameters to send to the API endpoint
for the authenticate operation. Typically these are written to a http.Request.
func NewAuthenticateParams ¶
func NewAuthenticateParams() *AuthenticateParams
NewAuthenticateParams creates a new AuthenticateParams 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 NewAuthenticateParamsWithContext ¶
func NewAuthenticateParamsWithContext(ctx context.Context) *AuthenticateParams
NewAuthenticateParamsWithContext creates a new AuthenticateParams object with the ability to set a context for a request.
func NewAuthenticateParamsWithHTTPClient ¶
func NewAuthenticateParamsWithHTTPClient(client *http.Client) *AuthenticateParams
NewAuthenticateParamsWithHTTPClient creates a new AuthenticateParams object with the ability to set a custom HTTPClient for a request.
func NewAuthenticateParamsWithTimeout ¶
func NewAuthenticateParamsWithTimeout(timeout time.Duration) *AuthenticateParams
NewAuthenticateParamsWithTimeout creates a new AuthenticateParams object with the ability to set a timeout on a request.
func (*AuthenticateParams) SetAuth ¶
func (o *AuthenticateParams) SetAuth(auth *rest_model.Authenticate)
SetAuth adds the auth to the authenticate params
func (*AuthenticateParams) SetContext ¶
func (o *AuthenticateParams) SetContext(ctx context.Context)
SetContext adds the context to the authenticate params
func (*AuthenticateParams) SetDefaults ¶
func (o *AuthenticateParams) SetDefaults()
SetDefaults hydrates default values in the authenticate params (not the query body).
All values with no default are reset to their zero value.
func (*AuthenticateParams) SetHTTPClient ¶
func (o *AuthenticateParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the authenticate params
func (*AuthenticateParams) SetMethod ¶
func (o *AuthenticateParams) SetMethod(method string)
SetMethod adds the method to the authenticate params
func (*AuthenticateParams) SetTimeout ¶
func (o *AuthenticateParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the authenticate params
func (*AuthenticateParams) WithAuth ¶
func (o *AuthenticateParams) WithAuth(auth *rest_model.Authenticate) *AuthenticateParams
WithAuth adds the auth to the authenticate params
func (*AuthenticateParams) WithContext ¶
func (o *AuthenticateParams) WithContext(ctx context.Context) *AuthenticateParams
WithContext adds the context to the authenticate params
func (*AuthenticateParams) WithDefaults ¶
func (o *AuthenticateParams) WithDefaults() *AuthenticateParams
WithDefaults hydrates default values in the authenticate params (not the query body).
All values with no default are reset to their zero value.
func (*AuthenticateParams) WithHTTPClient ¶
func (o *AuthenticateParams) WithHTTPClient(client *http.Client) *AuthenticateParams
WithHTTPClient adds the HTTPClient to the authenticate params
func (*AuthenticateParams) WithMethod ¶
func (o *AuthenticateParams) WithMethod(method string) *AuthenticateParams
WithMethod adds the method to the authenticate params
func (*AuthenticateParams) WithTimeout ¶
func (o *AuthenticateParams) WithTimeout(timeout time.Duration) *AuthenticateParams
WithTimeout adds the timeout to the authenticate params
func (*AuthenticateParams) WriteToRequest ¶
func (o *AuthenticateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AuthenticateReader ¶
type AuthenticateReader struct {
// contains filtered or unexported fields
}
AuthenticateReader is a Reader for the Authenticate structure.
func (*AuthenticateReader) ReadResponse ¶
func (o *AuthenticateReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type AuthenticateTooManyRequests ¶ added in v0.26.7
type AuthenticateTooManyRequests struct {
Payload *rest_model.APIErrorEnvelope
}
AuthenticateTooManyRequests describes a response with status code 429, with default header values.
The resource requested is rate limited and the rate limit has been exceeded
func NewAuthenticateTooManyRequests ¶ added in v0.26.7
func NewAuthenticateTooManyRequests() *AuthenticateTooManyRequests
NewAuthenticateTooManyRequests creates a AuthenticateTooManyRequests with default headers values
func (*AuthenticateTooManyRequests) Error ¶ added in v0.26.7
func (o *AuthenticateTooManyRequests) Error() string
func (*AuthenticateTooManyRequests) GetPayload ¶ added in v0.26.7
func (o *AuthenticateTooManyRequests) GetPayload() *rest_model.APIErrorEnvelope
type AuthenticateUnauthorized ¶ added in v0.25.15
type AuthenticateUnauthorized struct {
}
AuthenticateUnauthorized describes a response with status code 401, with default header values.
The authentication request could not be processed as the credentials are invalid
func NewAuthenticateUnauthorized ¶ added in v0.25.15
func NewAuthenticateUnauthorized() *AuthenticateUnauthorized
NewAuthenticateUnauthorized creates a AuthenticateUnauthorized with default headers values
func (*AuthenticateUnauthorized) Error ¶ added in v0.25.15
func (o *AuthenticateUnauthorized) Error() string
func (*AuthenticateUnauthorized) GetPayload ¶ added in v0.25.15
func (o *AuthenticateUnauthorized) GetPayload() *rest_model.APIErrorEnvelope
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for authentication API
func (*Client) Authenticate ¶
func (a *Client) Authenticate(params *AuthenticateParams, opts ...ClientOption) (*AuthenticateOK, error)
Authenticate authenticates via a method supplied via a query string parameter
Allowed authentication methods include "password", "cert", and "ext-jwt"
func (*Client) AuthenticateMfa ¶
func (a *Client) AuthenticateMfa(params *AuthenticateMfaParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AuthenticateMfaOK, error)
AuthenticateMfa completes m f a authentication
Completes MFA authentication by submitting a MFA time based one time token or backup code.
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 is the option for Client methods
type ClientService ¶
type ClientService interface {
Authenticate(params *AuthenticateParams, opts ...ClientOption) (*AuthenticateOK, error)
AuthenticateMfa(params *AuthenticateMfaParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AuthenticateMfaOK, 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 authentication API client.
Source Files