Documentation
¶
Index ¶
- type Client
- type GetRefreshTokenOK
- type GetRefreshTokenParams
- func NewGetRefreshTokenParams() *GetRefreshTokenParams
- func NewGetRefreshTokenParamsWithContext(ctx context.Context) *GetRefreshTokenParams
- func NewGetRefreshTokenParamsWithHTTPClient(client *http.Client) *GetRefreshTokenParams
- func NewGetRefreshTokenParamsWithTimeout(timeout time.Duration) *GetRefreshTokenParams
- func (o *GetRefreshTokenParams) SetContext(ctx context.Context)
- func (o *GetRefreshTokenParams) SetHTTPClient(client *http.Client)
- func (o *GetRefreshTokenParams) SetTimeout(timeout time.Duration)
- func (o *GetRefreshTokenParams) WithContext(ctx context.Context) *GetRefreshTokenParams
- func (o *GetRefreshTokenParams) WithHTTPClient(client *http.Client) *GetRefreshTokenParams
- func (o *GetRefreshTokenParams) WithTimeout(timeout time.Duration) *GetRefreshTokenParams
- func (o *GetRefreshTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetRefreshTokenReader
- type GetRefreshTokenUnauthorized
- type PostLoginOK
- type PostLoginParams
- func (o *PostLoginParams) SetAuthenticationString(authenticationString *models.Auth)
- func (o *PostLoginParams) SetContext(ctx context.Context)
- func (o *PostLoginParams) SetHTTPClient(client *http.Client)
- func (o *PostLoginParams) SetTimeout(timeout time.Duration)
- func (o *PostLoginParams) WithAuthenticationString(authenticationString *models.Auth) *PostLoginParams
- func (o *PostLoginParams) WithContext(ctx context.Context) *PostLoginParams
- func (o *PostLoginParams) WithHTTPClient(client *http.Client) *PostLoginParams
- func (o *PostLoginParams) WithTimeout(timeout time.Duration) *PostLoginParams
- func (o *PostLoginParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type PostLoginReader
- type PostLoginUnauthorized
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 authentication API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new authentication API client.
func (*Client) GetRefreshToken ¶
func (a *Client) GetRefreshToken(params *GetRefreshTokenParams, authInfo runtime.ClientAuthInfoWriter) (*GetRefreshTokenOK, error)
GetRefreshToken Refreshes your current, valid JWT token and returns a new token. Hit this route so that you do not have to post to `/login` with your API key and credentials once you have already been authenticated.
func (*Client) PostLogin ¶
func (a *Client) PostLogin(params *PostLoginParams) (*PostLoginOK, error)
PostLogin Returns a session token to be included in the rest of the requests. Note that API key authentication is required for all subsequent requests and user auth is required for routes in the `User` section
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type GetRefreshTokenOK ¶
GetRefreshTokenOK handles this case with default header values.
Returns a new token to use in your subsequent requests
func NewGetRefreshTokenOK ¶
func NewGetRefreshTokenOK() *GetRefreshTokenOK
NewGetRefreshTokenOK creates a GetRefreshTokenOK with default headers values
func (*GetRefreshTokenOK) Error ¶
func (o *GetRefreshTokenOK) Error() string
func (*GetRefreshTokenOK) GetPayload ¶
func (o *GetRefreshTokenOK) GetPayload() *models.Token
type GetRefreshTokenParams ¶
type GetRefreshTokenParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetRefreshTokenParams contains all the parameters to send to the API endpoint for the get refresh token operation typically these are written to a http.Request
func NewGetRefreshTokenParams ¶
func NewGetRefreshTokenParams() *GetRefreshTokenParams
NewGetRefreshTokenParams creates a new GetRefreshTokenParams object with the default values initialized.
func NewGetRefreshTokenParamsWithContext ¶
func NewGetRefreshTokenParamsWithContext(ctx context.Context) *GetRefreshTokenParams
NewGetRefreshTokenParamsWithContext creates a new GetRefreshTokenParams object with the default values initialized, and the ability to set a context for a request
func NewGetRefreshTokenParamsWithHTTPClient ¶
func NewGetRefreshTokenParamsWithHTTPClient(client *http.Client) *GetRefreshTokenParams
NewGetRefreshTokenParamsWithHTTPClient creates a new GetRefreshTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetRefreshTokenParamsWithTimeout ¶
func NewGetRefreshTokenParamsWithTimeout(timeout time.Duration) *GetRefreshTokenParams
NewGetRefreshTokenParamsWithTimeout creates a new GetRefreshTokenParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetRefreshTokenParams) SetContext ¶
func (o *GetRefreshTokenParams) SetContext(ctx context.Context)
SetContext adds the context to the get refresh token params
func (*GetRefreshTokenParams) SetHTTPClient ¶
func (o *GetRefreshTokenParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get refresh token params
func (*GetRefreshTokenParams) SetTimeout ¶
func (o *GetRefreshTokenParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get refresh token params
func (*GetRefreshTokenParams) WithContext ¶
func (o *GetRefreshTokenParams) WithContext(ctx context.Context) *GetRefreshTokenParams
WithContext adds the context to the get refresh token params
func (*GetRefreshTokenParams) WithHTTPClient ¶
func (o *GetRefreshTokenParams) WithHTTPClient(client *http.Client) *GetRefreshTokenParams
WithHTTPClient adds the HTTPClient to the get refresh token params
func (*GetRefreshTokenParams) WithTimeout ¶
func (o *GetRefreshTokenParams) WithTimeout(timeout time.Duration) *GetRefreshTokenParams
WithTimeout adds the timeout to the get refresh token params
func (*GetRefreshTokenParams) WriteToRequest ¶
func (o *GetRefreshTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetRefreshTokenReader ¶
type GetRefreshTokenReader struct {
// contains filtered or unexported fields
}
GetRefreshTokenReader is a Reader for the GetRefreshToken structure.
func (*GetRefreshTokenReader) ReadResponse ¶
func (o *GetRefreshTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetRefreshTokenUnauthorized ¶
type GetRefreshTokenUnauthorized struct {
}
GetRefreshTokenUnauthorized handles this case with default header values.
Returned if your JWT token is missing or expired
func NewGetRefreshTokenUnauthorized ¶
func NewGetRefreshTokenUnauthorized() *GetRefreshTokenUnauthorized
NewGetRefreshTokenUnauthorized creates a GetRefreshTokenUnauthorized with default headers values
func (*GetRefreshTokenUnauthorized) Error ¶
func (o *GetRefreshTokenUnauthorized) Error() string
func (*GetRefreshTokenUnauthorized) GetPayload ¶
func (o *GetRefreshTokenUnauthorized) GetPayload() *models.NotAuthorized
type PostLoginOK ¶
PostLoginOK handles this case with default header values.
Returns a JWT token for use with the rest of the API routes
func NewPostLoginOK ¶
func NewPostLoginOK() *PostLoginOK
NewPostLoginOK creates a PostLoginOK with default headers values
func (*PostLoginOK) Error ¶
func (o *PostLoginOK) Error() string
func (*PostLoginOK) GetPayload ¶
func (o *PostLoginOK) GetPayload() *models.Token
type PostLoginParams ¶
type PostLoginParams struct {
/*AuthenticationString
JSON string containing your authentication details.
*/
AuthenticationString *models.Auth
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
PostLoginParams contains all the parameters to send to the API endpoint for the post login operation typically these are written to a http.Request
func NewPostLoginParams ¶
func NewPostLoginParams() *PostLoginParams
NewPostLoginParams creates a new PostLoginParams object with the default values initialized.
func NewPostLoginParamsWithContext ¶
func NewPostLoginParamsWithContext(ctx context.Context) *PostLoginParams
NewPostLoginParamsWithContext creates a new PostLoginParams object with the default values initialized, and the ability to set a context for a request
func NewPostLoginParamsWithHTTPClient ¶
func NewPostLoginParamsWithHTTPClient(client *http.Client) *PostLoginParams
NewPostLoginParamsWithHTTPClient creates a new PostLoginParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewPostLoginParamsWithTimeout ¶
func NewPostLoginParamsWithTimeout(timeout time.Duration) *PostLoginParams
NewPostLoginParamsWithTimeout creates a new PostLoginParams object with the default values initialized, and the ability to set a timeout on a request
func (*PostLoginParams) SetAuthenticationString ¶
func (o *PostLoginParams) SetAuthenticationString(authenticationString *models.Auth)
SetAuthenticationString adds the authenticationString to the post login params
func (*PostLoginParams) SetContext ¶
func (o *PostLoginParams) SetContext(ctx context.Context)
SetContext adds the context to the post login params
func (*PostLoginParams) SetHTTPClient ¶
func (o *PostLoginParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the post login params
func (*PostLoginParams) SetTimeout ¶
func (o *PostLoginParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the post login params
func (*PostLoginParams) WithAuthenticationString ¶
func (o *PostLoginParams) WithAuthenticationString(authenticationString *models.Auth) *PostLoginParams
WithAuthenticationString adds the authenticationString to the post login params
func (*PostLoginParams) WithContext ¶
func (o *PostLoginParams) WithContext(ctx context.Context) *PostLoginParams
WithContext adds the context to the post login params
func (*PostLoginParams) WithHTTPClient ¶
func (o *PostLoginParams) WithHTTPClient(client *http.Client) *PostLoginParams
WithHTTPClient adds the HTTPClient to the post login params
func (*PostLoginParams) WithTimeout ¶
func (o *PostLoginParams) WithTimeout(timeout time.Duration) *PostLoginParams
WithTimeout adds the timeout to the post login params
func (*PostLoginParams) WriteToRequest ¶
func (o *PostLoginParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type PostLoginReader ¶
type PostLoginReader struct {
// contains filtered or unexported fields
}
PostLoginReader is a Reader for the PostLogin structure.
func (*PostLoginReader) ReadResponse ¶
func (o *PostLoginReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type PostLoginUnauthorized ¶
type PostLoginUnauthorized struct {
}
PostLoginUnauthorized handles this case with default header values.
Invalid credentials and/or API token
func NewPostLoginUnauthorized ¶
func NewPostLoginUnauthorized() *PostLoginUnauthorized
NewPostLoginUnauthorized creates a PostLoginUnauthorized with default headers values
func (*PostLoginUnauthorized) Error ¶
func (o *PostLoginUnauthorized) Error() string
func (*PostLoginUnauthorized) GetPayload ¶
func (o *PostLoginUnauthorized) GetPayload() *models.NotAuthorized
Source Files