login

Documentation

Index

• type Client
  • func (a *Client) RetrieveAuthToken(params *RetrieveAuthTokenParams) (*RetrieveAuthTokenOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type RetrieveAuthTokenBadRequest
  • func NewRetrieveAuthTokenBadRequest() *RetrieveAuthTokenBadRequest
  • func (o *RetrieveAuthTokenBadRequest) Error() string
  • func (o *RetrieveAuthTokenBadRequest) GetPayload() *models.Error
• type RetrieveAuthTokenForbidden
  • func NewRetrieveAuthTokenForbidden() *RetrieveAuthTokenForbidden
  • func (o *RetrieveAuthTokenForbidden) Error() string
• type RetrieveAuthTokenOK
  • func NewRetrieveAuthTokenOK() *RetrieveAuthTokenOK
  • func (o *RetrieveAuthTokenOK) Error() string
  • func (o *RetrieveAuthTokenOK) GetPayload() *models.AuthResponse
• type RetrieveAuthTokenParams
  • func NewRetrieveAuthTokenParams() *RetrieveAuthTokenParams
  • func NewRetrieveAuthTokenParamsWithContext(ctx context.Context) *RetrieveAuthTokenParams
  • func NewRetrieveAuthTokenParamsWithHTTPClient(client *http.Client) *RetrieveAuthTokenParams
  • func NewRetrieveAuthTokenParamsWithTimeout(timeout time.Duration) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) SetAPIVersion(aPIVersion *string)
  • func (o *RetrieveAuthTokenParams) SetBody(body *models.CspLoginSpecification)
  • func (o *RetrieveAuthTokenParams) SetContext(ctx context.Context)
  • func (o *RetrieveAuthTokenParams) SetHTTPClient(client *http.Client)
  • func (o *RetrieveAuthTokenParams) SetTimeout(timeout time.Duration)
  • func (o *RetrieveAuthTokenParams) WithAPIVersion(aPIVersion *string) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) WithBody(body *models.CspLoginSpecification) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) WithContext(ctx context.Context) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) WithHTTPClient(client *http.Client) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) WithTimeout(timeout time.Duration) *RetrieveAuthTokenParams
  • func (o *RetrieveAuthTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type RetrieveAuthTokenReader
  • func (o *RetrieveAuthTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for login API

func (*Client) RetrieveAuthToken

func (a *Client) RetrieveAuthToken(params *RetrieveAuthTokenParams) (*RetrieveAuthTokenOK, error)

RetrieveAuthToken retrieves auth token for local csp users

Retrieve AuthToken for local csp users.

When accessing other endpoints the `Bearer` authentication scheme and the received `token` must be provided in the `Authorization` request header field as follows: `Authorization: Bearer {token}`

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	RetrieveAuthToken(params *RetrieveAuthTokenParams) (*RetrieveAuthTokenOK, 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 login API client.

type RetrieveAuthTokenBadRequest

type RetrieveAuthTokenBadRequest struct {
	Payload *models.Error
}

RetrieveAuthTokenBadRequest handles this case with default header values.

Invalid Request - bad data

func NewRetrieveAuthTokenBadRequest

func NewRetrieveAuthTokenBadRequest() *RetrieveAuthTokenBadRequest

NewRetrieveAuthTokenBadRequest creates a RetrieveAuthTokenBadRequest with default headers values

func (*RetrieveAuthTokenBadRequest) Error

func (o *RetrieveAuthTokenBadRequest) Error() string

func (*RetrieveAuthTokenBadRequest) GetPayload

func (o *RetrieveAuthTokenBadRequest) GetPayload() *models.Error

type RetrieveAuthTokenForbidden

type RetrieveAuthTokenForbidden struct {
}

RetrieveAuthTokenForbidden handles this case with default header values.

Forbidden

func NewRetrieveAuthTokenForbidden

func NewRetrieveAuthTokenForbidden() *RetrieveAuthTokenForbidden

NewRetrieveAuthTokenForbidden creates a RetrieveAuthTokenForbidden with default headers values

func (*RetrieveAuthTokenForbidden) Error

func (o *RetrieveAuthTokenForbidden) Error() string

type RetrieveAuthTokenOK

type RetrieveAuthTokenOK struct {
	Payload *models.AuthResponse
}

RetrieveAuthTokenOK handles this case with default header values.

successful operation

func NewRetrieveAuthTokenOK

func NewRetrieveAuthTokenOK() *RetrieveAuthTokenOK

NewRetrieveAuthTokenOK creates a RetrieveAuthTokenOK with default headers values

func (*RetrieveAuthTokenOK) Error

func (o *RetrieveAuthTokenOK) Error() string

func (*RetrieveAuthTokenOK) GetPayload

func (o *RetrieveAuthTokenOK) GetPayload() *models.AuthResponse

type RetrieveAuthTokenParams

type RetrieveAuthTokenParams struct {

	/*APIVersion
	  The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

	*/
	APIVersion *string
	/*Body
	  CspLoginSpecification instance

	*/
	Body *models.CspLoginSpecification

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

RetrieveAuthTokenParams contains all the parameters to send to the API endpoint for the retrieve auth token operation typically these are written to a http.Request

func NewRetrieveAuthTokenParams

func NewRetrieveAuthTokenParams() *RetrieveAuthTokenParams

NewRetrieveAuthTokenParams creates a new RetrieveAuthTokenParams object with the default values initialized.

func NewRetrieveAuthTokenParamsWithContext

func NewRetrieveAuthTokenParamsWithContext(ctx context.Context) *RetrieveAuthTokenParams

NewRetrieveAuthTokenParamsWithContext creates a new RetrieveAuthTokenParams object with the default values initialized, and the ability to set a context for a request

func NewRetrieveAuthTokenParamsWithHTTPClient

func NewRetrieveAuthTokenParamsWithHTTPClient(client *http.Client) *RetrieveAuthTokenParams

NewRetrieveAuthTokenParamsWithHTTPClient creates a new RetrieveAuthTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewRetrieveAuthTokenParamsWithTimeout

func NewRetrieveAuthTokenParamsWithTimeout(timeout time.Duration) *RetrieveAuthTokenParams

NewRetrieveAuthTokenParamsWithTimeout creates a new RetrieveAuthTokenParams object with the default values initialized, and the ability to set a timeout on a request

func (*RetrieveAuthTokenParams) SetAPIVersion

func (o *RetrieveAuthTokenParams) SetAPIVersion(aPIVersion *string)

SetAPIVersion adds the apiVersion to the retrieve auth token params

func (*RetrieveAuthTokenParams) SetBody

func (o *RetrieveAuthTokenParams) SetBody(body *models.CspLoginSpecification)

SetBody adds the body to the retrieve auth token params

func (*RetrieveAuthTokenParams) SetContext

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

SetContext adds the context to the retrieve auth token params

func (*RetrieveAuthTokenParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the retrieve auth token params

func (*RetrieveAuthTokenParams) SetTimeout

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

SetTimeout adds the timeout to the retrieve auth token params

func (*RetrieveAuthTokenParams) WithAPIVersion

func (o *RetrieveAuthTokenParams) WithAPIVersion(aPIVersion *string) *RetrieveAuthTokenParams

WithAPIVersion adds the aPIVersion to the retrieve auth token params

func (*RetrieveAuthTokenParams) WithBody

func (o *RetrieveAuthTokenParams) WithBody(body *models.CspLoginSpecification) *RetrieveAuthTokenParams

WithBody adds the body to the retrieve auth token params

func (*RetrieveAuthTokenParams) WithContext

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

WithContext adds the context to the retrieve auth token params

func (*RetrieveAuthTokenParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the retrieve auth token params

func (*RetrieveAuthTokenParams) WithTimeout

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

WithTimeout adds the timeout to the retrieve auth token params

func (*RetrieveAuthTokenParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type RetrieveAuthTokenReader

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

RetrieveAuthTokenReader is a Reader for the RetrieveAuthToken structure.

func (*RetrieveAuthTokenReader) ReadResponse

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

ReadResponse reads a server response into the received o.