system

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

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) SystemGenerateCode 

func (a *Client) SystemGenerateCode(params *SystemGenerateCodeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SystemGenerateCodeCreated, error)
SystemGenerateCode generates code of a specific type

Generate code of a specific type for provided address

Invalidates previously generated OTPs for action associated with the type. Code is valid for specific period of time configured in Identity Pool.

Keep in mind that `address` attribute for different code types does not mean the same: for `reset_password`, `authentication` and `challenge` it must be user's address (verified or unverified) for `activation` it is not mandatory (system will pick up address itself if there is only one in user entry) but if provided it must be one of the user's addresses (can be not verified) for `verify_address` it must be user's unverified address and that address cannot be someone's else verified address

For `activation`, `reset_password` and `challenge` there is only one active code for a user (generating new one invalidates previous) For `verify_address` there might be many codes for a user. During verification latest for an address is being compared.

REFACTORED: input field name has been changed from `identifier` to `address`; field `identifier` stays for backward compatibility and overrides `address` if not empty

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	SystemGenerateCode(params *SystemGenerateCodeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SystemGenerateCodeCreated, 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 system API client.

type SystemGenerateCodeBadRequest 

type SystemGenerateCodeBadRequest struct {
	Payload *models.Error
}

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

Bad request

func NewSystemGenerateCodeBadRequest 

func NewSystemGenerateCodeBadRequest() *SystemGenerateCodeBadRequest

NewSystemGenerateCodeBadRequest creates a SystemGenerateCodeBadRequest with default headers values

func (*SystemGenerateCodeBadRequest) Code 

func (o *SystemGenerateCodeBadRequest) Code() int

Code gets the status code for the system generate code bad request response

func (*SystemGenerateCodeBadRequest) Error 

func (o *SystemGenerateCodeBadRequest) Error() string

func (*SystemGenerateCodeBadRequest) GetPayload 

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

func (*SystemGenerateCodeBadRequest) IsClientError 

func (o *SystemGenerateCodeBadRequest) IsClientError() bool

IsClientError returns true when this system generate code bad request response has a 4xx status code

func (*SystemGenerateCodeBadRequest) IsCode 

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

IsCode returns true when this system generate code bad request response a status code equal to that given

func (*SystemGenerateCodeBadRequest) IsRedirect 

func (o *SystemGenerateCodeBadRequest) IsRedirect() bool

IsRedirect returns true when this system generate code bad request response has a 3xx status code

func (*SystemGenerateCodeBadRequest) IsServerError 

func (o *SystemGenerateCodeBadRequest) IsServerError() bool

IsServerError returns true when this system generate code bad request response has a 5xx status code

func (*SystemGenerateCodeBadRequest) IsSuccess 

func (o *SystemGenerateCodeBadRequest) IsSuccess() bool

IsSuccess returns true when this system generate code bad request response has a 2xx status code

func (*SystemGenerateCodeBadRequest) String 

func (o *SystemGenerateCodeBadRequest) String() string

type SystemGenerateCodeCreated 

type SystemGenerateCodeCreated struct {
	Payload *models.Codes
}

SystemGenerateCodeCreated describes a response with status code 201, with default header values.

Code

func NewSystemGenerateCodeCreated 

func NewSystemGenerateCodeCreated() *SystemGenerateCodeCreated

NewSystemGenerateCodeCreated creates a SystemGenerateCodeCreated with default headers values

func (*SystemGenerateCodeCreated) Code 

func (o *SystemGenerateCodeCreated) Code() int

Code gets the status code for the system generate code created response

func (*SystemGenerateCodeCreated) Error 

func (o *SystemGenerateCodeCreated) Error() string

func (*SystemGenerateCodeCreated) GetPayload 

func (o *SystemGenerateCodeCreated) GetPayload() *models.Codes

func (*SystemGenerateCodeCreated) IsClientError 

func (o *SystemGenerateCodeCreated) IsClientError() bool

IsClientError returns true when this system generate code created response has a 4xx status code

func (*SystemGenerateCodeCreated) IsCode 

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

IsCode returns true when this system generate code created response a status code equal to that given

func (*SystemGenerateCodeCreated) IsRedirect 

func (o *SystemGenerateCodeCreated) IsRedirect() bool

IsRedirect returns true when this system generate code created response has a 3xx status code

func (*SystemGenerateCodeCreated) IsServerError 

func (o *SystemGenerateCodeCreated) IsServerError() bool

IsServerError returns true when this system generate code created response has a 5xx status code

func (*SystemGenerateCodeCreated) IsSuccess 

func (o *SystemGenerateCodeCreated) IsSuccess() bool

IsSuccess returns true when this system generate code created response has a 2xx status code

func (*SystemGenerateCodeCreated) String 

func (o *SystemGenerateCodeCreated) String() string

type SystemGenerateCodeNotFound 

type SystemGenerateCodeNotFound struct {
	Payload *models.Error
}

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

Not found

func NewSystemGenerateCodeNotFound 

func NewSystemGenerateCodeNotFound() *SystemGenerateCodeNotFound

NewSystemGenerateCodeNotFound creates a SystemGenerateCodeNotFound with default headers values

func (*SystemGenerateCodeNotFound) Code 

func (o *SystemGenerateCodeNotFound) Code() int

Code gets the status code for the system generate code not found response

func (*SystemGenerateCodeNotFound) Error 

func (o *SystemGenerateCodeNotFound) Error() string

func (*SystemGenerateCodeNotFound) GetPayload 

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

func (*SystemGenerateCodeNotFound) IsClientError 

func (o *SystemGenerateCodeNotFound) IsClientError() bool

IsClientError returns true when this system generate code not found response has a 4xx status code

func (*SystemGenerateCodeNotFound) IsCode 

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

IsCode returns true when this system generate code not found response a status code equal to that given

func (*SystemGenerateCodeNotFound) IsRedirect 

func (o *SystemGenerateCodeNotFound) IsRedirect() bool

IsRedirect returns true when this system generate code not found response has a 3xx status code

func (*SystemGenerateCodeNotFound) IsServerError 

func (o *SystemGenerateCodeNotFound) IsServerError() bool

IsServerError returns true when this system generate code not found response has a 5xx status code

func (*SystemGenerateCodeNotFound) IsSuccess 

func (o *SystemGenerateCodeNotFound) IsSuccess() bool

IsSuccess returns true when this system generate code not found response has a 2xx status code

func (*SystemGenerateCodeNotFound) String 

func (o *SystemGenerateCodeNotFound) String() string

type SystemGenerateCodeParams 

type SystemGenerateCodeParams struct {

	// CodeRequest.
	CodeRequest *models.RequestCode

	// IPID.
	IPID *string

	// TenantID.
	TenantID *string

	// UserID.
	UserID *string

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

SystemGenerateCodeParams contains all the parameters to send to the API endpoint 

for the system generate code operation.

Typically these are written to a http.Request.

func NewSystemGenerateCodeParams 

func NewSystemGenerateCodeParams() *SystemGenerateCodeParams

NewSystemGenerateCodeParams creates a new SystemGenerateCodeParams 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 NewSystemGenerateCodeParamsWithContext 

func NewSystemGenerateCodeParamsWithContext(ctx context.Context) *SystemGenerateCodeParams

NewSystemGenerateCodeParamsWithContext creates a new SystemGenerateCodeParams object with the ability to set a context for a request.

func NewSystemGenerateCodeParamsWithHTTPClient 

func NewSystemGenerateCodeParamsWithHTTPClient(client *http.Client) *SystemGenerateCodeParams

NewSystemGenerateCodeParamsWithHTTPClient creates a new SystemGenerateCodeParams object with the ability to set a custom HTTPClient for a request.

func NewSystemGenerateCodeParamsWithTimeout 

func NewSystemGenerateCodeParamsWithTimeout(timeout time.Duration) *SystemGenerateCodeParams

NewSystemGenerateCodeParamsWithTimeout creates a new SystemGenerateCodeParams object with the ability to set a timeout on a request.

func (*SystemGenerateCodeParams) SetCodeRequest 

func (o *SystemGenerateCodeParams) SetCodeRequest(codeRequest *models.RequestCode)

SetCodeRequest adds the codeRequest to the system generate code params

func (*SystemGenerateCodeParams) SetContext 

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

SetContext adds the context to the system generate code params

func (*SystemGenerateCodeParams) SetDefaults 

func (o *SystemGenerateCodeParams) SetDefaults()

SetDefaults hydrates default values in the system generate code params (not the query body).

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

func (*SystemGenerateCodeParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the system generate code params

func (*SystemGenerateCodeParams) SetIPID 

func (o *SystemGenerateCodeParams) SetIPID(iPID *string)

SetIPID adds the ipId to the system generate code params

func (*SystemGenerateCodeParams) SetTenantID 

func (o *SystemGenerateCodeParams) SetTenantID(tenantID *string)

SetTenantID adds the tenantId to the system generate code params

func (*SystemGenerateCodeParams) SetTimeout 

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

SetTimeout adds the timeout to the system generate code params

func (*SystemGenerateCodeParams) SetUserID 

func (o *SystemGenerateCodeParams) SetUserID(userID *string)

SetUserID adds the userId to the system generate code params

func (*SystemGenerateCodeParams) WithCodeRequest 

func (o *SystemGenerateCodeParams) WithCodeRequest(codeRequest *models.RequestCode) *SystemGenerateCodeParams

WithCodeRequest adds the codeRequest to the system generate code params

func (*SystemGenerateCodeParams) WithContext 

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

WithContext adds the context to the system generate code params

func (*SystemGenerateCodeParams) WithDefaults 

func (o *SystemGenerateCodeParams) WithDefaults() *SystemGenerateCodeParams

WithDefaults hydrates default values in the system generate code params (not the query body).

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

func (*SystemGenerateCodeParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the system generate code params

func (*SystemGenerateCodeParams) WithIPID 

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

WithIPID adds the iPID to the system generate code params

func (*SystemGenerateCodeParams) WithTenantID 

func (o *SystemGenerateCodeParams) WithTenantID(tenantID *string) *SystemGenerateCodeParams

WithTenantID adds the tenantID to the system generate code params

func (*SystemGenerateCodeParams) WithTimeout 

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

WithTimeout adds the timeout to the system generate code params

func (*SystemGenerateCodeParams) WithUserID 

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

WithUserID adds the userID to the system generate code params

func (*SystemGenerateCodeParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type SystemGenerateCodeReader 

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

SystemGenerateCodeReader is a Reader for the SystemGenerateCode structure.

func (*SystemGenerateCodeReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type SystemGenerateCodeTooManyRequests 

type SystemGenerateCodeTooManyRequests struct {
	Payload *models.Error
}

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

Too many requests

func NewSystemGenerateCodeTooManyRequests 

func NewSystemGenerateCodeTooManyRequests() *SystemGenerateCodeTooManyRequests

NewSystemGenerateCodeTooManyRequests creates a SystemGenerateCodeTooManyRequests with default headers values

func (*SystemGenerateCodeTooManyRequests) Code 

func (o *SystemGenerateCodeTooManyRequests) Code() int

Code gets the status code for the system generate code too many requests response

func (*SystemGenerateCodeTooManyRequests) Error 

func (o *SystemGenerateCodeTooManyRequests) Error() string

func (*SystemGenerateCodeTooManyRequests) GetPayload 

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

func (*SystemGenerateCodeTooManyRequests) IsClientError 

func (o *SystemGenerateCodeTooManyRequests) IsClientError() bool

IsClientError returns true when this system generate code too many requests response has a 4xx status code

func (*SystemGenerateCodeTooManyRequests) IsCode 

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

IsCode returns true when this system generate code too many requests response a status code equal to that given

func (*SystemGenerateCodeTooManyRequests) IsRedirect 

func (o *SystemGenerateCodeTooManyRequests) IsRedirect() bool

IsRedirect returns true when this system generate code too many requests response has a 3xx status code

func (*SystemGenerateCodeTooManyRequests) IsServerError 

func (o *SystemGenerateCodeTooManyRequests) IsServerError() bool

IsServerError returns true when this system generate code too many requests response has a 5xx status code

func (*SystemGenerateCodeTooManyRequests) IsSuccess 

func (o *SystemGenerateCodeTooManyRequests) IsSuccess() bool

IsSuccess returns true when this system generate code too many requests response has a 2xx status code

func (*SystemGenerateCodeTooManyRequests) String 

func (o *SystemGenerateCodeTooManyRequests) String() string

type SystemGenerateCodeUnauthorized 

type SystemGenerateCodeUnauthorized struct {
	Payload *models.Error
}

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

Unauthorized

func NewSystemGenerateCodeUnauthorized 

func NewSystemGenerateCodeUnauthorized() *SystemGenerateCodeUnauthorized

NewSystemGenerateCodeUnauthorized creates a SystemGenerateCodeUnauthorized with default headers values

func (*SystemGenerateCodeUnauthorized) Code 

func (o *SystemGenerateCodeUnauthorized) Code() int

Code gets the status code for the system generate code unauthorized response

func (*SystemGenerateCodeUnauthorized) Error 

func (o *SystemGenerateCodeUnauthorized) Error() string

func (*SystemGenerateCodeUnauthorized) GetPayload 

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

func (*SystemGenerateCodeUnauthorized) IsClientError 

func (o *SystemGenerateCodeUnauthorized) IsClientError() bool

IsClientError returns true when this system generate code unauthorized response has a 4xx status code

func (*SystemGenerateCodeUnauthorized) IsCode 

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

IsCode returns true when this system generate code unauthorized response a status code equal to that given

func (*SystemGenerateCodeUnauthorized) IsRedirect 

func (o *SystemGenerateCodeUnauthorized) IsRedirect() bool

IsRedirect returns true when this system generate code unauthorized response has a 3xx status code

func (*SystemGenerateCodeUnauthorized) IsServerError 

func (o *SystemGenerateCodeUnauthorized) IsServerError() bool

IsServerError returns true when this system generate code unauthorized response has a 5xx status code

func (*SystemGenerateCodeUnauthorized) IsSuccess 

func (o *SystemGenerateCodeUnauthorized) IsSuccess() bool

IsSuccess returns true when this system generate code unauthorized response has a 2xx status code

func (*SystemGenerateCodeUnauthorized) String 

func (o *SystemGenerateCodeUnauthorized) String() string

type SystemGenerateCodeUnprocessableEntity 

type SystemGenerateCodeUnprocessableEntity struct {
	Payload *models.Error
}

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

Unprocessable entity

func NewSystemGenerateCodeUnprocessableEntity 

func NewSystemGenerateCodeUnprocessableEntity() *SystemGenerateCodeUnprocessableEntity

NewSystemGenerateCodeUnprocessableEntity creates a SystemGenerateCodeUnprocessableEntity with default headers values

func (*SystemGenerateCodeUnprocessableEntity) Code 

func (o *SystemGenerateCodeUnprocessableEntity) Code() int

Code gets the status code for the system generate code unprocessable entity response

func (*SystemGenerateCodeUnprocessableEntity) Error 

func (o *SystemGenerateCodeUnprocessableEntity) Error() string

func (*SystemGenerateCodeUnprocessableEntity) GetPayload 

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

func (*SystemGenerateCodeUnprocessableEntity) IsClientError 

func (o *SystemGenerateCodeUnprocessableEntity) IsClientError() bool

IsClientError returns true when this system generate code unprocessable entity response has a 4xx status code

func (*SystemGenerateCodeUnprocessableEntity) IsCode 

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

IsCode returns true when this system generate code unprocessable entity response a status code equal to that given

func (*SystemGenerateCodeUnprocessableEntity) IsRedirect 

func (o *SystemGenerateCodeUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this system generate code unprocessable entity response has a 3xx status code

func (*SystemGenerateCodeUnprocessableEntity) IsServerError 

func (o *SystemGenerateCodeUnprocessableEntity) IsServerError() bool

IsServerError returns true when this system generate code unprocessable entity response has a 5xx status code

func (*SystemGenerateCodeUnprocessableEntity) IsSuccess 

func (o *SystemGenerateCodeUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this system generate code unprocessable entity response has a 2xx status code

func (*SystemGenerateCodeUnprocessableEntity) String 

func (o *SystemGenerateCodeUnprocessableEntity) String() string

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.