Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for api auth API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new api auth API client.
func (*Client) Login ¶
func (a *Client) Login(params *LoginParams) (*LoginOK, error)
Login logins
### Login in order to use the API.
func (*Client) Logout ¶
func (a *Client) Logout(params *LogoutParams) (*LogoutNoContent, error)
Logout logouts
### Logout of the API and invalidate the current access token.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type LoginBadRequest ¶
type LoginBadRequest struct {
Payload
}
LoginBadRequest handles this case with default header values.
Bad Request
func NewLoginBadRequest ¶
func NewLoginBadRequest() *LoginBadRequest
NewLoginBadRequest creates a LoginBadRequest with default headers values
func (*LoginBadRequest) Error ¶
func (o *LoginBadRequest) Error() string
type LoginNotFound ¶
type LoginNotFound struct {
Payload
}
LoginNotFound handles this case with default header values.
Not Found
func NewLoginNotFound ¶
func NewLoginNotFound() *LoginNotFound
NewLoginNotFound creates a LoginNotFound with default headers values
func (*LoginNotFound) Error ¶
func (o *LoginNotFound) Error() string
type LoginOK ¶
type LoginOK struct {
Payload *models.AccessToken
}
LoginOK handles this case with default header values.
Access token with metadata.
func NewLoginOK ¶
func NewLoginOK() *LoginOK
NewLoginOK creates a LoginOK with default headers values
type LoginParams ¶
type LoginParams struct {
/*ClientID
client_id part of API3 Key.
*/
ClientID *string
/*ClientSecret
client_secret part of API3 Key.
*/
ClientSecret *string
// contains filtered or unexported fields
}
LoginParams contains all the parameters to send to the API endpoint for the login operation typically these are written to a http.Request
func NewLoginParams ¶
func NewLoginParams() *LoginParams
NewLoginParams creates a new LoginParams object with the default values initialized.
func NewLoginParamsWithTimeout ¶
func NewLoginParamsWithTimeout(timeout time.Duration) *LoginParams
NewLoginParamsWithTimeout creates a new LoginParams object with the default values initialized, and the ability to set a timeout on a request
func (*LoginParams) WithClientID ¶
func (o *LoginParams) WithClientID(ClientID *string) *LoginParams
WithClientID adds the clientId to the login params
func (*LoginParams) WithClientSecret ¶
func (o *LoginParams) WithClientSecret(ClientSecret *string) *LoginParams
WithClientSecret adds the clientSecret to the login params
func (*LoginParams) WriteToRequest ¶
func (o *LoginParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type LoginReader ¶
type LoginReader struct {
// contains filtered or unexported fields
}
LoginReader is a Reader for the Login structure.
func (*LoginReader) ReadResponse ¶
func (o *LoginReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the recieved o.
type LogoutBadRequest ¶
type LogoutBadRequest struct {
Payload
}
LogoutBadRequest handles this case with default header values.
Bad Request
func NewLogoutBadRequest ¶
func NewLogoutBadRequest() *LogoutBadRequest
NewLogoutBadRequest creates a LogoutBadRequest with default headers values
func (*LogoutBadRequest) Error ¶
func (o *LogoutBadRequest) Error() string
type LogoutNoContent ¶
type LogoutNoContent struct {
Payload string
}
LogoutNoContent handles this case with default header values.
Logged out successfully.
func NewLogoutNoContent ¶
func NewLogoutNoContent() *LogoutNoContent
NewLogoutNoContent creates a LogoutNoContent with default headers values
func (*LogoutNoContent) Error ¶
func (o *LogoutNoContent) Error() string
type LogoutNotFound ¶
type LogoutNotFound struct {
Payload
}
LogoutNotFound handles this case with default header values.
Not Found
func NewLogoutNotFound ¶
func NewLogoutNotFound() *LogoutNotFound
NewLogoutNotFound creates a LogoutNotFound with default headers values
func (*LogoutNotFound) Error ¶
func (o *LogoutNotFound) Error() string
type LogoutParams ¶
type LogoutParams struct {
// contains filtered or unexported fields
}
LogoutParams contains all the parameters to send to the API endpoint for the logout operation typically these are written to a http.Request
func NewLogoutParams ¶
func NewLogoutParams() *LogoutParams
NewLogoutParams creates a new LogoutParams object with the default values initialized.
func NewLogoutParamsWithTimeout ¶
func NewLogoutParamsWithTimeout(timeout time.Duration) *LogoutParams
NewLogoutParamsWithTimeout creates a new LogoutParams object with the default values initialized, and the ability to set a timeout on a request
func (*LogoutParams) WriteToRequest ¶
func (o *LogoutParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type LogoutReader ¶
type LogoutReader struct {
// contains filtered or unexported fields
}
LogoutReader is a Reader for the Logout structure.
func (*LogoutReader) ReadResponse ¶
func (o *LogoutReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the recieved o.
Source Files