o_t_p

package
v0.0.0-...-7b99a6d Latest Latest
Warning

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

Go to latest
Published: Jan 29, 2024 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 Client

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

Client for o t p API

func (*Client) RequestAddressVerification

RequestAddressVerification requests address verification

Generate and send a verification link to the provided address.

The `address` value must be a valid email or mobile number marked as the user's `unverified address` and must not be a verified address of any other user.

Error `404` is returned when either `userID` or `address` are incorrect.

The requested link validity period is configured in the identity pool settings.

func (*Client) RequestOTPChallenge

func (a *Client) RequestOTPChallenge(params *RequestOTPChallengeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RequestOTPChallengeNoContent, error)
RequestOTPChallenge requests o t p challenge

Generate and send an OTP to the provided address.

The `address` value must be a valid email or mobile number marked as the user's `unverified address` and must not be a verified address of any other user.

The requested OTP validity period is configured in the identity pool settings.

Generating new challenge invalidates a previous challenge.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) VerifyOTP

func (a *Client) VerifyOTP(params *VerifyOTPParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*VerifyOTPOK, error)
VerifyOTP verifies o t p challenge

Verify the OTP generates as part of a challenge-response mechanism.

A valid OTP is removed, and the endpoint returns the **Request accepted** response.

For password change or activation, call **Request Reset Password** and **Send Activation Message**. Find these endpoints documented under the **Users** section of this specification.

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	RequestAddressVerification(params *RequestAddressVerificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RequestAddressVerificationNoContent, error)

	RequestOTPChallenge(params *RequestOTPChallengeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RequestOTPChallengeNoContent, error)

	VerifyOTP(params *VerifyOTPParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*VerifyOTPOK, 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 o t p API client.

type RequestAddressVerificationBadRequest

type RequestAddressVerificationBadRequest struct {
	Payload *models.Error
}

RequestAddressVerificationBadRequest describes a response with status code 400, with default header values.

Bad request

func NewRequestAddressVerificationBadRequest

func NewRequestAddressVerificationBadRequest() *RequestAddressVerificationBadRequest

NewRequestAddressVerificationBadRequest creates a RequestAddressVerificationBadRequest with default headers values

func (*RequestAddressVerificationBadRequest) Code

Code gets the status code for the request address verification bad request response

func (*RequestAddressVerificationBadRequest) Error

func (*RequestAddressVerificationBadRequest) GetPayload

func (*RequestAddressVerificationBadRequest) IsClientError

func (o *RequestAddressVerificationBadRequest) IsClientError() bool

IsClientError returns true when this request address verification bad request response has a 4xx status code

func (*RequestAddressVerificationBadRequest) IsCode

IsCode returns true when this request address verification bad request response a status code equal to that given

func (*RequestAddressVerificationBadRequest) IsRedirect

IsRedirect returns true when this request address verification bad request response has a 3xx status code

func (*RequestAddressVerificationBadRequest) IsServerError

func (o *RequestAddressVerificationBadRequest) IsServerError() bool

IsServerError returns true when this request address verification bad request response has a 5xx status code

func (*RequestAddressVerificationBadRequest) IsSuccess

IsSuccess returns true when this request address verification bad request response has a 2xx status code

func (*RequestAddressVerificationBadRequest) String

type RequestAddressVerificationConflict

type RequestAddressVerificationConflict struct {
	Payload *models.Error
}

RequestAddressVerificationConflict describes a response with status code 409, with default header values.

Conflict

func NewRequestAddressVerificationConflict

func NewRequestAddressVerificationConflict() *RequestAddressVerificationConflict

NewRequestAddressVerificationConflict creates a RequestAddressVerificationConflict with default headers values

func (*RequestAddressVerificationConflict) Code

Code gets the status code for the request address verification conflict response

func (*RequestAddressVerificationConflict) Error

func (*RequestAddressVerificationConflict) GetPayload

func (*RequestAddressVerificationConflict) IsClientError

func (o *RequestAddressVerificationConflict) IsClientError() bool

IsClientError returns true when this request address verification conflict response has a 4xx status code

func (*RequestAddressVerificationConflict) IsCode

IsCode returns true when this request address verification conflict response a status code equal to that given

func (*RequestAddressVerificationConflict) IsRedirect

func (o *RequestAddressVerificationConflict) IsRedirect() bool

IsRedirect returns true when this request address verification conflict response has a 3xx status code

func (*RequestAddressVerificationConflict) IsServerError

func (o *RequestAddressVerificationConflict) IsServerError() bool

IsServerError returns true when this request address verification conflict response has a 5xx status code

func (*RequestAddressVerificationConflict) IsSuccess

IsSuccess returns true when this request address verification conflict response has a 2xx status code

func (*RequestAddressVerificationConflict) String

type RequestAddressVerificationNoContent

type RequestAddressVerificationNoContent struct {
}

RequestAddressVerificationNoContent describes a response with status code 204, with default header values.

Request accepted

func NewRequestAddressVerificationNoContent

func NewRequestAddressVerificationNoContent() *RequestAddressVerificationNoContent

NewRequestAddressVerificationNoContent creates a RequestAddressVerificationNoContent with default headers values

func (*RequestAddressVerificationNoContent) Code

Code gets the status code for the request address verification no content response

func (*RequestAddressVerificationNoContent) Error

func (*RequestAddressVerificationNoContent) IsClientError

func (o *RequestAddressVerificationNoContent) IsClientError() bool

IsClientError returns true when this request address verification no content response has a 4xx status code

func (*RequestAddressVerificationNoContent) IsCode

IsCode returns true when this request address verification no content response a status code equal to that given

func (*RequestAddressVerificationNoContent) IsRedirect

func (o *RequestAddressVerificationNoContent) IsRedirect() bool

IsRedirect returns true when this request address verification no content response has a 3xx status code

func (*RequestAddressVerificationNoContent) IsServerError

func (o *RequestAddressVerificationNoContent) IsServerError() bool

IsServerError returns true when this request address verification no content response has a 5xx status code

func (*RequestAddressVerificationNoContent) IsSuccess

IsSuccess returns true when this request address verification no content response has a 2xx status code

func (*RequestAddressVerificationNoContent) String

type RequestAddressVerificationNotFound

type RequestAddressVerificationNotFound struct {
	Payload *models.Error
}

RequestAddressVerificationNotFound describes a response with status code 404, with default header values.

Not found

func NewRequestAddressVerificationNotFound

func NewRequestAddressVerificationNotFound() *RequestAddressVerificationNotFound

NewRequestAddressVerificationNotFound creates a RequestAddressVerificationNotFound with default headers values

func (*RequestAddressVerificationNotFound) Code

Code gets the status code for the request address verification not found response

func (*RequestAddressVerificationNotFound) Error

func (*RequestAddressVerificationNotFound) GetPayload

func (*RequestAddressVerificationNotFound) IsClientError

func (o *RequestAddressVerificationNotFound) IsClientError() bool

IsClientError returns true when this request address verification not found response has a 4xx status code

func (*RequestAddressVerificationNotFound) IsCode

IsCode returns true when this request address verification not found response a status code equal to that given

func (*RequestAddressVerificationNotFound) IsRedirect

func (o *RequestAddressVerificationNotFound) IsRedirect() bool

IsRedirect returns true when this request address verification not found response has a 3xx status code

func (*RequestAddressVerificationNotFound) IsServerError

func (o *RequestAddressVerificationNotFound) IsServerError() bool

IsServerError returns true when this request address verification not found response has a 5xx status code

func (*RequestAddressVerificationNotFound) IsSuccess

IsSuccess returns true when this request address verification not found response has a 2xx status code

func (*RequestAddressVerificationNotFound) String

type RequestAddressVerificationParams

type RequestAddressVerificationParams struct {

	// RequestAddressVerification.
	RequestAddressVerification *models.RequestOTPForAddress

	// IPID.
	IPID string

	/* ServerID.

	     optional server's identifier (used for themes etc.)
	ServerID
	*/
	ServerID *string

	// UserID.
	UserID string

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

RequestAddressVerificationParams contains all the parameters to send to the API endpoint

for the request address verification operation.

Typically these are written to a http.Request.

func NewRequestAddressVerificationParams

func NewRequestAddressVerificationParams() *RequestAddressVerificationParams

NewRequestAddressVerificationParams creates a new RequestAddressVerificationParams 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 NewRequestAddressVerificationParamsWithContext

func NewRequestAddressVerificationParamsWithContext(ctx context.Context) *RequestAddressVerificationParams

NewRequestAddressVerificationParamsWithContext creates a new RequestAddressVerificationParams object with the ability to set a context for a request.

func NewRequestAddressVerificationParamsWithHTTPClient

func NewRequestAddressVerificationParamsWithHTTPClient(client *http.Client) *RequestAddressVerificationParams

NewRequestAddressVerificationParamsWithHTTPClient creates a new RequestAddressVerificationParams object with the ability to set a custom HTTPClient for a request.

func NewRequestAddressVerificationParamsWithTimeout

func NewRequestAddressVerificationParamsWithTimeout(timeout time.Duration) *RequestAddressVerificationParams

NewRequestAddressVerificationParamsWithTimeout creates a new RequestAddressVerificationParams object with the ability to set a timeout on a request.

func (*RequestAddressVerificationParams) SetContext

SetContext adds the context to the request address verification params

func (*RequestAddressVerificationParams) SetDefaults

func (o *RequestAddressVerificationParams) SetDefaults()

SetDefaults hydrates default values in the request address verification params (not the query body).

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

func (*RequestAddressVerificationParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the request address verification params

func (*RequestAddressVerificationParams) SetIPID

func (o *RequestAddressVerificationParams) SetIPID(iPID string)

SetIPID adds the ipId to the request address verification params

func (*RequestAddressVerificationParams) SetRequestAddressVerification

func (o *RequestAddressVerificationParams) SetRequestAddressVerification(requestAddressVerification *models.RequestOTPForAddress)

SetRequestAddressVerification adds the requestAddressVerification to the request address verification params

func (*RequestAddressVerificationParams) SetServerID

func (o *RequestAddressVerificationParams) SetServerID(serverID *string)

SetServerID adds the serverId to the request address verification params

func (*RequestAddressVerificationParams) SetTimeout

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

SetTimeout adds the timeout to the request address verification params

func (*RequestAddressVerificationParams) SetUserID

func (o *RequestAddressVerificationParams) SetUserID(userID string)

SetUserID adds the userId to the request address verification params

func (*RequestAddressVerificationParams) WithContext

WithContext adds the context to the request address verification params

func (*RequestAddressVerificationParams) WithDefaults

WithDefaults hydrates default values in the request address verification params (not the query body).

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

func (*RequestAddressVerificationParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the request address verification params

func (*RequestAddressVerificationParams) WithIPID

WithIPID adds the iPID to the request address verification params

func (*RequestAddressVerificationParams) WithRequestAddressVerification

func (o *RequestAddressVerificationParams) WithRequestAddressVerification(requestAddressVerification *models.RequestOTPForAddress) *RequestAddressVerificationParams

WithRequestAddressVerification adds the requestAddressVerification to the request address verification params

func (*RequestAddressVerificationParams) WithServerID

WithServerID adds the serverID to the request address verification params

func (*RequestAddressVerificationParams) WithTimeout

WithTimeout adds the timeout to the request address verification params

func (*RequestAddressVerificationParams) WithUserID

WithUserID adds the userID to the request address verification params

func (*RequestAddressVerificationParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type RequestAddressVerificationPreconditionFailed

type RequestAddressVerificationPreconditionFailed struct {
	Payload *models.Error
}

RequestAddressVerificationPreconditionFailed describes a response with status code 412, with default header values.

Payload too large

func NewRequestAddressVerificationPreconditionFailed

func NewRequestAddressVerificationPreconditionFailed() *RequestAddressVerificationPreconditionFailed

NewRequestAddressVerificationPreconditionFailed creates a RequestAddressVerificationPreconditionFailed with default headers values

func (*RequestAddressVerificationPreconditionFailed) Code

Code gets the status code for the request address verification precondition failed response

func (*RequestAddressVerificationPreconditionFailed) Error

func (*RequestAddressVerificationPreconditionFailed) GetPayload

func (*RequestAddressVerificationPreconditionFailed) IsClientError

IsClientError returns true when this request address verification precondition failed response has a 4xx status code

func (*RequestAddressVerificationPreconditionFailed) IsCode

IsCode returns true when this request address verification precondition failed response a status code equal to that given

func (*RequestAddressVerificationPreconditionFailed) IsRedirect

IsRedirect returns true when this request address verification precondition failed response has a 3xx status code

func (*RequestAddressVerificationPreconditionFailed) IsServerError

IsServerError returns true when this request address verification precondition failed response has a 5xx status code

func (*RequestAddressVerificationPreconditionFailed) IsSuccess

IsSuccess returns true when this request address verification precondition failed response has a 2xx status code

func (*RequestAddressVerificationPreconditionFailed) String

type RequestAddressVerificationReader

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

RequestAddressVerificationReader is a Reader for the RequestAddressVerification structure.

func (*RequestAddressVerificationReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type RequestAddressVerificationTooManyRequests

type RequestAddressVerificationTooManyRequests struct {
	Payload *models.Error
}

RequestAddressVerificationTooManyRequests describes a response with status code 429, with default header values.

Too many requests

func NewRequestAddressVerificationTooManyRequests

func NewRequestAddressVerificationTooManyRequests() *RequestAddressVerificationTooManyRequests

NewRequestAddressVerificationTooManyRequests creates a RequestAddressVerificationTooManyRequests with default headers values

func (*RequestAddressVerificationTooManyRequests) Code

Code gets the status code for the request address verification too many requests response

func (*RequestAddressVerificationTooManyRequests) Error

func (*RequestAddressVerificationTooManyRequests) GetPayload

func (*RequestAddressVerificationTooManyRequests) IsClientError

IsClientError returns true when this request address verification too many requests response has a 4xx status code

func (*RequestAddressVerificationTooManyRequests) IsCode

IsCode returns true when this request address verification too many requests response a status code equal to that given

func (*RequestAddressVerificationTooManyRequests) IsRedirect

IsRedirect returns true when this request address verification too many requests response has a 3xx status code

func (*RequestAddressVerificationTooManyRequests) IsServerError

IsServerError returns true when this request address verification too many requests response has a 5xx status code

func (*RequestAddressVerificationTooManyRequests) IsSuccess

IsSuccess returns true when this request address verification too many requests response has a 2xx status code

func (*RequestAddressVerificationTooManyRequests) String

type RequestAddressVerificationUnauthorized

type RequestAddressVerificationUnauthorized struct {
	Payload *models.Error
}

RequestAddressVerificationUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewRequestAddressVerificationUnauthorized

func NewRequestAddressVerificationUnauthorized() *RequestAddressVerificationUnauthorized

NewRequestAddressVerificationUnauthorized creates a RequestAddressVerificationUnauthorized with default headers values

func (*RequestAddressVerificationUnauthorized) Code

Code gets the status code for the request address verification unauthorized response

func (*RequestAddressVerificationUnauthorized) Error

func (*RequestAddressVerificationUnauthorized) GetPayload

func (*RequestAddressVerificationUnauthorized) IsClientError

func (o *RequestAddressVerificationUnauthorized) IsClientError() bool

IsClientError returns true when this request address verification unauthorized response has a 4xx status code

func (*RequestAddressVerificationUnauthorized) IsCode

IsCode returns true when this request address verification unauthorized response a status code equal to that given

func (*RequestAddressVerificationUnauthorized) IsRedirect

IsRedirect returns true when this request address verification unauthorized response has a 3xx status code

func (*RequestAddressVerificationUnauthorized) IsServerError

func (o *RequestAddressVerificationUnauthorized) IsServerError() bool

IsServerError returns true when this request address verification unauthorized response has a 5xx status code

func (*RequestAddressVerificationUnauthorized) IsSuccess

IsSuccess returns true when this request address verification unauthorized response has a 2xx status code

func (*RequestAddressVerificationUnauthorized) String

type RequestAddressVerificationUnprocessableEntity

type RequestAddressVerificationUnprocessableEntity struct {
	Payload *models.Error
}

RequestAddressVerificationUnprocessableEntity describes a response with status code 422, with default header values.

Unprocessable entity

func NewRequestAddressVerificationUnprocessableEntity

func NewRequestAddressVerificationUnprocessableEntity() *RequestAddressVerificationUnprocessableEntity

NewRequestAddressVerificationUnprocessableEntity creates a RequestAddressVerificationUnprocessableEntity with default headers values

func (*RequestAddressVerificationUnprocessableEntity) Code

Code gets the status code for the request address verification unprocessable entity response

func (*RequestAddressVerificationUnprocessableEntity) Error

func (*RequestAddressVerificationUnprocessableEntity) GetPayload

func (*RequestAddressVerificationUnprocessableEntity) IsClientError

IsClientError returns true when this request address verification unprocessable entity response has a 4xx status code

func (*RequestAddressVerificationUnprocessableEntity) IsCode

IsCode returns true when this request address verification unprocessable entity response a status code equal to that given

func (*RequestAddressVerificationUnprocessableEntity) IsRedirect

IsRedirect returns true when this request address verification unprocessable entity response has a 3xx status code

func (*RequestAddressVerificationUnprocessableEntity) IsServerError

IsServerError returns true when this request address verification unprocessable entity response has a 5xx status code

func (*RequestAddressVerificationUnprocessableEntity) IsSuccess

IsSuccess returns true when this request address verification unprocessable entity response has a 2xx status code

func (*RequestAddressVerificationUnprocessableEntity) String

type RequestOTPChallengeNoContent

type RequestOTPChallengeNoContent struct {
}

RequestOTPChallengeNoContent describes a response with status code 204, with default header values.

Request accepted

func NewRequestOTPChallengeNoContent

func NewRequestOTPChallengeNoContent() *RequestOTPChallengeNoContent

NewRequestOTPChallengeNoContent creates a RequestOTPChallengeNoContent with default headers values

func (*RequestOTPChallengeNoContent) Code

Code gets the status code for the request o t p challenge no content response

func (*RequestOTPChallengeNoContent) Error

func (*RequestOTPChallengeNoContent) IsClientError

func (o *RequestOTPChallengeNoContent) IsClientError() bool

IsClientError returns true when this request o t p challenge no content response has a 4xx status code

func (*RequestOTPChallengeNoContent) IsCode

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

IsCode returns true when this request o t p challenge no content response a status code equal to that given

func (*RequestOTPChallengeNoContent) IsRedirect

func (o *RequestOTPChallengeNoContent) IsRedirect() bool

IsRedirect returns true when this request o t p challenge no content response has a 3xx status code

func (*RequestOTPChallengeNoContent) IsServerError

func (o *RequestOTPChallengeNoContent) IsServerError() bool

IsServerError returns true when this request o t p challenge no content response has a 5xx status code

func (*RequestOTPChallengeNoContent) IsSuccess

func (o *RequestOTPChallengeNoContent) IsSuccess() bool

IsSuccess returns true when this request o t p challenge no content response has a 2xx status code

func (*RequestOTPChallengeNoContent) String

type RequestOTPChallengeNotFound

type RequestOTPChallengeNotFound struct {
	Payload *models.Error
}

RequestOTPChallengeNotFound describes a response with status code 404, with default header values.

Not found

func NewRequestOTPChallengeNotFound

func NewRequestOTPChallengeNotFound() *RequestOTPChallengeNotFound

NewRequestOTPChallengeNotFound creates a RequestOTPChallengeNotFound with default headers values

func (*RequestOTPChallengeNotFound) Code

func (o *RequestOTPChallengeNotFound) Code() int

Code gets the status code for the request o t p challenge not found response

func (*RequestOTPChallengeNotFound) Error

func (*RequestOTPChallengeNotFound) GetPayload

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

func (*RequestOTPChallengeNotFound) IsClientError

func (o *RequestOTPChallengeNotFound) IsClientError() bool

IsClientError returns true when this request o t p challenge not found response has a 4xx status code

func (*RequestOTPChallengeNotFound) IsCode

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

IsCode returns true when this request o t p challenge not found response a status code equal to that given

func (*RequestOTPChallengeNotFound) IsRedirect

func (o *RequestOTPChallengeNotFound) IsRedirect() bool

IsRedirect returns true when this request o t p challenge not found response has a 3xx status code

func (*RequestOTPChallengeNotFound) IsServerError

func (o *RequestOTPChallengeNotFound) IsServerError() bool

IsServerError returns true when this request o t p challenge not found response has a 5xx status code

func (*RequestOTPChallengeNotFound) IsSuccess

func (o *RequestOTPChallengeNotFound) IsSuccess() bool

IsSuccess returns true when this request o t p challenge not found response has a 2xx status code

func (*RequestOTPChallengeNotFound) String

func (o *RequestOTPChallengeNotFound) String() string

type RequestOTPChallengeParams

type RequestOTPChallengeParams struct {

	// RequestOTPChallenge.
	RequestOTPChallenge *models.RequestOTPChallenge

	// IPID.
	IPID string

	/* ServerID.

	     optional server's identifier (used for themes etc.)
	ServerID
	*/
	ServerID *string

	// UserID.
	UserID string

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

RequestOTPChallengeParams contains all the parameters to send to the API endpoint

for the request o t p challenge operation.

Typically these are written to a http.Request.

func NewRequestOTPChallengeParams

func NewRequestOTPChallengeParams() *RequestOTPChallengeParams

NewRequestOTPChallengeParams creates a new RequestOTPChallengeParams 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 NewRequestOTPChallengeParamsWithContext

func NewRequestOTPChallengeParamsWithContext(ctx context.Context) *RequestOTPChallengeParams

NewRequestOTPChallengeParamsWithContext creates a new RequestOTPChallengeParams object with the ability to set a context for a request.

func NewRequestOTPChallengeParamsWithHTTPClient

func NewRequestOTPChallengeParamsWithHTTPClient(client *http.Client) *RequestOTPChallengeParams

NewRequestOTPChallengeParamsWithHTTPClient creates a new RequestOTPChallengeParams object with the ability to set a custom HTTPClient for a request.

func NewRequestOTPChallengeParamsWithTimeout

func NewRequestOTPChallengeParamsWithTimeout(timeout time.Duration) *RequestOTPChallengeParams

NewRequestOTPChallengeParamsWithTimeout creates a new RequestOTPChallengeParams object with the ability to set a timeout on a request.

func (*RequestOTPChallengeParams) SetContext

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

SetContext adds the context to the request o t p challenge params

func (*RequestOTPChallengeParams) SetDefaults

func (o *RequestOTPChallengeParams) SetDefaults()

SetDefaults hydrates default values in the request o t p challenge params (not the query body).

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

func (*RequestOTPChallengeParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the request o t p challenge params

func (*RequestOTPChallengeParams) SetIPID

func (o *RequestOTPChallengeParams) SetIPID(iPID string)

SetIPID adds the ipId to the request o t p challenge params

func (*RequestOTPChallengeParams) SetRequestOTPChallenge

func (o *RequestOTPChallengeParams) SetRequestOTPChallenge(requestOTPChallenge *models.RequestOTPChallenge)

SetRequestOTPChallenge adds the requestOTPChallenge to the request o t p challenge params

func (*RequestOTPChallengeParams) SetServerID

func (o *RequestOTPChallengeParams) SetServerID(serverID *string)

SetServerID adds the serverId to the request o t p challenge params

func (*RequestOTPChallengeParams) SetTimeout

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

SetTimeout adds the timeout to the request o t p challenge params

func (*RequestOTPChallengeParams) SetUserID

func (o *RequestOTPChallengeParams) SetUserID(userID string)

SetUserID adds the userId to the request o t p challenge params

func (*RequestOTPChallengeParams) WithContext

WithContext adds the context to the request o t p challenge params

func (*RequestOTPChallengeParams) WithDefaults

WithDefaults hydrates default values in the request o t p challenge params (not the query body).

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

func (*RequestOTPChallengeParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the request o t p challenge params

func (*RequestOTPChallengeParams) WithIPID

WithIPID adds the iPID to the request o t p challenge params

func (*RequestOTPChallengeParams) WithRequestOTPChallenge

func (o *RequestOTPChallengeParams) WithRequestOTPChallenge(requestOTPChallenge *models.RequestOTPChallenge) *RequestOTPChallengeParams

WithRequestOTPChallenge adds the requestOTPChallenge to the request o t p challenge params

func (*RequestOTPChallengeParams) WithServerID

func (o *RequestOTPChallengeParams) WithServerID(serverID *string) *RequestOTPChallengeParams

WithServerID adds the serverID to the request o t p challenge params

func (*RequestOTPChallengeParams) WithTimeout

WithTimeout adds the timeout to the request o t p challenge params

func (*RequestOTPChallengeParams) WithUserID

WithUserID adds the userID to the request o t p challenge params

func (*RequestOTPChallengeParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type RequestOTPChallengePreconditionFailed

type RequestOTPChallengePreconditionFailed struct {
	Payload *models.Error
}

RequestOTPChallengePreconditionFailed describes a response with status code 412, with default header values.

Payload too large

func NewRequestOTPChallengePreconditionFailed

func NewRequestOTPChallengePreconditionFailed() *RequestOTPChallengePreconditionFailed

NewRequestOTPChallengePreconditionFailed creates a RequestOTPChallengePreconditionFailed with default headers values

func (*RequestOTPChallengePreconditionFailed) Code

Code gets the status code for the request o t p challenge precondition failed response

func (*RequestOTPChallengePreconditionFailed) Error

func (*RequestOTPChallengePreconditionFailed) GetPayload

func (*RequestOTPChallengePreconditionFailed) IsClientError

func (o *RequestOTPChallengePreconditionFailed) IsClientError() bool

IsClientError returns true when this request o t p challenge precondition failed response has a 4xx status code

func (*RequestOTPChallengePreconditionFailed) IsCode

IsCode returns true when this request o t p challenge precondition failed response a status code equal to that given

func (*RequestOTPChallengePreconditionFailed) IsRedirect

IsRedirect returns true when this request o t p challenge precondition failed response has a 3xx status code

func (*RequestOTPChallengePreconditionFailed) IsServerError

func (o *RequestOTPChallengePreconditionFailed) IsServerError() bool

IsServerError returns true when this request o t p challenge precondition failed response has a 5xx status code

func (*RequestOTPChallengePreconditionFailed) IsSuccess

IsSuccess returns true when this request o t p challenge precondition failed response has a 2xx status code

func (*RequestOTPChallengePreconditionFailed) String

type RequestOTPChallengeReader

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

RequestOTPChallengeReader is a Reader for the RequestOTPChallenge structure.

func (*RequestOTPChallengeReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type RequestOTPChallengeTooManyRequests

type RequestOTPChallengeTooManyRequests struct {
	Payload *models.Error
}

RequestOTPChallengeTooManyRequests describes a response with status code 429, with default header values.

Too many requests

func NewRequestOTPChallengeTooManyRequests

func NewRequestOTPChallengeTooManyRequests() *RequestOTPChallengeTooManyRequests

NewRequestOTPChallengeTooManyRequests creates a RequestOTPChallengeTooManyRequests with default headers values

func (*RequestOTPChallengeTooManyRequests) Code

Code gets the status code for the request o t p challenge too many requests response

func (*RequestOTPChallengeTooManyRequests) Error

func (*RequestOTPChallengeTooManyRequests) GetPayload

func (*RequestOTPChallengeTooManyRequests) IsClientError

func (o *RequestOTPChallengeTooManyRequests) IsClientError() bool

IsClientError returns true when this request o t p challenge too many requests response has a 4xx status code

func (*RequestOTPChallengeTooManyRequests) IsCode

IsCode returns true when this request o t p challenge too many requests response a status code equal to that given

func (*RequestOTPChallengeTooManyRequests) IsRedirect

func (o *RequestOTPChallengeTooManyRequests) IsRedirect() bool

IsRedirect returns true when this request o t p challenge too many requests response has a 3xx status code

func (*RequestOTPChallengeTooManyRequests) IsServerError

func (o *RequestOTPChallengeTooManyRequests) IsServerError() bool

IsServerError returns true when this request o t p challenge too many requests response has a 5xx status code

func (*RequestOTPChallengeTooManyRequests) IsSuccess

IsSuccess returns true when this request o t p challenge too many requests response has a 2xx status code

func (*RequestOTPChallengeTooManyRequests) String

type RequestOTPChallengeUnauthorized

type RequestOTPChallengeUnauthorized struct {
	Payload *models.Error
}

RequestOTPChallengeUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewRequestOTPChallengeUnauthorized

func NewRequestOTPChallengeUnauthorized() *RequestOTPChallengeUnauthorized

NewRequestOTPChallengeUnauthorized creates a RequestOTPChallengeUnauthorized with default headers values

func (*RequestOTPChallengeUnauthorized) Code

Code gets the status code for the request o t p challenge unauthorized response

func (*RequestOTPChallengeUnauthorized) Error

func (*RequestOTPChallengeUnauthorized) GetPayload

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

func (*RequestOTPChallengeUnauthorized) IsClientError

func (o *RequestOTPChallengeUnauthorized) IsClientError() bool

IsClientError returns true when this request o t p challenge unauthorized response has a 4xx status code

func (*RequestOTPChallengeUnauthorized) IsCode

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

IsCode returns true when this request o t p challenge unauthorized response a status code equal to that given

func (*RequestOTPChallengeUnauthorized) IsRedirect

func (o *RequestOTPChallengeUnauthorized) IsRedirect() bool

IsRedirect returns true when this request o t p challenge unauthorized response has a 3xx status code

func (*RequestOTPChallengeUnauthorized) IsServerError

func (o *RequestOTPChallengeUnauthorized) IsServerError() bool

IsServerError returns true when this request o t p challenge unauthorized response has a 5xx status code

func (*RequestOTPChallengeUnauthorized) IsSuccess

func (o *RequestOTPChallengeUnauthorized) IsSuccess() bool

IsSuccess returns true when this request o t p challenge unauthorized response has a 2xx status code

func (*RequestOTPChallengeUnauthorized) String

type RequestOTPChallengeUnprocessableEntity

type RequestOTPChallengeUnprocessableEntity struct {
	Payload *models.Error
}

RequestOTPChallengeUnprocessableEntity describes a response with status code 422, with default header values.

Unprocessable entity

func NewRequestOTPChallengeUnprocessableEntity

func NewRequestOTPChallengeUnprocessableEntity() *RequestOTPChallengeUnprocessableEntity

NewRequestOTPChallengeUnprocessableEntity creates a RequestOTPChallengeUnprocessableEntity with default headers values

func (*RequestOTPChallengeUnprocessableEntity) Code

Code gets the status code for the request o t p challenge unprocessable entity response

func (*RequestOTPChallengeUnprocessableEntity) Error

func (*RequestOTPChallengeUnprocessableEntity) GetPayload

func (*RequestOTPChallengeUnprocessableEntity) IsClientError

func (o *RequestOTPChallengeUnprocessableEntity) IsClientError() bool

IsClientError returns true when this request o t p challenge unprocessable entity response has a 4xx status code

func (*RequestOTPChallengeUnprocessableEntity) IsCode

IsCode returns true when this request o t p challenge unprocessable entity response a status code equal to that given

func (*RequestOTPChallengeUnprocessableEntity) IsRedirect

IsRedirect returns true when this request o t p challenge unprocessable entity response has a 3xx status code

func (*RequestOTPChallengeUnprocessableEntity) IsServerError

func (o *RequestOTPChallengeUnprocessableEntity) IsServerError() bool

IsServerError returns true when this request o t p challenge unprocessable entity response has a 5xx status code

func (*RequestOTPChallengeUnprocessableEntity) IsSuccess

IsSuccess returns true when this request o t p challenge unprocessable entity response has a 2xx status code

func (*RequestOTPChallengeUnprocessableEntity) String

type VerifyOTPOK

type VerifyOTPOK struct {
	Payload *models.UserID
}

VerifyOTPOK describes a response with status code 200, with default header values.

User

func NewVerifyOTPOK

func NewVerifyOTPOK() *VerifyOTPOK

NewVerifyOTPOK creates a VerifyOTPOK with default headers values

func (*VerifyOTPOK) Code

func (o *VerifyOTPOK) Code() int

Code gets the status code for the verify o t p o k response

func (*VerifyOTPOK) Error

func (o *VerifyOTPOK) Error() string

func (*VerifyOTPOK) GetPayload

func (o *VerifyOTPOK) GetPayload() *models.UserID

func (*VerifyOTPOK) IsClientError

func (o *VerifyOTPOK) IsClientError() bool

IsClientError returns true when this verify o t p o k response has a 4xx status code

func (*VerifyOTPOK) IsCode

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

IsCode returns true when this verify o t p o k response a status code equal to that given

func (*VerifyOTPOK) IsRedirect

func (o *VerifyOTPOK) IsRedirect() bool

IsRedirect returns true when this verify o t p o k response has a 3xx status code

func (*VerifyOTPOK) IsServerError

func (o *VerifyOTPOK) IsServerError() bool

IsServerError returns true when this verify o t p o k response has a 5xx status code

func (*VerifyOTPOK) IsSuccess

func (o *VerifyOTPOK) IsSuccess() bool

IsSuccess returns true when this verify o t p o k response has a 2xx status code

func (*VerifyOTPOK) String

func (o *VerifyOTPOK) String() string

type VerifyOTPParams

type VerifyOTPParams struct {

	// InspectOTP.
	InspectOTP *models.InspectOTP

	// IPID.
	IPID string

	// UserID.
	UserID string

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

VerifyOTPParams contains all the parameters to send to the API endpoint

for the verify o t p operation.

Typically these are written to a http.Request.

func NewVerifyOTPParams

func NewVerifyOTPParams() *VerifyOTPParams

NewVerifyOTPParams creates a new VerifyOTPParams 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 NewVerifyOTPParamsWithContext

func NewVerifyOTPParamsWithContext(ctx context.Context) *VerifyOTPParams

NewVerifyOTPParamsWithContext creates a new VerifyOTPParams object with the ability to set a context for a request.

func NewVerifyOTPParamsWithHTTPClient

func NewVerifyOTPParamsWithHTTPClient(client *http.Client) *VerifyOTPParams

NewVerifyOTPParamsWithHTTPClient creates a new VerifyOTPParams object with the ability to set a custom HTTPClient for a request.

func NewVerifyOTPParamsWithTimeout

func NewVerifyOTPParamsWithTimeout(timeout time.Duration) *VerifyOTPParams

NewVerifyOTPParamsWithTimeout creates a new VerifyOTPParams object with the ability to set a timeout on a request.

func (*VerifyOTPParams) SetContext

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

SetContext adds the context to the verify o t p params

func (*VerifyOTPParams) SetDefaults

func (o *VerifyOTPParams) SetDefaults()

SetDefaults hydrates default values in the verify o t p params (not the query body).

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

func (*VerifyOTPParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the verify o t p params

func (*VerifyOTPParams) SetIPID

func (o *VerifyOTPParams) SetIPID(iPID string)

SetIPID adds the ipId to the verify o t p params

func (*VerifyOTPParams) SetInspectOTP

func (o *VerifyOTPParams) SetInspectOTP(inspectOTP *models.InspectOTP)

SetInspectOTP adds the inspectOTP to the verify o t p params

func (*VerifyOTPParams) SetTimeout

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

SetTimeout adds the timeout to the verify o t p params

func (*VerifyOTPParams) SetUserID

func (o *VerifyOTPParams) SetUserID(userID string)

SetUserID adds the userId to the verify o t p params

func (*VerifyOTPParams) WithContext

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

WithContext adds the context to the verify o t p params

func (*VerifyOTPParams) WithDefaults

func (o *VerifyOTPParams) WithDefaults() *VerifyOTPParams

WithDefaults hydrates default values in the verify o t p params (not the query body).

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

func (*VerifyOTPParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the verify o t p params

func (*VerifyOTPParams) WithIPID

func (o *VerifyOTPParams) WithIPID(iPID string) *VerifyOTPParams

WithIPID adds the iPID to the verify o t p params

func (*VerifyOTPParams) WithInspectOTP

func (o *VerifyOTPParams) WithInspectOTP(inspectOTP *models.InspectOTP) *VerifyOTPParams

WithInspectOTP adds the inspectOTP to the verify o t p params

func (*VerifyOTPParams) WithTimeout

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

WithTimeout adds the timeout to the verify o t p params

func (*VerifyOTPParams) WithUserID

func (o *VerifyOTPParams) WithUserID(userID string) *VerifyOTPParams

WithUserID adds the userID to the verify o t p params

func (*VerifyOTPParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type VerifyOTPPreconditionFailed

type VerifyOTPPreconditionFailed struct {
	Payload *models.Error
}

VerifyOTPPreconditionFailed describes a response with status code 412, with default header values.

Payload too large

func NewVerifyOTPPreconditionFailed

func NewVerifyOTPPreconditionFailed() *VerifyOTPPreconditionFailed

NewVerifyOTPPreconditionFailed creates a VerifyOTPPreconditionFailed with default headers values

func (*VerifyOTPPreconditionFailed) Code

func (o *VerifyOTPPreconditionFailed) Code() int

Code gets the status code for the verify o t p precondition failed response

func (*VerifyOTPPreconditionFailed) Error

func (*VerifyOTPPreconditionFailed) GetPayload

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

func (*VerifyOTPPreconditionFailed) IsClientError

func (o *VerifyOTPPreconditionFailed) IsClientError() bool

IsClientError returns true when this verify o t p precondition failed response has a 4xx status code

func (*VerifyOTPPreconditionFailed) IsCode

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

IsCode returns true when this verify o t p precondition failed response a status code equal to that given

func (*VerifyOTPPreconditionFailed) IsRedirect

func (o *VerifyOTPPreconditionFailed) IsRedirect() bool

IsRedirect returns true when this verify o t p precondition failed response has a 3xx status code

func (*VerifyOTPPreconditionFailed) IsServerError

func (o *VerifyOTPPreconditionFailed) IsServerError() bool

IsServerError returns true when this verify o t p precondition failed response has a 5xx status code

func (*VerifyOTPPreconditionFailed) IsSuccess

func (o *VerifyOTPPreconditionFailed) IsSuccess() bool

IsSuccess returns true when this verify o t p precondition failed response has a 2xx status code

func (*VerifyOTPPreconditionFailed) String

func (o *VerifyOTPPreconditionFailed) String() string

type VerifyOTPReader

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

VerifyOTPReader is a Reader for the VerifyOTP structure.

func (*VerifyOTPReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type VerifyOTPUnauthorized

type VerifyOTPUnauthorized struct {
	Payload *models.Error
}

VerifyOTPUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewVerifyOTPUnauthorized

func NewVerifyOTPUnauthorized() *VerifyOTPUnauthorized

NewVerifyOTPUnauthorized creates a VerifyOTPUnauthorized with default headers values

func (*VerifyOTPUnauthorized) Code

func (o *VerifyOTPUnauthorized) Code() int

Code gets the status code for the verify o t p unauthorized response

func (*VerifyOTPUnauthorized) Error

func (o *VerifyOTPUnauthorized) Error() string

func (*VerifyOTPUnauthorized) GetPayload

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

func (*VerifyOTPUnauthorized) IsClientError

func (o *VerifyOTPUnauthorized) IsClientError() bool

IsClientError returns true when this verify o t p unauthorized response has a 4xx status code

func (*VerifyOTPUnauthorized) IsCode

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

IsCode returns true when this verify o t p unauthorized response a status code equal to that given

func (*VerifyOTPUnauthorized) IsRedirect

func (o *VerifyOTPUnauthorized) IsRedirect() bool

IsRedirect returns true when this verify o t p unauthorized response has a 3xx status code

func (*VerifyOTPUnauthorized) IsServerError

func (o *VerifyOTPUnauthorized) IsServerError() bool

IsServerError returns true when this verify o t p unauthorized response has a 5xx status code

func (*VerifyOTPUnauthorized) IsSuccess

func (o *VerifyOTPUnauthorized) IsSuccess() bool

IsSuccess returns true when this verify o t p unauthorized response has a 2xx status code

func (*VerifyOTPUnauthorized) String

func (o *VerifyOTPUnauthorized) String() string

type VerifyOTPUnprocessableEntity

type VerifyOTPUnprocessableEntity struct {
	Payload *models.Error
}

VerifyOTPUnprocessableEntity describes a response with status code 422, with default header values.

Unprocessable entity

func NewVerifyOTPUnprocessableEntity

func NewVerifyOTPUnprocessableEntity() *VerifyOTPUnprocessableEntity

NewVerifyOTPUnprocessableEntity creates a VerifyOTPUnprocessableEntity with default headers values

func (*VerifyOTPUnprocessableEntity) Code

Code gets the status code for the verify o t p unprocessable entity response

func (*VerifyOTPUnprocessableEntity) Error

func (*VerifyOTPUnprocessableEntity) GetPayload

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

func (*VerifyOTPUnprocessableEntity) IsClientError

func (o *VerifyOTPUnprocessableEntity) IsClientError() bool

IsClientError returns true when this verify o t p unprocessable entity response has a 4xx status code

func (*VerifyOTPUnprocessableEntity) IsCode

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

IsCode returns true when this verify o t p unprocessable entity response a status code equal to that given

func (*VerifyOTPUnprocessableEntity) IsRedirect

func (o *VerifyOTPUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this verify o t p unprocessable entity response has a 3xx status code

func (*VerifyOTPUnprocessableEntity) IsServerError

func (o *VerifyOTPUnprocessableEntity) IsServerError() bool

IsServerError returns true when this verify o t p unprocessable entity response has a 5xx status code

func (*VerifyOTPUnprocessableEntity) IsSuccess

func (o *VerifyOTPUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this verify o t p unprocessable entity response has a 2xx status code

func (*VerifyOTPUnprocessableEntity) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL