login

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 11, 2022 License: Apache-2.0 Imports: 10 Imported by: 1

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 login API

func (*Client) RetrieveAuthToken 

func (a *Client) RetrieveAuthToken(params *RetrieveAuthTokenParams, opts ...ClientOption) (*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 ClientOption added in v0.2.20 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService added in v0.2.18 

type ClientService interface {
	RetrieveAuthToken(params *RetrieveAuthTokenParams, opts ...ClientOption) (*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 describes a response with status code 400, 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 added in v0.2.9 

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

func (*RetrieveAuthTokenBadRequest) IsClientError added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) IsClientError() bool

IsClientError returns true when this retrieve auth token bad request response has a 4xx status code

func (*RetrieveAuthTokenBadRequest) IsCode added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) IsCode(code int) bool

IsCode returns true when this retrieve auth token bad request response a status code equal to that given

func (*RetrieveAuthTokenBadRequest) IsRedirect added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) IsRedirect() bool

IsRedirect returns true when this retrieve auth token bad request response has a 3xx status code

func (*RetrieveAuthTokenBadRequest) IsServerError added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) IsServerError() bool

IsServerError returns true when this retrieve auth token bad request response has a 5xx status code

func (*RetrieveAuthTokenBadRequest) IsSuccess added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) IsSuccess() bool

IsSuccess returns true when this retrieve auth token bad request response has a 2xx status code

func (*RetrieveAuthTokenBadRequest) String added in v0.5.0 

func (o *RetrieveAuthTokenBadRequest) String() string

type RetrieveAuthTokenForbidden 

type RetrieveAuthTokenForbidden struct {
	Payload *models.ServiceErrorResponse
}

RetrieveAuthTokenForbidden describes a response with status code 403, 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

func (*RetrieveAuthTokenForbidden) GetPayload added in v0.2.20 

func (o *RetrieveAuthTokenForbidden) GetPayload() *models.ServiceErrorResponse

func (*RetrieveAuthTokenForbidden) IsClientError added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) IsClientError() bool

IsClientError returns true when this retrieve auth token forbidden response has a 4xx status code

func (*RetrieveAuthTokenForbidden) IsCode added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) IsCode(code int) bool

IsCode returns true when this retrieve auth token forbidden response a status code equal to that given

func (*RetrieveAuthTokenForbidden) IsRedirect added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) IsRedirect() bool

IsRedirect returns true when this retrieve auth token forbidden response has a 3xx status code

func (*RetrieveAuthTokenForbidden) IsServerError added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) IsServerError() bool

IsServerError returns true when this retrieve auth token forbidden response has a 5xx status code

func (*RetrieveAuthTokenForbidden) IsSuccess added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) IsSuccess() bool

IsSuccess returns true when this retrieve auth token forbidden response has a 2xx status code

func (*RetrieveAuthTokenForbidden) String added in v0.5.0 

func (o *RetrieveAuthTokenForbidden) String() string

type RetrieveAuthTokenOK 

type RetrieveAuthTokenOK struct {
	Payload *models.AuthResponse
}

RetrieveAuthTokenOK describes a response with status code 200, 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

func (*RetrieveAuthTokenOK) IsClientError added in v0.5.0 

func (o *RetrieveAuthTokenOK) IsClientError() bool

IsClientError returns true when this retrieve auth token o k response has a 4xx status code

func (*RetrieveAuthTokenOK) IsCode added in v0.5.0 

func (o *RetrieveAuthTokenOK) IsCode(code int) bool

IsCode returns true when this retrieve auth token o k response a status code equal to that given

func (*RetrieveAuthTokenOK) IsRedirect added in v0.5.0 

func (o *RetrieveAuthTokenOK) IsRedirect() bool

IsRedirect returns true when this retrieve auth token o k response has a 3xx status code

func (*RetrieveAuthTokenOK) IsServerError added in v0.5.0 

func (o *RetrieveAuthTokenOK) IsServerError() bool

IsServerError returns true when this retrieve auth token o k response has a 5xx status code

func (*RetrieveAuthTokenOK) IsSuccess added in v0.5.0 

func (o *RetrieveAuthTokenOK) IsSuccess() bool

IsSuccess returns true when this retrieve auth token o k response has a 2xx status code

func (*RetrieveAuthTokenOK) String added in v0.5.0 

func (o *RetrieveAuthTokenOK) String() string

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 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 NewRetrieveAuthTokenParamsWithContext 

func NewRetrieveAuthTokenParamsWithContext(ctx context.Context) *RetrieveAuthTokenParams

NewRetrieveAuthTokenParamsWithContext creates a new RetrieveAuthTokenParams object with 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 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 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) SetDefaults added in v0.2.20 

func (o *RetrieveAuthTokenParams) SetDefaults()

SetDefaults hydrates default values in the retrieve auth token params (not the query body).

All values with no default are reset to their zero value.

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) WithDefaults added in v0.2.20 

func (o *RetrieveAuthTokenParams) WithDefaults() *RetrieveAuthTokenParams

WithDefaults hydrates default values in the retrieve auth token params (not the query body).

All values with no default are reset to their zero value.

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.