authentication

package
v0.19.79 Latest Latest
Warning

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

 Go to latest Published: Apr 14, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

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 AuthenticateMfaOK added in v0.17.52 

type AuthenticateMfaOK struct {
	Payload *rest_model.Empty
}

AuthenticateMfaOK handles this case with default header values.

Base empty response

func NewAuthenticateMfaOK added in v0.17.52 

func NewAuthenticateMfaOK() *AuthenticateMfaOK

NewAuthenticateMfaOK creates a AuthenticateMfaOK with default headers values

func (*AuthenticateMfaOK) Error added in v0.17.52 

func (o *AuthenticateMfaOK) Error() string

func (*AuthenticateMfaOK) GetPayload added in v0.17.52 

func (o *AuthenticateMfaOK) GetPayload() *rest_model.Empty

type AuthenticateMfaParams added in v0.17.52 

type AuthenticateMfaParams struct {

	/*MfaAuth
	  An MFA validation request

	*/
	MfaAuth *rest_model.MfaCode

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

AuthenticateMfaParams contains all the parameters to send to the API endpoint for the authenticate mfa operation typically these are written to a http.Request

func NewAuthenticateMfaParams added in v0.17.52 

func NewAuthenticateMfaParams() *AuthenticateMfaParams

NewAuthenticateMfaParams creates a new AuthenticateMfaParams object with the default values initialized.

func NewAuthenticateMfaParamsWithContext added in v0.17.52 

func NewAuthenticateMfaParamsWithContext(ctx context.Context) *AuthenticateMfaParams

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

func NewAuthenticateMfaParamsWithHTTPClient added in v0.17.52 

func NewAuthenticateMfaParamsWithHTTPClient(client *http.Client) *AuthenticateMfaParams

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

func NewAuthenticateMfaParamsWithTimeout added in v0.17.52 

func NewAuthenticateMfaParamsWithTimeout(timeout time.Duration) *AuthenticateMfaParams

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

func (*AuthenticateMfaParams) SetContext added in v0.17.52 

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

SetContext adds the context to the authenticate mfa params

func (*AuthenticateMfaParams) SetHTTPClient added in v0.17.52 

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

SetHTTPClient adds the HTTPClient to the authenticate mfa params

func (*AuthenticateMfaParams) SetMfaAuth added in v0.19.6 

func (o *AuthenticateMfaParams) SetMfaAuth(mfaAuth *rest_model.MfaCode)

SetMfaAuth adds the mfaAuth to the authenticate mfa params

func (*AuthenticateMfaParams) SetTimeout added in v0.17.52 

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

SetTimeout adds the timeout to the authenticate mfa params

func (*AuthenticateMfaParams) WithContext added in v0.17.52 

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

WithContext adds the context to the authenticate mfa params

func (*AuthenticateMfaParams) WithHTTPClient added in v0.17.52 

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

WithHTTPClient adds the HTTPClient to the authenticate mfa params

func (*AuthenticateMfaParams) WithMfaAuth added in v0.19.6 

func (o *AuthenticateMfaParams) WithMfaAuth(mfaAuth *rest_model.MfaCode) *AuthenticateMfaParams

WithMfaAuth adds the mfaAuth to the authenticate mfa params

func (*AuthenticateMfaParams) WithTimeout added in v0.17.52 

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

WithTimeout adds the timeout to the authenticate mfa params

func (*AuthenticateMfaParams) WriteToRequest added in v0.17.52 

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

WriteToRequest writes these params to a swagger request

type AuthenticateMfaReader added in v0.17.52 

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

AuthenticateMfaReader is a Reader for the AuthenticateMfa structure.

func (*AuthenticateMfaReader) ReadResponse added in v0.17.52 

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

ReadResponse reads a server response into the received o.

type AuthenticateMfaUnauthorized added in v0.17.52 

type AuthenticateMfaUnauthorized struct {
	Payload *rest_model.Empty
}

AuthenticateMfaUnauthorized handles this case with default header values.

Base empty response

func NewAuthenticateMfaUnauthorized added in v0.17.52 

func NewAuthenticateMfaUnauthorized() *AuthenticateMfaUnauthorized

NewAuthenticateMfaUnauthorized creates a AuthenticateMfaUnauthorized with default headers values

func (*AuthenticateMfaUnauthorized) Error added in v0.17.52 

func (o *AuthenticateMfaUnauthorized) Error() string

func (*AuthenticateMfaUnauthorized) GetPayload added in v0.17.52 

func (o *AuthenticateMfaUnauthorized) GetPayload() *rest_model.Empty

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 {

	/*Auth*/
	Auth *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) SetAuth added in v0.19.6 

func (o *AuthenticateParams) SetAuth(auth *rest_model.Authenticate)

SetAuth adds the auth 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) WithAuth added in v0.19.6 

func (o *AuthenticateParams) WithAuth(auth *rest_model.Authenticate) *AuthenticateParams

WithAuth adds the auth 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) AuthenticateMfa added in v0.17.52 

func (a *Client) AuthenticateMfa(params *AuthenticateMfaParams, authInfo runtime.ClientAuthInfoWriter) (*AuthenticateMfaOK, error)

AuthenticateMfa completes m f a authentication

Completes MFA authentication by submitting a MFA time based one time token or backup code.

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)

	AuthenticateMfa(params *AuthenticateMfaParams, authInfo runtime.ClientAuthInfoWriter) (*AuthenticateMfaOK, 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

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.