Documentation
¶
Index ¶
- type AuthenticateBadRequest
- type AuthenticateForbidden
- type AuthenticateOK
- type AuthenticateParams
- func (o *AuthenticateParams) SetBody(body *rest_model.Authenticate)
- func (o *AuthenticateParams) SetContext(ctx context.Context)
- func (o *AuthenticateParams) SetHTTPClient(client *http.Client)
- func (o *AuthenticateParams) SetMethod(method string)
- func (o *AuthenticateParams) SetTimeout(timeout time.Duration)
- func (o *AuthenticateParams) WithBody(body *rest_model.Authenticate) *AuthenticateParams
- func (o *AuthenticateParams) WithContext(ctx context.Context) *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 Client
- 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 handles this case 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 AuthenticateForbidden ¶
type AuthenticateForbidden struct {
Payload *rest_model.APIErrorEnvelope
}
AuthenticateForbidden handles this case with default header values.
The authentication request could not be processed as the credentials are invalid
func NewAuthenticateForbidden ¶
func NewAuthenticateForbidden() *AuthenticateForbidden
NewAuthenticateForbidden creates a AuthenticateForbidden with default headers values
func (*AuthenticateForbidden) Error ¶
func (o *AuthenticateForbidden) Error() string
func (*AuthenticateForbidden) GetPayload ¶
func (o *AuthenticateForbidden) GetPayload() *rest_model.APIErrorEnvelope
type AuthenticateOK ¶
type AuthenticateOK struct {
Payload *rest_model.CurrentAPISessionDetailEnvelope
}
AuthenticateOK handles this case 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 {
/*Body*/
Body *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 values initialized.
func NewAuthenticateParamsWithContext ¶
func NewAuthenticateParamsWithContext(ctx context.Context) *AuthenticateParams
NewAuthenticateParamsWithContext creates a new AuthenticateParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and the ability to set a timeout on a request
func (*AuthenticateParams) SetBody ¶
func (o *AuthenticateParams) SetBody(body *rest_model.Authenticate)
SetBody adds the body to the authenticate params
func (*AuthenticateParams) SetContext ¶
func (o *AuthenticateParams) SetContext(ctx context.Context)
SetContext adds the context to the authenticate params
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) WithBody ¶
func (o *AuthenticateParams) WithBody(body *rest_model.Authenticate) *AuthenticateParams
WithBody adds the body 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) 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 Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for authentication API
func (*Client) Authenticate ¶
func (a *Client) Authenticate(params *AuthenticateParams) (*AuthenticateOK, error)
Authenticate authenticates via a method supplied via a query string parameter
Allows authentication Methods include "password" and "cert"
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
Authenticate(params *AuthenticateParams) (*AuthenticateOK, 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