o_auth2_0

package
v0.59.0 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2023 License: MIT Imports: 16 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	AuthorizeV3S256Constant  = "S256"
	AuthorizeV3PlainConstant = "plain"
)

Get the enum in AuthorizeV3Params

View Source 
const (
	TokenGrantV3AuthorizationCodeConstant                                  = "authorization_code"
	TokenGrantV3ClientCredentialsConstant                                  = "client_credentials"
	TokenGrantV3PasswordConstant                                           = "password"
	TokenGrantV3RefreshTokenConstant                                       = "refresh_token"
	TokenGrantV3UrnIetfParamsOauthGrantTypeExtendClientCredentialsConstant = "urn:ietf:params:oauth:grant-type:extend_client_credentials"
)

Get the enum in TokenGrantV3Params

View Source 
const (
	AuthorizeV3CodeConstant = "code"
)

Get the enum in AuthorizeV3Params

Variables

This section is empty.

Functions

This section is empty.

Types

type AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden added in v0.8.0 

type AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden handles this case with default header values. 

Unauthorized access

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Forbidden added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Forbidden() *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden

NewAdminRetrieveUserThirdPartyPlatformTokenV3Forbidden creates a AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden with default headers values

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) Error added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) Error() string

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) GetPayload added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) ToJSONString added in v0.25.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden) ToJSONString() string

type AdminRetrieveUserThirdPartyPlatformTokenV3NotFound added in v0.8.0 

type AdminRetrieveUserThirdPartyPlatformTokenV3NotFound struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

AdminRetrieveUserThirdPartyPlatformTokenV3NotFound handles this case with default header values. 

Platform Token Not Found

func NewAdminRetrieveUserThirdPartyPlatformTokenV3NotFound added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3NotFound() *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound

NewAdminRetrieveUserThirdPartyPlatformTokenV3NotFound creates a AdminRetrieveUserThirdPartyPlatformTokenV3NotFound with default headers values

func (*AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) Error added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) Error() string

func (*AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) GetPayload added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) ToJSONString added in v0.25.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound) ToJSONString() string

type AdminRetrieveUserThirdPartyPlatformTokenV3OK added in v0.8.0 

type AdminRetrieveUserThirdPartyPlatformTokenV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenThirdPartyResponse
}

AdminRetrieveUserThirdPartyPlatformTokenV3OK handles this case with default header values. 

Token returned

func NewAdminRetrieveUserThirdPartyPlatformTokenV3OK added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3OK() *AdminRetrieveUserThirdPartyPlatformTokenV3OK

NewAdminRetrieveUserThirdPartyPlatformTokenV3OK creates a AdminRetrieveUserThirdPartyPlatformTokenV3OK with default headers values

func (*AdminRetrieveUserThirdPartyPlatformTokenV3OK) Error added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3OK) Error() string

func (*AdminRetrieveUserThirdPartyPlatformTokenV3OK) GetPayload added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3OK) GetPayload() *iamclientmodels.OauthmodelTokenThirdPartyResponse

func (*AdminRetrieveUserThirdPartyPlatformTokenV3OK) ToJSONString added in v0.25.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3OK) ToJSONString() string

type AdminRetrieveUserThirdPartyPlatformTokenV3Params added in v0.8.0 

type AdminRetrieveUserThirdPartyPlatformTokenV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  Namespace, only accept alphabet and numeric

	*/
	Namespace string
	/*PlatformID
	  Platform ID

	*/
	PlatformID string
	/*UserID
	  UserId

	*/
	UserID string

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

AdminRetrieveUserThirdPartyPlatformTokenV3Params contains all the parameters to send to the API endpoint for the admin retrieve user third party platform token v3 operation typically these are written to a http.Request

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Params added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Params() *AdminRetrieveUserThirdPartyPlatformTokenV3Params

NewAdminRetrieveUserThirdPartyPlatformTokenV3Params creates a new AdminRetrieveUserThirdPartyPlatformTokenV3Params object with the default values initialized.

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithContext added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithContext(ctx context.Context) *AdminRetrieveUserThirdPartyPlatformTokenV3Params

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

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithHTTPClient added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithHTTPClient(client *http.Client) *AdminRetrieveUserThirdPartyPlatformTokenV3Params

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

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithTimeout added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3ParamsWithTimeout(timeout time.Duration) *AdminRetrieveUserThirdPartyPlatformTokenV3Params

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

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetContext added in v0.8.0 

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

SetContext adds the context to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClient added in v0.8.0 

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

SetHTTPClient adds the HTTPClient to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetNamespace added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetNamespace(namespace string)

SetNamespace adds the namespace to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetPlatformID added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetTimeout added in v0.8.0 

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

SetTimeout adds the timeout to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetUserID added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) SetUserID(userID string)

SetUserID adds the userId to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithContext added in v0.8.0 

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

WithContext adds the context to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithHTTPClient added in v0.8.0 

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

WithHTTPClient adds the HTTPClient to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithNamespace added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithNamespace(namespace string) *AdminRetrieveUserThirdPartyPlatformTokenV3Params

WithNamespace adds the namespace to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithPlatformID added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithPlatformID(platformID string) *AdminRetrieveUserThirdPartyPlatformTokenV3Params

WithPlatformID adds the platformID to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithTimeout added in v0.8.0 

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

WithTimeout adds the timeout to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WithUserID added in v0.8.0 

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

WithUserID adds the userID to the admin retrieve user third party platform token v3 params

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Params) WriteToRequest added in v0.8.0 

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

WriteToRequest writes these params to a swagger request

type AdminRetrieveUserThirdPartyPlatformTokenV3Reader added in v0.8.0 

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

AdminRetrieveUserThirdPartyPlatformTokenV3Reader is a Reader for the AdminRetrieveUserThirdPartyPlatformTokenV3 structure.

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Reader) ReadResponse added in v0.8.0 

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

ReadResponse reads a server response into the received o.

type AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized added in v0.8.0 

type AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized handles this case with default header values. 

Client authentication failed

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized added in v0.8.0 

func NewAdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized() *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized

NewAdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized creates a AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized with default headers values

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) Error added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) Error() string

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) GetPayload added in v0.8.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) ToJSONString added in v0.25.0 

func (o *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized) ToJSONString() string

type AuthCodeRequestV3Found added in v0.2.0 

type AuthCodeRequestV3Found struct {
	Location string
}

AuthCodeRequestV3Found handles this case with default header values. 

Found. Redirect to client’s redirect URI with either code or error on the query parameter

func NewAuthCodeRequestV3Found added in v0.2.0 

func NewAuthCodeRequestV3Found() *AuthCodeRequestV3Found

NewAuthCodeRequestV3Found creates a AuthCodeRequestV3Found with default headers values

func (*AuthCodeRequestV3Found) Error added in v0.2.0 

func (o *AuthCodeRequestV3Found) Error() string

type AuthCodeRequestV3Params added in v0.2.0 

type AuthCodeRequestV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*PlatformID
	  Platform ID

	*/
	PlatformID string
	/*ClientID
	  Client ID

	*/
	ClientID *string
	/*RedirectURI
	  Redirect URI

	*/
	RedirectURI *string
	/*RequestID
	  Request ID retrieved from authorize endpoint ([GET] iam/v3/oauth/authorize)

	*/
	RequestID string

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

AuthCodeRequestV3Params contains all the parameters to send to the API endpoint for the auth code request v3 operation typically these are written to a http.Request

func NewAuthCodeRequestV3Params added in v0.2.0 

func NewAuthCodeRequestV3Params() *AuthCodeRequestV3Params

NewAuthCodeRequestV3Params creates a new AuthCodeRequestV3Params object with the default values initialized.

func NewAuthCodeRequestV3ParamsWithContext added in v0.2.0 

func NewAuthCodeRequestV3ParamsWithContext(ctx context.Context) *AuthCodeRequestV3Params

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

func NewAuthCodeRequestV3ParamsWithHTTPClient added in v0.2.0 

func NewAuthCodeRequestV3ParamsWithHTTPClient(client *http.Client) *AuthCodeRequestV3Params

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

func NewAuthCodeRequestV3ParamsWithTimeout added in v0.2.0 

func NewAuthCodeRequestV3ParamsWithTimeout(timeout time.Duration) *AuthCodeRequestV3Params

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

func (*AuthCodeRequestV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *AuthCodeRequestV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetClientID added in v0.2.0 

func (o *AuthCodeRequestV3Params) SetClientID(clientID *string)

SetClientID adds the clientId to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *AuthCodeRequestV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetPlatformID added in v0.2.0 

func (o *AuthCodeRequestV3Params) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetRedirectURI added in v0.2.0 

func (o *AuthCodeRequestV3Params) SetRedirectURI(redirectURI *string)

SetRedirectURI adds the redirectUri to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetRequestID added in v0.2.0 

func (o *AuthCodeRequestV3Params) SetRequestID(requestID string)

SetRequestID adds the requestId to the auth code request v3 params

func (*AuthCodeRequestV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithClientID added in v0.2.0 

func (o *AuthCodeRequestV3Params) WithClientID(clientID *string) *AuthCodeRequestV3Params

WithClientID adds the clientID to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithPlatformID added in v0.2.0 

func (o *AuthCodeRequestV3Params) WithPlatformID(platformID string) *AuthCodeRequestV3Params

WithPlatformID adds the platformID to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithRedirectURI added in v0.2.0 

func (o *AuthCodeRequestV3Params) WithRedirectURI(redirectURI *string) *AuthCodeRequestV3Params

WithRedirectURI adds the redirectURI to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithRequestID added in v0.2.0 

func (o *AuthCodeRequestV3Params) WithRequestID(requestID string) *AuthCodeRequestV3Params

WithRequestID adds the requestID to the auth code request v3 params

func (*AuthCodeRequestV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the auth code request v3 params

func (*AuthCodeRequestV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type AuthCodeRequestV3Reader added in v0.2.0 

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

AuthCodeRequestV3Reader is a Reader for the AuthCodeRequestV3 structure.

func (*AuthCodeRequestV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type AuthorizeV3Found 

type AuthorizeV3Found struct {
	Location string
}

AuthorizeV3Found handles this case with default header values. 

Found. Redirected to login page with either request_id or error.

func NewAuthorizeV3Found 

func NewAuthorizeV3Found() *AuthorizeV3Found

NewAuthorizeV3Found creates a AuthorizeV3Found with default headers values

func (*AuthorizeV3Found) Error 

func (o *AuthorizeV3Found) Error() string

type AuthorizeV3Params 

type AuthorizeV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*CodeChallenge
	  Value generated by transforming code verifier using code challenge method. Mandatory for public client.

	*/
	CodeChallenge *string
	/*CodeChallengeMethod
	  Method that is used to transform code verifier to code challenge

	*/
	CodeChallengeMethod *string
	/*CreateHeadless
	  If create new headless account when login by new third platform user

	*/
	CreateHeadless *bool
	/*OneTimeLinkCode
	  One time link code for headless account to link. Can get from [/iam/v3/link/code/request]

	*/
	OneTimeLinkCode *string
	/*RedirectURI
	  Redirect URI registered for requesting client. Required if client registered with multiple redirect URI. Registered redirect uri will be assigned if left empty.

	*/
	RedirectURI *string
	/*Scope
	  Defines the requested access request scope. Can be multiple values delimited by whitespace.

	*/
	Scope *string
	/*State
	  Random value for preventing cross-site request forgery used by client.

	*/
	State *string
	/*TargetAuthPage
	  Custom query to tell authorization web which page to present to user

	*/
	TargetAuthPage *string
	/*UseRedirectURIAsLoginURLWhenLocked
	  Use Redirect URI as the Login URL after resetting password when got locked

	*/
	UseRedirectURIAsLoginURLWhenLocked *bool
	/*ClientID
	  Registered client ID

	*/
	ClientID string
	/*ResponseType
	  Supported response type : 'code'

	*/
	ResponseType string

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

AuthorizeV3Params contains all the parameters to send to the API endpoint for the authorize v3 operation typically these are written to a http.Request

func NewAuthorizeV3Params 

func NewAuthorizeV3Params() *AuthorizeV3Params

NewAuthorizeV3Params creates a new AuthorizeV3Params object with the default values initialized.

func NewAuthorizeV3ParamsWithContext 

func NewAuthorizeV3ParamsWithContext(ctx context.Context) *AuthorizeV3Params

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

func NewAuthorizeV3ParamsWithHTTPClient 

func NewAuthorizeV3ParamsWithHTTPClient(client *http.Client) *AuthorizeV3Params

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

func NewAuthorizeV3ParamsWithTimeout 

func NewAuthorizeV3ParamsWithTimeout(timeout time.Duration) *AuthorizeV3Params

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

func (*AuthorizeV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *AuthorizeV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the authorize v3 params

func (*AuthorizeV3Params) SetClientID 

func (o *AuthorizeV3Params) SetClientID(clientID string)

SetClientID adds the clientId to the authorize v3 params

func (*AuthorizeV3Params) SetCodeChallenge 

func (o *AuthorizeV3Params) SetCodeChallenge(codeChallenge *string)

SetCodeChallenge adds the codeChallenge to the authorize v3 params

func (*AuthorizeV3Params) SetCodeChallengeMethod 

func (o *AuthorizeV3Params) SetCodeChallengeMethod(codeChallengeMethod *string)

SetCodeChallengeMethod adds the codeChallengeMethod to the authorize v3 params

func (*AuthorizeV3Params) SetContext 

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

SetContext adds the context to the authorize v3 params

func (*AuthorizeV3Params) SetCreateHeadless added in v0.20.0 

func (o *AuthorizeV3Params) SetCreateHeadless(createHeadless *bool)

SetCreateHeadless adds the createHeadless to the authorize v3 params

func (*AuthorizeV3Params) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the authorize v3 params

func (*AuthorizeV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *AuthorizeV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the authorize v3 params

func (*AuthorizeV3Params) SetOneTimeLinkCode added in v0.34.0 

func (o *AuthorizeV3Params) SetOneTimeLinkCode(oneTimeLinkCode *string)

SetOneTimeLinkCode adds the oneTimeLinkCode to the authorize v3 params

func (*AuthorizeV3Params) SetRedirectURI 

func (o *AuthorizeV3Params) SetRedirectURI(redirectURI *string)

SetRedirectURI adds the redirectUri to the authorize v3 params

func (*AuthorizeV3Params) SetResponseType 

func (o *AuthorizeV3Params) SetResponseType(responseType string)

SetResponseType adds the responseType to the authorize v3 params

func (*AuthorizeV3Params) SetScope 

func (o *AuthorizeV3Params) SetScope(scope *string)

SetScope adds the scope to the authorize v3 params

func (*AuthorizeV3Params) SetState 

func (o *AuthorizeV3Params) SetState(state *string)

SetState adds the state to the authorize v3 params

func (*AuthorizeV3Params) SetTargetAuthPage 

func (o *AuthorizeV3Params) SetTargetAuthPage(targetAuthPage *string)

SetTargetAuthPage adds the targetAuthPage to the authorize v3 params

func (*AuthorizeV3Params) SetTimeout 

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

SetTimeout adds the timeout to the authorize v3 params

func (*AuthorizeV3Params) SetUseRedirectURIAsLoginURLWhenLocked added in v0.31.0 

func (o *AuthorizeV3Params) SetUseRedirectURIAsLoginURLWhenLocked(useRedirectURIAsLoginURLWhenLocked *bool)

SetUseRedirectURIAsLoginURLWhenLocked adds the useRedirectUriAsLoginUrlWhenLocked to the authorize v3 params

func (*AuthorizeV3Params) WithClientID 

func (o *AuthorizeV3Params) WithClientID(clientID string) *AuthorizeV3Params

WithClientID adds the clientID to the authorize v3 params

func (*AuthorizeV3Params) WithCodeChallenge 

func (o *AuthorizeV3Params) WithCodeChallenge(codeChallenge *string) *AuthorizeV3Params

WithCodeChallenge adds the codeChallenge to the authorize v3 params

func (*AuthorizeV3Params) WithCodeChallengeMethod 

func (o *AuthorizeV3Params) WithCodeChallengeMethod(codeChallengeMethod *string) *AuthorizeV3Params

WithCodeChallengeMethod adds the codeChallengeMethod to the authorize v3 params

func (*AuthorizeV3Params) WithContext 

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

WithContext adds the context to the authorize v3 params

func (*AuthorizeV3Params) WithCreateHeadless added in v0.20.0 

func (o *AuthorizeV3Params) WithCreateHeadless(createHeadless *bool) *AuthorizeV3Params

WithCreateHeadless adds the createHeadless to the authorize v3 params

func (*AuthorizeV3Params) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the authorize v3 params

func (*AuthorizeV3Params) WithOneTimeLinkCode added in v0.34.0 

func (o *AuthorizeV3Params) WithOneTimeLinkCode(oneTimeLinkCode *string) *AuthorizeV3Params

WithOneTimeLinkCode adds the oneTimeLinkCode to the authorize v3 params

func (*AuthorizeV3Params) WithRedirectURI 

func (o *AuthorizeV3Params) WithRedirectURI(redirectURI *string) *AuthorizeV3Params

WithRedirectURI adds the redirectURI to the authorize v3 params

func (*AuthorizeV3Params) WithResponseType 

func (o *AuthorizeV3Params) WithResponseType(responseType string) *AuthorizeV3Params

WithResponseType adds the responseType to the authorize v3 params

func (*AuthorizeV3Params) WithScope 

func (o *AuthorizeV3Params) WithScope(scope *string) *AuthorizeV3Params

WithScope adds the scope to the authorize v3 params

func (*AuthorizeV3Params) WithState 

func (o *AuthorizeV3Params) WithState(state *string) *AuthorizeV3Params

WithState adds the state to the authorize v3 params

func (*AuthorizeV3Params) WithTargetAuthPage 

func (o *AuthorizeV3Params) WithTargetAuthPage(targetAuthPage *string) *AuthorizeV3Params

WithTargetAuthPage adds the targetAuthPage to the authorize v3 params

func (*AuthorizeV3Params) WithTimeout 

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

WithTimeout adds the timeout to the authorize v3 params

func (*AuthorizeV3Params) WithUseRedirectURIAsLoginURLWhenLocked added in v0.31.0 

func (o *AuthorizeV3Params) WithUseRedirectURIAsLoginURLWhenLocked(useRedirectURIAsLoginURLWhenLocked *bool) *AuthorizeV3Params

WithUseRedirectURIAsLoginURLWhenLocked adds the useRedirectURIAsLoginURLWhenLocked to the authorize v3 params

func (*AuthorizeV3Params) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type AuthorizeV3Reader 

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

AuthorizeV3Reader is a Reader for the AuthorizeV3 structure.

func (*AuthorizeV3Reader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type Change2FAMethodBadRequest added in v0.15.0 

type Change2FAMethodBadRequest struct {
	Payload *iamclientmodels.RestErrorResponse
}

Change2FAMethodBadRequest handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>10189</td><td>invalid factor</td></tr><tr><td>20002</td><td>validation error</td></tr></table>

func NewChange2FAMethodBadRequest added in v0.15.0 

func NewChange2FAMethodBadRequest() *Change2FAMethodBadRequest

NewChange2FAMethodBadRequest creates a Change2FAMethodBadRequest with default headers values

func (*Change2FAMethodBadRequest) Error added in v0.15.0 

func (o *Change2FAMethodBadRequest) Error() string

func (*Change2FAMethodBadRequest) GetPayload added in v0.15.0 

func (o *Change2FAMethodBadRequest) GetPayload() *iamclientmodels.RestErrorResponse

func (*Change2FAMethodBadRequest) ToJSONString added in v0.25.0 

func (o *Change2FAMethodBadRequest) ToJSONString() string

type Change2FAMethodInternalServerError added in v0.32.0 

type Change2FAMethodInternalServerError struct {
	Payload *iamclientmodels.RestErrorResponse
}

Change2FAMethodInternalServerError handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20000</td><td>internal server error</td></tr></table>

func NewChange2FAMethodInternalServerError added in v0.32.0 

func NewChange2FAMethodInternalServerError() *Change2FAMethodInternalServerError

NewChange2FAMethodInternalServerError creates a Change2FAMethodInternalServerError with default headers values

func (*Change2FAMethodInternalServerError) Error added in v0.32.0 

func (o *Change2FAMethodInternalServerError) Error() string

func (*Change2FAMethodInternalServerError) GetPayload added in v0.32.0 

func (o *Change2FAMethodInternalServerError) GetPayload() *iamclientmodels.RestErrorResponse

func (*Change2FAMethodInternalServerError) ToJSONString added in v0.32.0 

func (o *Change2FAMethodInternalServerError) ToJSONString() string

type Change2FAMethodNoContent added in v0.15.0 

type Change2FAMethodNoContent struct {
}

Change2FAMethodNoContent handles this case with default header values. 

Method changed

func NewChange2FAMethodNoContent added in v0.15.0 

func NewChange2FAMethodNoContent() *Change2FAMethodNoContent

NewChange2FAMethodNoContent creates a Change2FAMethodNoContent with default headers values

func (*Change2FAMethodNoContent) Error added in v0.15.0 

func (o *Change2FAMethodNoContent) Error() string

type Change2FAMethodParams added in v0.15.0 

type Change2FAMethodParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Factor
	  factor

	*/
	Factor string
	/*MFAToken
	  mfa token

	*/
	MFAToken string

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

Change2FAMethodParams contains all the parameters to send to the API endpoint for the change2fa method operation typically these are written to a http.Request

func NewChange2FAMethodParams added in v0.15.0 

func NewChange2FAMethodParams() *Change2FAMethodParams

NewChange2FAMethodParams creates a new Change2FAMethodParams object with the default values initialized.

func NewChange2FAMethodParamsWithContext added in v0.15.0 

func NewChange2FAMethodParamsWithContext(ctx context.Context) *Change2FAMethodParams

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

func NewChange2FAMethodParamsWithHTTPClient added in v0.15.0 

func NewChange2FAMethodParamsWithHTTPClient(client *http.Client) *Change2FAMethodParams

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

func NewChange2FAMethodParamsWithTimeout added in v0.15.0 

func NewChange2FAMethodParamsWithTimeout(timeout time.Duration) *Change2FAMethodParams

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

func (*Change2FAMethodParams) SetAuthInfoWriter added in v0.17.0 

func (o *Change2FAMethodParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the change2fa method params

func (*Change2FAMethodParams) SetContext added in v0.15.0 

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

SetContext adds the context to the change2fa method params

func (*Change2FAMethodParams) SetFactor added in v0.15.0 

func (o *Change2FAMethodParams) SetFactor(factor string)

SetFactor adds the factor to the change2fa method params

func (*Change2FAMethodParams) SetHTTPClient added in v0.15.0 

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

SetHTTPClient adds the HTTPClient to the change2fa method params

func (*Change2FAMethodParams) SetHTTPClientTransport added in v0.19.0 

func (o *Change2FAMethodParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the change2fa method params

func (*Change2FAMethodParams) SetMFAToken added in v0.39.0 

func (o *Change2FAMethodParams) SetMFAToken(mFAToken string)

SetMFAToken adds the mfaToken to the change2fa method params

func (*Change2FAMethodParams) SetTimeout added in v0.15.0 

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

SetTimeout adds the timeout to the change2fa method params

func (*Change2FAMethodParams) WithContext added in v0.15.0 

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

WithContext adds the context to the change2fa method params

func (*Change2FAMethodParams) WithFactor added in v0.15.0 

func (o *Change2FAMethodParams) WithFactor(factor string) *Change2FAMethodParams

WithFactor adds the factor to the change2fa method params

func (*Change2FAMethodParams) WithHTTPClient added in v0.15.0 

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

WithHTTPClient adds the HTTPClient to the change2fa method params

func (*Change2FAMethodParams) WithMFAToken added in v0.39.0 

func (o *Change2FAMethodParams) WithMFAToken(mFAToken string) *Change2FAMethodParams

WithMFAToken adds the mFAToken to the change2fa method params

func (*Change2FAMethodParams) WithTimeout added in v0.15.0 

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

WithTimeout adds the timeout to the change2fa method params

func (*Change2FAMethodParams) WriteToRequest added in v0.15.0 

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

WriteToRequest writes these params to a swagger request

type Change2FAMethodReader added in v0.15.0 

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

Change2FAMethodReader is a Reader for the Change2FAMethod structure.

func (*Change2FAMethodReader) ReadResponse added in v0.15.0 

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

ReadResponse reads a server response into the received o.

type Change2FAMethodTooManyRequests added in v0.44.0 

type Change2FAMethodTooManyRequests struct {
	Payload *iamclientmodels.RestErrorResponse
}

Change2FAMethodTooManyRequests handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20007</td><td>too many requests</td></tr></table>

func NewChange2FAMethodTooManyRequests added in v0.44.0 

func NewChange2FAMethodTooManyRequests() *Change2FAMethodTooManyRequests

NewChange2FAMethodTooManyRequests creates a Change2FAMethodTooManyRequests with default headers values

func (*Change2FAMethodTooManyRequests) Error added in v0.44.0 

func (o *Change2FAMethodTooManyRequests) Error() string

func (*Change2FAMethodTooManyRequests) GetPayload added in v0.44.0 

func (o *Change2FAMethodTooManyRequests) GetPayload() *iamclientmodels.RestErrorResponse

func (*Change2FAMethodTooManyRequests) ToJSONString added in v0.44.0 

func (o *Change2FAMethodTooManyRequests) ToJSONString() string

type Client 

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

Client for o auth2 0 API

func (*Client) AdminRetrieveUserThirdPartyPlatformTokenV3 deprecated added in v0.8.0 

func (a *Client) AdminRetrieveUserThirdPartyPlatformTokenV3(params *AdminRetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*AdminRetrieveUserThirdPartyPlatformTokenV3OK, *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized, *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden, *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound, error)

Deprecated: 2022-08-10 - Use AdminRetrieveUserThirdPartyPlatformTokenV3Short instead.

AdminRetrieveUserThirdPartyPlatformTokenV3 admin retrieve user third party platform token Admin Retrieve User Third Party Platform Token

This endpoint used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members.

Notes:

  • Required permission: ADMIN:NAMESPACE:{namespace}:USER:{userId} [READ]

The third party platform and platform group covered for this is:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

  • epicgames

  • twitch

  • awscognito

    *

  • eaorigin

  • snapchat

  • twitch

  • live

func (*Client) AdminRetrieveUserThirdPartyPlatformTokenV3Short added in v0.8.0 

func (a *Client) AdminRetrieveUserThirdPartyPlatformTokenV3Short(params *AdminRetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*AdminRetrieveUserThirdPartyPlatformTokenV3OK, error)

AdminRetrieveUserThirdPartyPlatformTokenV3Short admin retrieve user third party platform token Admin Retrieve User Third Party Platform Token

This endpoint used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members.

Notes:

  • Required permission: ADMIN:NAMESPACE:{namespace}:USER:{userId} [READ]

The third party platform and platform group covered for this is:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

  • epicgames

  • twitch

  • awscognito

    *

  • eaorigin

  • snapchat

  • twitch

  • live

func (*Client) AuthCodeRequestV3 deprecated added in v0.2.0 

func (a *Client) AuthCodeRequestV3(params *AuthCodeRequestV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthCodeRequestV3Found, error)

Deprecated: 2022-08-10 - Use AuthCodeRequestV3Short instead.

AuthCodeRequestV3 generate url to request auth code from third party platform. Generate url to request auth code from third party platform

## Supported platforms:

  • steamopenid

This endpoint redirects to steam login page, then redirect back to platform authenticate endpoint after successfully authenticating user steam.

  • xblweb

This endpoint redirects to xbox login page, then redirect back to platform authenticate endpoint after successfully authenticating xbox user.

  • ps4web

This endpoint redirects to psn login page, then redirect back to platform authenticate endpoint after successfully authenticating psn user.

  • epicgames

This endpoint redirects to Epicgames OAuth login page. then redirect to platform authenticate endpoint after successfully authenticating an Epicgames credential

  • twitch

This endpoint redirects to twitch login page, then redirect back to platform authenticate endpoint after successfully authenticating twitch user.

  • azure

This endpoint redirects to azure login page, then redirect back to platform authenticate(saml) endpoint after successfully authenticating azure user.

  • facebook

This endpoint redirects to facebook login page, then redirect back to platform authenticate endpoint after successfully authenticating facebook user.

  • google

This endpoint redirects to google login page, then redirect back to platform authenticate endpoint after successfully authenticating google user.

  • snapchat

This endpoint redirects to snapchat login page, then redirect back to platform authenticate endpoint after successfully authenticating snapchat user.

  • discord

This endpoint redirects to discord login page, then redirect back to platform authenticate endpoint after successfully authenticating discord user.

  • amazon

This endpoint redirects to amazon login page, then redirect back to platform authenticate endpoint after successfully authenticating amazon user.

  • oculusweb

This endpoint redirects to oculus login page, then redirect back to Login Website page after successfully authenticating oculus user. action code : 10702'

func (*Client) AuthCodeRequestV3Short added in v0.8.0 

func (a *Client) AuthCodeRequestV3Short(params *AuthCodeRequestV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthCodeRequestV3Found, error)

AuthCodeRequestV3Short generate url to request auth code from third party platform. Generate url to request auth code from third party platform

## Supported platforms:

  • steamopenid

This endpoint redirects to steam login page, then redirect back to platform authenticate endpoint after successfully authenticating user steam.

  • xblweb

This endpoint redirects to xbox login page, then redirect back to platform authenticate endpoint after successfully authenticating xbox user.

  • ps4web

This endpoint redirects to psn login page, then redirect back to platform authenticate endpoint after successfully authenticating psn user.

  • epicgames

This endpoint redirects to Epicgames OAuth login page. then redirect to platform authenticate endpoint after successfully authenticating an Epicgames credential

  • twitch

This endpoint redirects to twitch login page, then redirect back to platform authenticate endpoint after successfully authenticating twitch user.

  • azure

This endpoint redirects to azure login page, then redirect back to platform authenticate(saml) endpoint after successfully authenticating azure user.

  • facebook

This endpoint redirects to facebook login page, then redirect back to platform authenticate endpoint after successfully authenticating facebook user.

  • google

This endpoint redirects to google login page, then redirect back to platform authenticate endpoint after successfully authenticating google user.

  • snapchat

This endpoint redirects to snapchat login page, then redirect back to platform authenticate endpoint after successfully authenticating snapchat user.

  • discord

This endpoint redirects to discord login page, then redirect back to platform authenticate endpoint after successfully authenticating discord user.

  • amazon

This endpoint redirects to amazon login page, then redirect back to platform authenticate endpoint after successfully authenticating amazon user.

  • oculusweb

This endpoint redirects to oculus login page, then redirect back to Login Website page after successfully authenticating oculus user. action code : 10702'

func (*Client) AuthorizeV3 deprecated 

func (a *Client) AuthorizeV3(params *AuthorizeV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthorizeV3Found, error)

Deprecated: 2022-08-10 - Use AuthorizeV3Short instead.

AuthorizeV3 oauth2 authorize api Initializes OAuth2.0 authorization code flow

The endpoint stores authorization request and redirects to login page with the authorization request id. The user can then do the authentication on the login page. The user will be redirected back to the requesting client with authorization code if successfully authenticated.

Only authorization code flow supported by this endpoint, implicit flow is not supported.

  • Authorize success :

redirects to login page with the following information: ?request_id={authorization_request_id}

  • Authorize failure :

redirects to the given redirect uri with the following information: ?error={error_code}&error;_description={error description}

Following are the error code based on the specification:

  • invalid_request: The request is missing a required parameter,

includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.

  • server_error:

The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

  • unauthorized_client: The client is not authorized to request a token using this method.

  • access_denied: The resource owner or authorization server denied the request.

  • invalid_scope: The requested scope is invalid, unknown, or malformed.

  • unsupported_response_type: The authorization server does not support obtaining a token using this method.

  • temporarily_unavailable: The authorization server is currently unable to handle the request

due to a temporary overloading or maintenance of the server.

Please refer to the RFC for more information about authorization code flow: https://tools.ietf.org/html/rfc6749#section-4.1

action code: 10701

func (*Client) AuthorizeV3Short added in v0.8.0 

func (a *Client) AuthorizeV3Short(params *AuthorizeV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthorizeV3Found, error)

AuthorizeV3Short oauth2 authorize api Initializes OAuth2.0 authorization code flow

The endpoint stores authorization request and redirects to login page with the authorization request id. The user can then do the authentication on the login page. The user will be redirected back to the requesting client with authorization code if successfully authenticated.

Only authorization code flow supported by this endpoint, implicit flow is not supported.

  • Authorize success :

redirects to login page with the following information: ?request_id={authorization_request_id}

  • Authorize failure :

redirects to the given redirect uri with the following information: ?error={error_code}&error;_description={error description}

Following are the error code based on the specification:

  • invalid_request: The request is missing a required parameter,

includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.

  • server_error:

The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

  • unauthorized_client: The client is not authorized to request a token using this method.

  • access_denied: The resource owner or authorization server denied the request.

  • invalid_scope: The requested scope is invalid, unknown, or malformed.

  • unsupported_response_type: The authorization server does not support obtaining a token using this method.

  • temporarily_unavailable: The authorization server is currently unable to handle the request

due to a temporary overloading or maintenance of the server.

Please refer to the RFC for more information about authorization code flow: https://tools.ietf.org/html/rfc6749#section-4.1

action code: 10701

func (*Client) Change2FAMethod deprecated added in v0.15.0 

func (a *Client) Change2FAMethod(params *Change2FAMethodParams, authInfo runtime.ClientAuthInfoWriter) (*Change2FAMethodNoContent, *Change2FAMethodBadRequest, *Change2FAMethodTooManyRequests, *Change2FAMethodInternalServerError, error)

Deprecated: 2022-08-10 - Use Change2FAMethodShort instead.

Change2FAMethod change 2fa method Change 2FA method

This endpoint is used for change 2FA method. Only enabled methods are accepted.

Supported methods:

  • authenticator

  • backupCode

  • email

func (*Client) Change2FAMethodShort added in v0.15.0 

func (a *Client) Change2FAMethodShort(params *Change2FAMethodParams, authInfo runtime.ClientAuthInfoWriter) (*Change2FAMethodNoContent, error)

Change2FAMethodShort change 2fa method Change 2FA method

This endpoint is used for change 2FA method. Only enabled methods are accepted.

Supported methods:

  • authenticator

  • backupCode

  • email

func (*Client) GetJWKSV3 deprecated added in v0.2.0 

func (a *Client) GetJWKSV3(params *GetJWKSV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSV3OK, error)

Deprecated: 2022-08-10 - Use GetJWKSV3Short instead.

GetJWKSV3 json web key set for verifying jwt

This endpoint serves public keys for verifying JWT access tokens generated by this service.

When a client application wants to verify a JWT token, it needs to get the 'kid' value found in the JWT token header and use it to look up the corresponding public key from a set returned by this endpoint. The client application can then use that public key to verify the JWT.

A client application might cache the keys so it doesn't need to do request every time it needs to verify a JWT token. If a client application caches the keys and a key with the same 'kid' cannot be found in the cache, it should then try to refresh the keys by making a request to this endpoint again.

Please refer to the RFC for more information about JWK (JSON Web Key): https://tools.ietf.org/html/rfc7517

action code : 10709

func (*Client) GetJWKSV3Short added in v0.8.0 

func (a *Client) GetJWKSV3Short(params *GetJWKSV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSV3OK, error)

GetJWKSV3Short json web key set for verifying jwt

This endpoint serves public keys for verifying JWT access tokens generated by this service.

When a client application wants to verify a JWT token, it needs to get the 'kid' value found in the JWT token header and use it to look up the corresponding public key from a set returned by this endpoint. The client application can then use that public key to verify the JWT.

A client application might cache the keys so it doesn't need to do request every time it needs to verify a JWT token. If a client application caches the keys and a key with the same 'kid' cannot be found in the cache, it should then try to refresh the keys by making a request to this endpoint again.

Please refer to the RFC for more information about JWK (JSON Web Key): https://tools.ietf.org/html/rfc7517

action code : 10709

func (*Client) GetRevocationListV3 deprecated added in v0.2.0 

func (a *Client) GetRevocationListV3(params *GetRevocationListV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListV3OK, *GetRevocationListV3Unauthorized, error)

Deprecated: 2022-08-10 - Use GetRevocationListV3Short instead.

GetRevocationListV3 oauth2 revocation list api

This endpoint will return a list of revoked users and revoked tokens. List of revoked tokens in bloom filter format.

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

The bloom filter uses MurmurHash3 algorithm for hashing the values

action code : 10708

func (*Client) GetRevocationListV3Short added in v0.8.0 

func (a *Client) GetRevocationListV3Short(params *GetRevocationListV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListV3OK, error)

GetRevocationListV3Short oauth2 revocation list api

This endpoint will return a list of revoked users and revoked tokens. List of revoked tokens in bloom filter format.

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

The bloom filter uses MurmurHash3 algorithm for hashing the values

action code : 10708

func (*Client) PlatformTokenGrantV3 deprecated added in v0.2.0 

func (a *Client) PlatformTokenGrantV3(params *PlatformTokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV3OK, *PlatformTokenGrantV3BadRequest, *PlatformTokenGrantV3Unauthorized, *PlatformTokenGrantV3Forbidden, *PlatformTokenGrantV3ServiceUnavailable, error)

Deprecated: 2022-08-10 - Use PlatformTokenGrantV3Short instead.

PlatformTokenGrantV3 oauth2 access token generation specific to platform

Platform token grant specifically used for performing token grant using platform, e.g. Steam, Justice, etc. The endpoint automatically create an account if the account associated with the platform is not exists yet. This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. For publisher-game namespace schema : Specify only either platform_token or device_id. Device token grant should be requested along with device_id parameter against game namespace. Another 3rd party platform token grant should be requested along with platform_token parameter against publisher namespace.

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

## Supported platforms:

  • steam : The platform_tokenâ��s value is the binary ticket returned by Steam.

If this ticket was generated by Steam GetAuthTicketForWebApi with version >= 1.57, then platform token should use this style: `{identity}:{ticket}`,

the `{identity}` was the parameter to call GetAuthTicketForWebApi when the ticket was created. Note: Do not contain `:` in this `{identity}`.

  • steamopenid : Steam's user authentication method using OpenID 2.0. The platform_token's value is URL generated by Steam on web authentication

  • facebook : The platform_tokenâ��s value is the authorization code returned by Facebook OAuth

  • google : The platform_tokenâ��s value is the authorization code returned by Google OAuth

  • oculus : The platform_tokenâ��s value is a string composed of Oculus's user ID and the nonce separated by a colon (:).

  • twitch : The platform_tokenâ��s value is the authorization code returned by Twitch OAuth.

  • discord : The platform_tokenâ��s value is the authorization code returned by Discord OAuth

  • android : The device_id is the Androidâ��s device ID

  • ios : The device_id is the iOSâ��s device ID.

  • apple : The platform_tokenâ��s value is the authorization code returned by Apple OAuth.(We will use this code to generate APP token)

  • device : Every device that doesâ��nt run Android and iOS is categorized as a device. The device_id is the deviceâ��s ID.

  • justice : The platform_tokenâ��s value is the designated userâ��s access token.

  • epicgames : The platform_tokenâ��s value is an access-token or authorization code obtained from Epicgames EOS Account Service.

  • ps4 : The platform_tokenâ��s value is the authorization code returned by Sony OAuth.

  • ps5 : The platform_tokenâ��s value is the authorization code returned by Sony OAuth.

  • nintendo : The platform_tokenâ��s value is the id_token returned by Nintendo OAuth.

  • awscognito : The platform_tokenâ��s value is the aws cognito access token or id token (JWT).

  • live : The platform_tokenâ��s value is xbox XSTS token

  • xblweb : The platform_tokenâ��s value is code returned by xbox after login

  • netflix : The platform_tokenâ��s value is GAT (Gamer Access Token) returned by Netflix backend

  • snapchat : The platform_tokenâ��s value is the authorization code returned by Snapchat OAuth.

  • for specific generic oauth (OIDC) : The platform_tokenâ��s value should be the same type as created OIDC auth type whether it is auth code, idToken or bearerToken.

## Account Group

Several platforms are grouped under account groups. The accounts on these platforms have the same platform user id. Login using one of these platform will returns the same IAM user.

Following is the current registered account grouping:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

  • 8: Suspicious Login

    *

aud. The aud is the client ID. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

sub. The UserID. The sub is omitted if the token is generated from client credential

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

action code : 10704

func (*Client) PlatformTokenGrantV3Short added in v0.8.0 

func (a *Client) PlatformTokenGrantV3Short(params *PlatformTokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV3OK, error)

PlatformTokenGrantV3Short oauth2 access token generation specific to platform

Platform token grant specifically used for performing token grant using platform, e.g. Steam, Justice, etc. The endpoint automatically create an account if the account associated with the platform is not exists yet. This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. For publisher-game namespace schema : Specify only either platform_token or device_id. Device token grant should be requested along with device_id parameter against game namespace. Another 3rd party platform token grant should be requested along with platform_token parameter against publisher namespace.

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

## Supported platforms:

  • steam : The platform_tokenâ��s value is the binary ticket returned by Steam.

If this ticket was generated by Steam GetAuthTicketForWebApi with version >= 1.57, then platform token should use this style: `{identity}:{ticket}`,

the `{identity}` was the parameter to call GetAuthTicketForWebApi when the ticket was created. Note: Do not contain `:` in this `{identity}`.

  • steamopenid : Steam's user authentication method using OpenID 2.0. The platform_token's value is URL generated by Steam on web authentication

  • facebook : The platform_tokenâ��s value is the authorization code returned by Facebook OAuth

  • google : The platform_tokenâ��s value is the authorization code returned by Google OAuth

  • oculus : The platform_tokenâ��s value is a string composed of Oculus's user ID and the nonce separated by a colon (:).

  • twitch : The platform_tokenâ��s value is the authorization code returned by Twitch OAuth.

  • discord : The platform_tokenâ��s value is the authorization code returned by Discord OAuth

  • android : The device_id is the Androidâ��s device ID

  • ios : The device_id is the iOSâ��s device ID.

  • apple : The platform_tokenâ��s value is the authorization code returned by Apple OAuth.(We will use this code to generate APP token)

  • device : Every device that doesâ��nt run Android and iOS is categorized as a device. The device_id is the deviceâ��s ID.

  • justice : The platform_tokenâ��s value is the designated userâ��s access token.

  • epicgames : The platform_tokenâ��s value is an access-token or authorization code obtained from Epicgames EOS Account Service.

  • ps4 : The platform_tokenâ��s value is the authorization code returned by Sony OAuth.

  • ps5 : The platform_tokenâ��s value is the authorization code returned by Sony OAuth.

  • nintendo : The platform_tokenâ��s value is the id_token returned by Nintendo OAuth.

  • awscognito : The platform_tokenâ��s value is the aws cognito access token or id token (JWT).

  • live : The platform_tokenâ��s value is xbox XSTS token

  • xblweb : The platform_tokenâ��s value is code returned by xbox after login

  • netflix : The platform_tokenâ��s value is GAT (Gamer Access Token) returned by Netflix backend

  • snapchat : The platform_tokenâ��s value is the authorization code returned by Snapchat OAuth.

  • for specific generic oauth (OIDC) : The platform_tokenâ��s value should be the same type as created OIDC auth type whether it is auth code, idToken or bearerToken.

## Account Group

Several platforms are grouped under account groups. The accounts on these platforms have the same platform user id. Login using one of these platform will returns the same IAM user.

Following is the current registered account grouping:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

  • 8: Suspicious Login

    *

aud. The aud is the client ID. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

sub. The UserID. The sub is omitted if the token is generated from client credential

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

action code : 10704

func (*Client) RetrieveUserThirdPartyPlatformTokenV3 deprecated added in v0.2.0 

func (a *Client) RetrieveUserThirdPartyPlatformTokenV3(params *RetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*RetrieveUserThirdPartyPlatformTokenV3OK, *RetrieveUserThirdPartyPlatformTokenV3Unauthorized, *RetrieveUserThirdPartyPlatformTokenV3Forbidden, *RetrieveUserThirdPartyPlatformTokenV3NotFound, error)

Deprecated: 2022-08-10 - Use RetrieveUserThirdPartyPlatformTokenV3Short instead.

RetrieveUserThirdPartyPlatformTokenV3 retrieve user third party platform token Retrieve User Third Party Platform Token

This endpoint used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members.

The third party platform and platform group covered for this is:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

  • epicgames

  • twitch

  • awscognito

    *

  • eaorigin

  • snapchat

  • twitch

  • live

func (*Client) RetrieveUserThirdPartyPlatformTokenV3Short added in v0.8.0 

func (a *Client) RetrieveUserThirdPartyPlatformTokenV3Short(params *RetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*RetrieveUserThirdPartyPlatformTokenV3OK, error)

RetrieveUserThirdPartyPlatformTokenV3Short retrieve user third party platform token Retrieve User Third Party Platform Token

This endpoint used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members.

The third party platform and platform group covered for this is:

  • (psn) ps4web

  • (psn) ps4

  • (psn) ps5

  • epicgames

  • twitch

  • awscognito

    *

  • eaorigin

  • snapchat

  • twitch

  • live

func (*Client) RevokeUserV3 deprecated added in v0.2.0 

func (a *Client) RevokeUserV3(params *RevokeUserV3Params, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserV3NoContent, *RevokeUserV3BadRequest, *RevokeUserV3Unauthorized, *RevokeUserV3Forbidden, error)

Deprecated: 2022-08-10 - Use RevokeUserV3Short instead.

RevokeUserV3 revokes user's tokens'

This endpoint revokes all access tokens and refresh tokens a user has prior the revocation time.

This endpoint requires authorized requests header with valid access token.

Required permission 'ADMIN:NAMESPACE:{namespace}:USER:{userId} [UPDATE]'

It is a convenient feature for the developer (or admin) who wanted to revokes all user's access tokens and refresh tokens generated before some period of time.

action code : 10707

func (*Client) RevokeUserV3Short added in v0.8.0 

func (a *Client) RevokeUserV3Short(params *RevokeUserV3Params, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserV3NoContent, error)

RevokeUserV3Short revokes user's tokens'

This endpoint revokes all access tokens and refresh tokens a user has prior the revocation time.

This endpoint requires authorized requests header with valid access token.

Required permission 'ADMIN:NAMESPACE:{namespace}:USER:{userId} [UPDATE]'

It is a convenient feature for the developer (or admin) who wanted to revokes all user's access tokens and refresh tokens generated before some period of time.

action code : 10707

func (*Client) SendMFAAuthenticationCode deprecated added in v0.32.0 

func (a *Client) SendMFAAuthenticationCode(params *SendMFAAuthenticationCodeParams, authInfo runtime.ClientAuthInfoWriter) (*SendMFAAuthenticationCodeNoContent, *SendMFAAuthenticationCodeBadRequest, *SendMFAAuthenticationCodeForbidden, *SendMFAAuthenticationCodeNotFound, *SendMFAAuthenticationCodeTooManyRequests, *SendMFAAuthenticationCodeInternalServerError, error)

Deprecated: 2022-08-10 - Use SendMFAAuthenticationCodeShort instead.

SendMFAAuthenticationCode send 2fa code Send 2FA code

This endpoint is used for sending 2FA code.

func (*Client) SendMFAAuthenticationCodeShort added in v0.32.0 

func (a *Client) SendMFAAuthenticationCodeShort(params *SendMFAAuthenticationCodeParams, authInfo runtime.ClientAuthInfoWriter) (*SendMFAAuthenticationCodeNoContent, error)

SendMFAAuthenticationCodeShort send 2fa code Send 2FA code

This endpoint is used for sending 2FA code.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) TokenGrantV3 deprecated 

func (a *Client) TokenGrantV3(params *TokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV3OK, *TokenGrantV3BadRequest, *TokenGrantV3Unauthorized, *TokenGrantV3Forbidden, *TokenGrantV3TooManyRequests, error)

Deprecated: 2022-08-10 - Use TokenGrantV3Short instead.

TokenGrantV3 oauth2 access token generation endpoint

This endpoint supports grant type:

  1. Grant Type == `authorization_code`:

    It generates the user token by given the authorization

code which generated in "/iam/v3/authenticate" API response. It should also pass in the redirect_uri, which should be the same as generating the authorization code request.

  1. Grant Type == `password`:

    The grant type to use for authenticating a user, whether it's by email / username and password combination

or through platform.

  1. Grant Type == `refresh_token`:

    Used to get a new access token for a valid refresh token.

  2. Grant Type == `client_credentials`:

    It generates a token by checking the client credentials provided through Authorization header.

  3. Grant Type == `urn:ietf:params:oauth:grant-type:extend_client_credentials`:

    It generates a token by checking the client credentials provided through Authorization header. It only allow publisher namespace client. In generated token: 1.There wil be no roles, namespace_roles & permission. 2.The scope will be fixed as 'extend'. 3.There will have a new field 'extend_namespace', the value is from token request body.

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

  • 8: Suspicious Login

    *

aud. The aud is the targeted resource server. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

client_id. The UserID. The sub is omitted if the token is generated from client credential 

*

scope. The scope of the access request, expressed as a list of space-delimited, case-sensitive strings

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

## Device Cookie Validation

For grant type "password" only

Device Cookie is used to protect the user account from brute force login attack, [more detail from OWASP.

This endpoint will read device cookie from request header Auth-Trust-Id. If device cookie not found, it will generate a new one and set it into response body auth_trust_id when successfully login.

## Track Login History

This endpoint will track login history to detect suspicious login activity, please provide Device-Id (alphanumeric) in request header parameter otherwise it will set to "unknown".

Align with General Data Protection Regulation in Europe, user login history will be kept within 28 days by default"

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

## Response note

If it is a user token request and user hasn't accepted required legal policy, the field `is_comply` will be false in response and responsed token will have no permission.

action code: 10703

func (*Client) TokenGrantV3Short added in v0.8.0 

func (a *Client) TokenGrantV3Short(params *TokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV3OK, error)

TokenGrantV3Short oauth2 access token generation endpoint

This endpoint supports grant type:

  1. Grant Type == `authorization_code`:

    It generates the user token by given the authorization

code which generated in "/iam/v3/authenticate" API response. It should also pass in the redirect_uri, which should be the same as generating the authorization code request.

  1. Grant Type == `password`:

    The grant type to use for authenticating a user, whether it's by email / username and password combination

or through platform.

  1. Grant Type == `refresh_token`:

    Used to get a new access token for a valid refresh token.

  2. Grant Type == `client_credentials`:

    It generates a token by checking the client credentials provided through Authorization header.

  3. Grant Type == `urn:ietf:params:oauth:grant-type:extend_client_credentials`:

    It generates a token by checking the client credentials provided through Authorization header. It only allow publisher namespace client. In generated token: 1.There wil be no roles, namespace_roles & permission. 2.The scope will be fixed as 'extend'. 3.There will have a new field 'extend_namespace', the value is from token request body.

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

  • 8: Suspicious Login

    *

aud. The aud is the targeted resource server. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

client_id. The UserID. The sub is omitted if the token is generated from client credential 

*

scope. The scope of the access request, expressed as a list of space-delimited, case-sensitive strings

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

## Device Cookie Validation

For grant type "password" only

Device Cookie is used to protect the user account from brute force login attack, [more detail from OWASP.

This endpoint will read device cookie from request header Auth-Trust-Id. If device cookie not found, it will generate a new one and set it into response body auth_trust_id when successfully login.

## Track Login History

This endpoint will track login history to detect suspicious login activity, please provide Device-Id (alphanumeric) in request header parameter otherwise it will set to "unknown".

Align with General Data Protection Regulation in Europe, user login history will be kept within 28 days by default"

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

## Response note

If it is a user token request and user hasn't accepted required legal policy, the field `is_comply` will be false in response and responsed token will have no permission.

action code: 10703

func (*Client) TokenIntrospectionV3 deprecated added in v0.2.0 

func (a *Client) TokenIntrospectionV3(params *TokenIntrospectionV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenIntrospectionV3OK, *TokenIntrospectionV3BadRequest, *TokenIntrospectionV3Unauthorized, error)

Deprecated: 2022-08-10 - Use TokenIntrospectionV3Short instead.

TokenIntrospectionV3 oauth2 token introspection api

This endpoint returns information about an access token intended to be used by resource servers or other internal servers.

This endpoint requires authorized requests header with valid basic or bearer token.

action code : 10705

func (*Client) TokenIntrospectionV3Short added in v0.8.0 

func (a *Client) TokenIntrospectionV3Short(params *TokenIntrospectionV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenIntrospectionV3OK, error)

TokenIntrospectionV3Short oauth2 token introspection api

This endpoint returns information about an access token intended to be used by resource servers or other internal servers.

This endpoint requires authorized requests header with valid basic or bearer token.

action code : 10705

func (*Client) TokenRevocationV3 deprecated 

func (a *Client) TokenRevocationV3(params *TokenRevocationV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenRevocationV3OK, *TokenRevocationV3BadRequest, *TokenRevocationV3Unauthorized, error)

Deprecated: 2022-08-10 - Use TokenRevocationV3Short instead.

TokenRevocationV3 oauth2 token revocation api

This endpoint revokes a token.

This endpoint requires authorized requests header with Basic Authentication from client that establish the token.

action code: 10706

func (*Client) TokenRevocationV3Short added in v0.8.0 

func (a *Client) TokenRevocationV3Short(params *TokenRevocationV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenRevocationV3OK, error)

TokenRevocationV3Short oauth2 token revocation api

This endpoint revokes a token.

This endpoint requires authorized requests header with Basic Authentication from client that establish the token.

action code: 10706

func (*Client) Verify2FACode deprecated added in v0.15.0 

func (a *Client) Verify2FACode(params *Verify2FACodeParams, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeOK, *Verify2FACodeUnauthorized, error)

Deprecated: 2022-08-10 - Use Verify2FACodeShort instead.

Verify2FACode verify 2fa code Verify 2FA code

This endpoint is used for verifying 2FA code.

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

func (*Client) Verify2FACodeShort added in v0.15.0 

func (a *Client) Verify2FACodeShort(params *Verify2FACodeParams, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeOK, error)

Verify2FACodeShort verify 2fa code Verify 2FA code

This endpoint is used for verifying 2FA code.

## 2FA remember device

To remember device for 2FA, should provide cookie: device_token or header: Device-Token

func (*Client) VerifyTokenV3 deprecated added in v0.24.0 

func (a *Client) VerifyTokenV3(params *VerifyTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenV3OK, *VerifyTokenV3BadRequest, error)

Deprecated: 2022-08-10 - Use VerifyTokenV3Short instead.

VerifyTokenV3 oauth2 token verification api This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

func (*Client) VerifyTokenV3Short added in v0.24.0 

func (a *Client) VerifyTokenV3Short(params *VerifyTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenV3OK, error)

VerifyTokenV3Short oauth2 token verification api This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

type ClientService 

type ClientService interface {
	AdminRetrieveUserThirdPartyPlatformTokenV3(params *AdminRetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*AdminRetrieveUserThirdPartyPlatformTokenV3OK, *AdminRetrieveUserThirdPartyPlatformTokenV3Unauthorized, *AdminRetrieveUserThirdPartyPlatformTokenV3Forbidden, *AdminRetrieveUserThirdPartyPlatformTokenV3NotFound, error)
	AdminRetrieveUserThirdPartyPlatformTokenV3Short(params *AdminRetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*AdminRetrieveUserThirdPartyPlatformTokenV3OK, error)
	RevokeUserV3(params *RevokeUserV3Params, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserV3NoContent, *RevokeUserV3BadRequest, *RevokeUserV3Unauthorized, *RevokeUserV3Forbidden, error)
	RevokeUserV3Short(params *RevokeUserV3Params, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserV3NoContent, error)
	AuthorizeV3(params *AuthorizeV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthorizeV3Found, error)
	AuthorizeV3Short(params *AuthorizeV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthorizeV3Found, error)
	TokenIntrospectionV3(params *TokenIntrospectionV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenIntrospectionV3OK, *TokenIntrospectionV3BadRequest, *TokenIntrospectionV3Unauthorized, error)
	TokenIntrospectionV3Short(params *TokenIntrospectionV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenIntrospectionV3OK, error)
	GetJWKSV3(params *GetJWKSV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSV3OK, error)
	GetJWKSV3Short(params *GetJWKSV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSV3OK, error)
	SendMFAAuthenticationCode(params *SendMFAAuthenticationCodeParams, authInfo runtime.ClientAuthInfoWriter) (*SendMFAAuthenticationCodeNoContent, *SendMFAAuthenticationCodeBadRequest, *SendMFAAuthenticationCodeForbidden, *SendMFAAuthenticationCodeNotFound, *SendMFAAuthenticationCodeTooManyRequests, *SendMFAAuthenticationCodeInternalServerError, error)
	SendMFAAuthenticationCodeShort(params *SendMFAAuthenticationCodeParams, authInfo runtime.ClientAuthInfoWriter) (*SendMFAAuthenticationCodeNoContent, error)
	Change2FAMethod(params *Change2FAMethodParams, authInfo runtime.ClientAuthInfoWriter) (*Change2FAMethodNoContent, *Change2FAMethodBadRequest, *Change2FAMethodTooManyRequests, *Change2FAMethodInternalServerError, error)
	Change2FAMethodShort(params *Change2FAMethodParams, authInfo runtime.ClientAuthInfoWriter) (*Change2FAMethodNoContent, error)
	Verify2FACode(params *Verify2FACodeParams, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeOK, *Verify2FACodeUnauthorized, error)
	Verify2FACodeShort(params *Verify2FACodeParams, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeOK, error)
	RetrieveUserThirdPartyPlatformTokenV3(params *RetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*RetrieveUserThirdPartyPlatformTokenV3OK, *RetrieveUserThirdPartyPlatformTokenV3Unauthorized, *RetrieveUserThirdPartyPlatformTokenV3Forbidden, *RetrieveUserThirdPartyPlatformTokenV3NotFound, error)
	RetrieveUserThirdPartyPlatformTokenV3Short(params *RetrieveUserThirdPartyPlatformTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*RetrieveUserThirdPartyPlatformTokenV3OK, error)
	AuthCodeRequestV3(params *AuthCodeRequestV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthCodeRequestV3Found, error)
	AuthCodeRequestV3Short(params *AuthCodeRequestV3Params, authInfo runtime.ClientAuthInfoWriter) (*AuthCodeRequestV3Found, error)
	PlatformTokenGrantV3(params *PlatformTokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV3OK, *PlatformTokenGrantV3BadRequest, *PlatformTokenGrantV3Unauthorized, *PlatformTokenGrantV3Forbidden, *PlatformTokenGrantV3ServiceUnavailable, error)
	PlatformTokenGrantV3Short(params *PlatformTokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV3OK, error)
	GetRevocationListV3(params *GetRevocationListV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListV3OK, *GetRevocationListV3Unauthorized, error)
	GetRevocationListV3Short(params *GetRevocationListV3Params, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListV3OK, error)
	TokenRevocationV3(params *TokenRevocationV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenRevocationV3OK, *TokenRevocationV3BadRequest, *TokenRevocationV3Unauthorized, error)
	TokenRevocationV3Short(params *TokenRevocationV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenRevocationV3OK, error)
	TokenGrantV3(params *TokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV3OK, *TokenGrantV3BadRequest, *TokenGrantV3Unauthorized, *TokenGrantV3Forbidden, *TokenGrantV3TooManyRequests, error)
	TokenGrantV3Short(params *TokenGrantV3Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV3OK, error)
	VerifyTokenV3(params *VerifyTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenV3OK, *VerifyTokenV3BadRequest, error)
	VerifyTokenV3Short(params *VerifyTokenV3Params, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenV3OK, 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 auth2 0 API client.

type GetJWKSV3OK added in v0.2.0 

type GetJWKSV3OK struct {
	Payload *iamclientmodels.OauthcommonJWKSet
}

GetJWKSV3OK handles this case with default header values. 

JWKS returned

func NewGetJWKSV3OK added in v0.2.0 

func NewGetJWKSV3OK() *GetJWKSV3OK

NewGetJWKSV3OK creates a GetJWKSV3OK with default headers values

func (*GetJWKSV3OK) Error added in v0.2.0 

func (o *GetJWKSV3OK) Error() string

func (*GetJWKSV3OK) GetPayload added in v0.2.0 

func (o *GetJWKSV3OK) GetPayload() *iamclientmodels.OauthcommonJWKSet

func (*GetJWKSV3OK) ToJSONString added in v0.25.0 

func (o *GetJWKSV3OK) ToJSONString() string

type GetJWKSV3Params added in v0.2.0 

type GetJWKSV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry

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

GetJWKSV3Params contains all the parameters to send to the API endpoint for the get jwksv3 operation typically these are written to a http.Request

func NewGetJWKSV3Params added in v0.2.0 

func NewGetJWKSV3Params() *GetJWKSV3Params

NewGetJWKSV3Params creates a new GetJWKSV3Params object with the default values initialized.

func NewGetJWKSV3ParamsWithContext added in v0.2.0 

func NewGetJWKSV3ParamsWithContext(ctx context.Context) *GetJWKSV3Params

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

func NewGetJWKSV3ParamsWithHTTPClient added in v0.2.0 

func NewGetJWKSV3ParamsWithHTTPClient(client *http.Client) *GetJWKSV3Params

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

func NewGetJWKSV3ParamsWithTimeout added in v0.2.0 

func NewGetJWKSV3ParamsWithTimeout(timeout time.Duration) *GetJWKSV3Params

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

func (*GetJWKSV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *GetJWKSV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the get jwksv3 params

func (*GetJWKSV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the get jwksv3 params

func (*GetJWKSV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the get jwksv3 params

func (*GetJWKSV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *GetJWKSV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the get jwksv3 params

func (*GetJWKSV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the get jwksv3 params

func (*GetJWKSV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the get jwksv3 params

func (*GetJWKSV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the get jwksv3 params

func (*GetJWKSV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the get jwksv3 params

func (*GetJWKSV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type GetJWKSV3Reader added in v0.2.0 

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

GetJWKSV3Reader is a Reader for the GetJWKSV3 structure.

func (*GetJWKSV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type GetRevocationListV3OK added in v0.2.0 

type GetRevocationListV3OK struct {
	Payload *iamclientmodels.OauthapiRevocationList
}

GetRevocationListV3OK handles this case with default header values. 

Revocation list returned

func NewGetRevocationListV3OK added in v0.2.0 

func NewGetRevocationListV3OK() *GetRevocationListV3OK

NewGetRevocationListV3OK creates a GetRevocationListV3OK with default headers values

func (*GetRevocationListV3OK) Error added in v0.2.0 

func (o *GetRevocationListV3OK) Error() string

func (*GetRevocationListV3OK) GetPayload added in v0.2.0 

func (o *GetRevocationListV3OK) GetPayload() *iamclientmodels.OauthapiRevocationList

func (*GetRevocationListV3OK) ToJSONString added in v0.25.0 

func (o *GetRevocationListV3OK) ToJSONString() string

type GetRevocationListV3Params added in v0.2.0 

type GetRevocationListV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry

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

GetRevocationListV3Params contains all the parameters to send to the API endpoint for the get revocation list v3 operation typically these are written to a http.Request

func NewGetRevocationListV3Params added in v0.2.0 

func NewGetRevocationListV3Params() *GetRevocationListV3Params

NewGetRevocationListV3Params creates a new GetRevocationListV3Params object with the default values initialized.

func NewGetRevocationListV3ParamsWithContext added in v0.2.0 

func NewGetRevocationListV3ParamsWithContext(ctx context.Context) *GetRevocationListV3Params

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

func NewGetRevocationListV3ParamsWithHTTPClient added in v0.2.0 

func NewGetRevocationListV3ParamsWithHTTPClient(client *http.Client) *GetRevocationListV3Params

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

func NewGetRevocationListV3ParamsWithTimeout added in v0.2.0 

func NewGetRevocationListV3ParamsWithTimeout(timeout time.Duration) *GetRevocationListV3Params

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

func (*GetRevocationListV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *GetRevocationListV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the get revocation list v3 params

func (*GetRevocationListV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the get revocation list v3 params

func (*GetRevocationListV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the get revocation list v3 params

func (*GetRevocationListV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *GetRevocationListV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the get revocation list v3 params

func (*GetRevocationListV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the get revocation list v3 params

func (*GetRevocationListV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the get revocation list v3 params

func (*GetRevocationListV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the get revocation list v3 params

func (*GetRevocationListV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the get revocation list v3 params

func (*GetRevocationListV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type GetRevocationListV3Reader added in v0.2.0 

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

GetRevocationListV3Reader is a Reader for the GetRevocationListV3 structure.

func (*GetRevocationListV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type GetRevocationListV3Unauthorized added in v0.2.0 

type GetRevocationListV3Unauthorized struct {
	Payload *iamclientmodels.RestErrorResponse
}

GetRevocationListV3Unauthorized handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20001</td><td>unauthorized access</td></tr></table>

func NewGetRevocationListV3Unauthorized added in v0.2.0 

func NewGetRevocationListV3Unauthorized() *GetRevocationListV3Unauthorized

NewGetRevocationListV3Unauthorized creates a GetRevocationListV3Unauthorized with default headers values

func (*GetRevocationListV3Unauthorized) Error added in v0.2.0 

func (o *GetRevocationListV3Unauthorized) Error() string

func (*GetRevocationListV3Unauthorized) GetPayload added in v0.2.0 

func (o *GetRevocationListV3Unauthorized) GetPayload() *iamclientmodels.RestErrorResponse

func (*GetRevocationListV3Unauthorized) ToJSONString added in v0.25.0 

func (o *GetRevocationListV3Unauthorized) ToJSONString() string

type PlatformTokenGrantV3BadRequest added in v0.2.0 

type PlatformTokenGrantV3BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV3BadRequest handles this case with default header values. 

General request error

func NewPlatformTokenGrantV3BadRequest added in v0.2.0 

func NewPlatformTokenGrantV3BadRequest() *PlatformTokenGrantV3BadRequest

NewPlatformTokenGrantV3BadRequest creates a PlatformTokenGrantV3BadRequest with default headers values

func (*PlatformTokenGrantV3BadRequest) Error added in v0.2.0 

func (o *PlatformTokenGrantV3BadRequest) Error() string

func (*PlatformTokenGrantV3BadRequest) GetPayload added in v0.2.0 

func (o *PlatformTokenGrantV3BadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenGrantV3BadRequest) ToJSONString added in v0.25.0 

func (o *PlatformTokenGrantV3BadRequest) ToJSONString() string

type PlatformTokenGrantV3Forbidden added in v0.29.0 

type PlatformTokenGrantV3Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV3Forbidden handles this case with default header values. 

Forbidden

func NewPlatformTokenGrantV3Forbidden added in v0.29.0 

func NewPlatformTokenGrantV3Forbidden() *PlatformTokenGrantV3Forbidden

NewPlatformTokenGrantV3Forbidden creates a PlatformTokenGrantV3Forbidden with default headers values

func (*PlatformTokenGrantV3Forbidden) Error added in v0.29.0 

func (o *PlatformTokenGrantV3Forbidden) Error() string

func (*PlatformTokenGrantV3Forbidden) GetPayload added in v0.29.0 

func (o *PlatformTokenGrantV3Forbidden) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenGrantV3Forbidden) ToJSONString added in v0.29.0 

func (o *PlatformTokenGrantV3Forbidden) ToJSONString() string

type PlatformTokenGrantV3OK added in v0.2.0 

type PlatformTokenGrantV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponse
}

PlatformTokenGrantV3OK handles this case with default header values. 

Token returned

func NewPlatformTokenGrantV3OK added in v0.2.0 

func NewPlatformTokenGrantV3OK() *PlatformTokenGrantV3OK

NewPlatformTokenGrantV3OK creates a PlatformTokenGrantV3OK with default headers values

func (*PlatformTokenGrantV3OK) Error added in v0.2.0 

func (o *PlatformTokenGrantV3OK) Error() string

func (*PlatformTokenGrantV3OK) GetPayload added in v0.2.0 

func (o *PlatformTokenGrantV3OK) GetPayload() *iamclientmodels.OauthmodelTokenResponse

func (*PlatformTokenGrantV3OK) ToJSONString added in v0.25.0 

func (o *PlatformTokenGrantV3OK) ToJSONString() string

type PlatformTokenGrantV3Params added in v0.2.0 

type PlatformTokenGrantV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*AdditionalData
	  Additional info, it will be passed to login success event.

	*/
	AdditionalData *string
	/*ClientID
	  Client ID, only accept UUID version 4 without hyphen

	*/
	ClientID *string
	/*CreateHeadless
	  If directly create new account when not linked yet

	*/
	CreateHeadless *bool
	/*DeviceID
	  Device/hardware identifier

	*/
	DeviceID *string
	/*MacAddress
	  Mac address of device

	*/
	MacAddress *string
	/*PlatformToken
	  Token from platform auth

	*/
	PlatformToken *string
	/*SkipSetCookie
	  If need skip set cookie. Default is false

	*/
	SkipSetCookie *bool
	/*PlatformID
	  Platform ID to login with

	*/
	PlatformID string

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

PlatformTokenGrantV3Params contains all the parameters to send to the API endpoint for the platform token grant v3 operation typically these are written to a http.Request

func NewPlatformTokenGrantV3Params added in v0.2.0 

func NewPlatformTokenGrantV3Params() *PlatformTokenGrantV3Params

NewPlatformTokenGrantV3Params creates a new PlatformTokenGrantV3Params object with the default values initialized.

func NewPlatformTokenGrantV3ParamsWithContext added in v0.2.0 

func NewPlatformTokenGrantV3ParamsWithContext(ctx context.Context) *PlatformTokenGrantV3Params

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

func NewPlatformTokenGrantV3ParamsWithHTTPClient added in v0.2.0 

func NewPlatformTokenGrantV3ParamsWithHTTPClient(client *http.Client) *PlatformTokenGrantV3Params

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

func NewPlatformTokenGrantV3ParamsWithTimeout added in v0.2.0 

func NewPlatformTokenGrantV3ParamsWithTimeout(timeout time.Duration) *PlatformTokenGrantV3Params

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

func (*PlatformTokenGrantV3Params) SetAdditionalData added in v0.48.0 

func (o *PlatformTokenGrantV3Params) SetAdditionalData(additionalData *string)

SetAdditionalData adds the additionalData to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *PlatformTokenGrantV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetClientID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) SetClientID(clientID *string)

SetClientID adds the clientId to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetCreateHeadless added in v0.20.0 

func (o *PlatformTokenGrantV3Params) SetCreateHeadless(createHeadless *bool)

SetCreateHeadless adds the createHeadless to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetDeviceID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) SetDeviceID(deviceID *string)

SetDeviceID adds the deviceId to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *PlatformTokenGrantV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetMacAddress added in v0.29.0 

func (o *PlatformTokenGrantV3Params) SetMacAddress(macAddress *string)

SetMacAddress adds the macAddress to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetPlatformID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetPlatformToken added in v0.2.0 

func (o *PlatformTokenGrantV3Params) SetPlatformToken(platformToken *string)

SetPlatformToken adds the platformToken to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetSkipSetCookie added in v0.42.0 

func (o *PlatformTokenGrantV3Params) SetSkipSetCookie(skipSetCookie *bool)

SetSkipSetCookie adds the skipSetCookie to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithAdditionalData added in v0.48.0 

func (o *PlatformTokenGrantV3Params) WithAdditionalData(additionalData *string) *PlatformTokenGrantV3Params

WithAdditionalData adds the additionalData to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithClientID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) WithClientID(clientID *string) *PlatformTokenGrantV3Params

WithClientID adds the clientID to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithCreateHeadless added in v0.20.0 

func (o *PlatformTokenGrantV3Params) WithCreateHeadless(createHeadless *bool) *PlatformTokenGrantV3Params

WithCreateHeadless adds the createHeadless to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithDeviceID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) WithDeviceID(deviceID *string) *PlatformTokenGrantV3Params

WithDeviceID adds the deviceID to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithMacAddress added in v0.29.0 

func (o *PlatformTokenGrantV3Params) WithMacAddress(macAddress *string) *PlatformTokenGrantV3Params

WithMacAddress adds the macAddress to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithPlatformID added in v0.2.0 

func (o *PlatformTokenGrantV3Params) WithPlatformID(platformID string) *PlatformTokenGrantV3Params

WithPlatformID adds the platformID to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithPlatformToken added in v0.2.0 

func (o *PlatformTokenGrantV3Params) WithPlatformToken(platformToken *string) *PlatformTokenGrantV3Params

WithPlatformToken adds the platformToken to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithSkipSetCookie added in v0.42.0 

func (o *PlatformTokenGrantV3Params) WithSkipSetCookie(skipSetCookie *bool) *PlatformTokenGrantV3Params

WithSkipSetCookie adds the skipSetCookie to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the platform token grant v3 params

func (*PlatformTokenGrantV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type PlatformTokenGrantV3Reader added in v0.2.0 

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

PlatformTokenGrantV3Reader is a Reader for the PlatformTokenGrantV3 structure.

func (*PlatformTokenGrantV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type PlatformTokenGrantV3ServiceUnavailable added in v0.41.0 

type PlatformTokenGrantV3ServiceUnavailable struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV3ServiceUnavailable handles this case with default header values. 

Third Party Server timeout or unavailable

func NewPlatformTokenGrantV3ServiceUnavailable added in v0.41.0 

func NewPlatformTokenGrantV3ServiceUnavailable() *PlatformTokenGrantV3ServiceUnavailable

NewPlatformTokenGrantV3ServiceUnavailable creates a PlatformTokenGrantV3ServiceUnavailable with default headers values

func (*PlatformTokenGrantV3ServiceUnavailable) Error added in v0.41.0 

func (o *PlatformTokenGrantV3ServiceUnavailable) Error() string

func (*PlatformTokenGrantV3ServiceUnavailable) GetPayload added in v0.41.0 

func (o *PlatformTokenGrantV3ServiceUnavailable) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenGrantV3ServiceUnavailable) ToJSONString added in v0.41.0 

func (o *PlatformTokenGrantV3ServiceUnavailable) ToJSONString() string

type PlatformTokenGrantV3Unauthorized added in v0.2.0 

type PlatformTokenGrantV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV3Unauthorized handles this case with default header values. 

Client authentication failed

func NewPlatformTokenGrantV3Unauthorized added in v0.2.0 

func NewPlatformTokenGrantV3Unauthorized() *PlatformTokenGrantV3Unauthorized

NewPlatformTokenGrantV3Unauthorized creates a PlatformTokenGrantV3Unauthorized with default headers values

func (*PlatformTokenGrantV3Unauthorized) Error added in v0.2.0 

func (o *PlatformTokenGrantV3Unauthorized) Error() string

func (*PlatformTokenGrantV3Unauthorized) GetPayload added in v0.2.0 

func (o *PlatformTokenGrantV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenGrantV3Unauthorized) ToJSONString added in v0.25.0 

func (o *PlatformTokenGrantV3Unauthorized) ToJSONString() string

type RetrieveUserThirdPartyPlatformTokenV3Forbidden added in v0.2.0 

type RetrieveUserThirdPartyPlatformTokenV3Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RetrieveUserThirdPartyPlatformTokenV3Forbidden handles this case with default header values. 

Unauthorized access

func NewRetrieveUserThirdPartyPlatformTokenV3Forbidden added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3Forbidden() *RetrieveUserThirdPartyPlatformTokenV3Forbidden

NewRetrieveUserThirdPartyPlatformTokenV3Forbidden creates a RetrieveUserThirdPartyPlatformTokenV3Forbidden with default headers values

func (*RetrieveUserThirdPartyPlatformTokenV3Forbidden) Error added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Forbidden) Error() string

func (*RetrieveUserThirdPartyPlatformTokenV3Forbidden) GetPayload added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Forbidden) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RetrieveUserThirdPartyPlatformTokenV3Forbidden) ToJSONString added in v0.25.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Forbidden) ToJSONString() string

type RetrieveUserThirdPartyPlatformTokenV3NotFound added in v0.2.0 

type RetrieveUserThirdPartyPlatformTokenV3NotFound struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RetrieveUserThirdPartyPlatformTokenV3NotFound handles this case with default header values. 

Platform Token Not Found

func NewRetrieveUserThirdPartyPlatformTokenV3NotFound added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3NotFound() *RetrieveUserThirdPartyPlatformTokenV3NotFound

NewRetrieveUserThirdPartyPlatformTokenV3NotFound creates a RetrieveUserThirdPartyPlatformTokenV3NotFound with default headers values

func (*RetrieveUserThirdPartyPlatformTokenV3NotFound) Error added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3NotFound) Error() string

func (*RetrieveUserThirdPartyPlatformTokenV3NotFound) GetPayload added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3NotFound) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RetrieveUserThirdPartyPlatformTokenV3NotFound) ToJSONString added in v0.25.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3NotFound) ToJSONString() string

type RetrieveUserThirdPartyPlatformTokenV3OK added in v0.2.0 

type RetrieveUserThirdPartyPlatformTokenV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenThirdPartyResponse
}

RetrieveUserThirdPartyPlatformTokenV3OK handles this case with default header values. 

Token returned

func NewRetrieveUserThirdPartyPlatformTokenV3OK added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3OK() *RetrieveUserThirdPartyPlatformTokenV3OK

NewRetrieveUserThirdPartyPlatformTokenV3OK creates a RetrieveUserThirdPartyPlatformTokenV3OK with default headers values

func (*RetrieveUserThirdPartyPlatformTokenV3OK) Error added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3OK) Error() string

func (*RetrieveUserThirdPartyPlatformTokenV3OK) GetPayload added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3OK) GetPayload() *iamclientmodels.OauthmodelTokenThirdPartyResponse

func (*RetrieveUserThirdPartyPlatformTokenV3OK) ToJSONString added in v0.25.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3OK) ToJSONString() string

type RetrieveUserThirdPartyPlatformTokenV3Params added in v0.2.0 

type RetrieveUserThirdPartyPlatformTokenV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  Namespace, only accept alphabet and numeric

	*/
	Namespace string
	/*PlatformID
	  Platform ID

	*/
	PlatformID string
	/*UserID
	  UserId

	*/
	UserID string

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

RetrieveUserThirdPartyPlatformTokenV3Params contains all the parameters to send to the API endpoint for the retrieve user third party platform token v3 operation typically these are written to a http.Request

func NewRetrieveUserThirdPartyPlatformTokenV3Params added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3Params() *RetrieveUserThirdPartyPlatformTokenV3Params

NewRetrieveUserThirdPartyPlatformTokenV3Params creates a new RetrieveUserThirdPartyPlatformTokenV3Params object with the default values initialized.

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithContext added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithContext(ctx context.Context) *RetrieveUserThirdPartyPlatformTokenV3Params

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

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithHTTPClient added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithHTTPClient(client *http.Client) *RetrieveUserThirdPartyPlatformTokenV3Params

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

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithTimeout added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3ParamsWithTimeout(timeout time.Duration) *RetrieveUserThirdPartyPlatformTokenV3Params

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

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetNamespace added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) SetNamespace(namespace string)

SetNamespace adds the namespace to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetPlatformID added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) SetUserID added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) SetUserID(userID string)

SetUserID adds the userId to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithNamespace added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) WithNamespace(namespace string) *RetrieveUserThirdPartyPlatformTokenV3Params

WithNamespace adds the namespace to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithPlatformID added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Params) WithPlatformID(platformID string) *RetrieveUserThirdPartyPlatformTokenV3Params

WithPlatformID adds the platformID to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WithUserID added in v0.2.0 

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

WithUserID adds the userID to the retrieve user third party platform token v3 params

func (*RetrieveUserThirdPartyPlatformTokenV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type RetrieveUserThirdPartyPlatformTokenV3Reader added in v0.2.0 

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

RetrieveUserThirdPartyPlatformTokenV3Reader is a Reader for the RetrieveUserThirdPartyPlatformTokenV3 structure.

func (*RetrieveUserThirdPartyPlatformTokenV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type RetrieveUserThirdPartyPlatformTokenV3Unauthorized added in v0.2.0 

type RetrieveUserThirdPartyPlatformTokenV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RetrieveUserThirdPartyPlatformTokenV3Unauthorized handles this case with default header values. 

Client authentication failed

func NewRetrieveUserThirdPartyPlatformTokenV3Unauthorized added in v0.2.0 

func NewRetrieveUserThirdPartyPlatformTokenV3Unauthorized() *RetrieveUserThirdPartyPlatformTokenV3Unauthorized

NewRetrieveUserThirdPartyPlatformTokenV3Unauthorized creates a RetrieveUserThirdPartyPlatformTokenV3Unauthorized with default headers values

func (*RetrieveUserThirdPartyPlatformTokenV3Unauthorized) Error added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Unauthorized) Error() string

func (*RetrieveUserThirdPartyPlatformTokenV3Unauthorized) GetPayload added in v0.2.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RetrieveUserThirdPartyPlatformTokenV3Unauthorized) ToJSONString added in v0.25.0 

func (o *RetrieveUserThirdPartyPlatformTokenV3Unauthorized) ToJSONString() string

type RevokeUserV3BadRequest added in v0.2.0 

type RevokeUserV3BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RevokeUserV3BadRequest handles this case with default header values. 

invalid input

func NewRevokeUserV3BadRequest added in v0.2.0 

func NewRevokeUserV3BadRequest() *RevokeUserV3BadRequest

NewRevokeUserV3BadRequest creates a RevokeUserV3BadRequest with default headers values

func (*RevokeUserV3BadRequest) Error added in v0.2.0 

func (o *RevokeUserV3BadRequest) Error() string

func (*RevokeUserV3BadRequest) GetPayload added in v0.2.0 

func (o *RevokeUserV3BadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RevokeUserV3BadRequest) ToJSONString added in v0.25.0 

func (o *RevokeUserV3BadRequest) ToJSONString() string

type RevokeUserV3Forbidden added in v0.2.0 

type RevokeUserV3Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RevokeUserV3Forbidden handles this case with default header values. 

insufficient permission

func NewRevokeUserV3Forbidden added in v0.2.0 

func NewRevokeUserV3Forbidden() *RevokeUserV3Forbidden

NewRevokeUserV3Forbidden creates a RevokeUserV3Forbidden with default headers values

func (*RevokeUserV3Forbidden) Error added in v0.2.0 

func (o *RevokeUserV3Forbidden) Error() string

func (*RevokeUserV3Forbidden) GetPayload added in v0.2.0 

func (o *RevokeUserV3Forbidden) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RevokeUserV3Forbidden) ToJSONString added in v0.25.0 

func (o *RevokeUserV3Forbidden) ToJSONString() string

type RevokeUserV3NoContent added in v0.50.0 

type RevokeUserV3NoContent struct {
}

RevokeUserV3NoContent handles this case with default header values. 

user revoked

func NewRevokeUserV3NoContent added in v0.50.0 

func NewRevokeUserV3NoContent() *RevokeUserV3NoContent

NewRevokeUserV3NoContent creates a RevokeUserV3NoContent with default headers values

func (*RevokeUserV3NoContent) Error added in v0.50.0 

func (o *RevokeUserV3NoContent) Error() string

type RevokeUserV3Params added in v0.2.0 

type RevokeUserV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  Namespace, only accept alphabet and numeric

	*/
	Namespace string
	/*UserID
	  User to be revoked

	*/
	UserID string
	/*IncludeGameNamespace
	  <p>This queryParameter only works when utilizing userID and namespace publisher.</p> <p>If true, the system will revoke all game account under the publisher account.</p>

	*/
	IncludeGameNamespace *bool

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

RevokeUserV3Params contains all the parameters to send to the API endpoint for the revoke user v3 operation typically these are written to a http.Request

func NewRevokeUserV3Params added in v0.2.0 

func NewRevokeUserV3Params() *RevokeUserV3Params

NewRevokeUserV3Params creates a new RevokeUserV3Params object with the default values initialized.

func NewRevokeUserV3ParamsWithContext added in v0.2.0 

func NewRevokeUserV3ParamsWithContext(ctx context.Context) *RevokeUserV3Params

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

func NewRevokeUserV3ParamsWithHTTPClient added in v0.2.0 

func NewRevokeUserV3ParamsWithHTTPClient(client *http.Client) *RevokeUserV3Params

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

func NewRevokeUserV3ParamsWithTimeout added in v0.2.0 

func NewRevokeUserV3ParamsWithTimeout(timeout time.Duration) *RevokeUserV3Params

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

func (*RevokeUserV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *RevokeUserV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the revoke user v3 params

func (*RevokeUserV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the revoke user v3 params

func (*RevokeUserV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the revoke user v3 params

func (*RevokeUserV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *RevokeUserV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the revoke user v3 params

func (*RevokeUserV3Params) SetIncludeGameNamespace added in v0.50.0 

func (o *RevokeUserV3Params) SetIncludeGameNamespace(includeGameNamespace *bool)

SetIncludeGameNamespace adds the includeGameNamespace to the revoke user v3 params

func (*RevokeUserV3Params) SetNamespace added in v0.2.0 

func (o *RevokeUserV3Params) SetNamespace(namespace string)

SetNamespace adds the namespace to the revoke user v3 params

func (*RevokeUserV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the revoke user v3 params

func (*RevokeUserV3Params) SetUserID added in v0.2.0 

func (o *RevokeUserV3Params) SetUserID(userID string)

SetUserID adds the userId to the revoke user v3 params

func (*RevokeUserV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the revoke user v3 params

func (*RevokeUserV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the revoke user v3 params

func (*RevokeUserV3Params) WithIncludeGameNamespace added in v0.50.0 

func (o *RevokeUserV3Params) WithIncludeGameNamespace(includeGameNamespace *bool) *RevokeUserV3Params

WithIncludeGameNamespace adds the includeGameNamespace to the revoke user v3 params

func (*RevokeUserV3Params) WithNamespace added in v0.2.0 

func (o *RevokeUserV3Params) WithNamespace(namespace string) *RevokeUserV3Params

WithNamespace adds the namespace to the revoke user v3 params

func (*RevokeUserV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the revoke user v3 params

func (*RevokeUserV3Params) WithUserID added in v0.2.0 

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

WithUserID adds the userID to the revoke user v3 params

func (*RevokeUserV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type RevokeUserV3Reader added in v0.2.0 

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

RevokeUserV3Reader is a Reader for the RevokeUserV3 structure.

func (*RevokeUserV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type RevokeUserV3Unauthorized added in v0.2.0 

type RevokeUserV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

RevokeUserV3Unauthorized handles this case with default header values. 

Token is not exist, expired, or invalid

func NewRevokeUserV3Unauthorized added in v0.2.0 

func NewRevokeUserV3Unauthorized() *RevokeUserV3Unauthorized

NewRevokeUserV3Unauthorized creates a RevokeUserV3Unauthorized with default headers values

func (*RevokeUserV3Unauthorized) Error added in v0.2.0 

func (o *RevokeUserV3Unauthorized) Error() string

func (*RevokeUserV3Unauthorized) GetPayload added in v0.2.0 

func (o *RevokeUserV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*RevokeUserV3Unauthorized) ToJSONString added in v0.25.0 

func (o *RevokeUserV3Unauthorized) ToJSONString() string

type SendMFAAuthenticationCodeBadRequest added in v0.32.0 

type SendMFAAuthenticationCodeBadRequest struct {
	Payload *iamclientmodels.RestErrorResponse
}

SendMFAAuthenticationCodeBadRequest handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20002</td><td>validation error</td></tr><tr><td>10189</td><td>invalid factor</td></tr></table>

func NewSendMFAAuthenticationCodeBadRequest added in v0.32.0 

func NewSendMFAAuthenticationCodeBadRequest() *SendMFAAuthenticationCodeBadRequest

NewSendMFAAuthenticationCodeBadRequest creates a SendMFAAuthenticationCodeBadRequest with default headers values

func (*SendMFAAuthenticationCodeBadRequest) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeBadRequest) Error() string

func (*SendMFAAuthenticationCodeBadRequest) GetPayload added in v0.32.0 

func (o *SendMFAAuthenticationCodeBadRequest) GetPayload() *iamclientmodels.RestErrorResponse

func (*SendMFAAuthenticationCodeBadRequest) ToJSONString added in v0.32.0 

func (o *SendMFAAuthenticationCodeBadRequest) ToJSONString() string

type SendMFAAuthenticationCodeForbidden added in v0.32.0 

type SendMFAAuthenticationCodeForbidden struct {
	Payload *iamclientmodels.RestErrorResponse
}

SendMFAAuthenticationCodeForbidden handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20003</td><td>forbidden access</td></tr></table>

func NewSendMFAAuthenticationCodeForbidden added in v0.32.0 

func NewSendMFAAuthenticationCodeForbidden() *SendMFAAuthenticationCodeForbidden

NewSendMFAAuthenticationCodeForbidden creates a SendMFAAuthenticationCodeForbidden with default headers values

func (*SendMFAAuthenticationCodeForbidden) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeForbidden) Error() string

func (*SendMFAAuthenticationCodeForbidden) GetPayload added in v0.32.0 

func (o *SendMFAAuthenticationCodeForbidden) GetPayload() *iamclientmodels.RestErrorResponse

func (*SendMFAAuthenticationCodeForbidden) ToJSONString added in v0.32.0 

func (o *SendMFAAuthenticationCodeForbidden) ToJSONString() string

type SendMFAAuthenticationCodeInternalServerError added in v0.32.0 

type SendMFAAuthenticationCodeInternalServerError struct {
	Payload *iamclientmodels.RestErrorResponse
}

SendMFAAuthenticationCodeInternalServerError handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20000</td><td>internal server error</td></tr></table>

func NewSendMFAAuthenticationCodeInternalServerError added in v0.32.0 

func NewSendMFAAuthenticationCodeInternalServerError() *SendMFAAuthenticationCodeInternalServerError

NewSendMFAAuthenticationCodeInternalServerError creates a SendMFAAuthenticationCodeInternalServerError with default headers values

func (*SendMFAAuthenticationCodeInternalServerError) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeInternalServerError) Error() string

func (*SendMFAAuthenticationCodeInternalServerError) GetPayload added in v0.32.0 

func (o *SendMFAAuthenticationCodeInternalServerError) GetPayload() *iamclientmodels.RestErrorResponse

func (*SendMFAAuthenticationCodeInternalServerError) ToJSONString added in v0.32.0 

func (o *SendMFAAuthenticationCodeInternalServerError) ToJSONString() string

type SendMFAAuthenticationCodeNoContent added in v0.32.0 

type SendMFAAuthenticationCodeNoContent struct {
}

SendMFAAuthenticationCodeNoContent handles this case with default header values. 

Code sent

func NewSendMFAAuthenticationCodeNoContent added in v0.32.0 

func NewSendMFAAuthenticationCodeNoContent() *SendMFAAuthenticationCodeNoContent

NewSendMFAAuthenticationCodeNoContent creates a SendMFAAuthenticationCodeNoContent with default headers values

func (*SendMFAAuthenticationCodeNoContent) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeNoContent) Error() string

type SendMFAAuthenticationCodeNotFound added in v0.32.0 

type SendMFAAuthenticationCodeNotFound struct {
	Payload *iamclientmodels.RestErrorResponse
}

SendMFAAuthenticationCodeNotFound handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20008</td><td>user not found</td></tr></table>

func NewSendMFAAuthenticationCodeNotFound added in v0.32.0 

func NewSendMFAAuthenticationCodeNotFound() *SendMFAAuthenticationCodeNotFound

NewSendMFAAuthenticationCodeNotFound creates a SendMFAAuthenticationCodeNotFound with default headers values

func (*SendMFAAuthenticationCodeNotFound) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeNotFound) Error() string

func (*SendMFAAuthenticationCodeNotFound) GetPayload added in v0.32.0 

func (o *SendMFAAuthenticationCodeNotFound) GetPayload() *iamclientmodels.RestErrorResponse

func (*SendMFAAuthenticationCodeNotFound) ToJSONString added in v0.32.0 

func (o *SendMFAAuthenticationCodeNotFound) ToJSONString() string

type SendMFAAuthenticationCodeParams added in v0.32.0 

type SendMFAAuthenticationCodeParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*ClientID
	  client id

	*/
	ClientID string
	/*Factor
	  factor

	*/
	Factor string
	/*MFAToken
	  mfa token

	*/
	MFAToken string

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

SendMFAAuthenticationCodeParams contains all the parameters to send to the API endpoint for the send mfa authentication code operation typically these are written to a http.Request

func NewSendMFAAuthenticationCodeParams added in v0.32.0 

func NewSendMFAAuthenticationCodeParams() *SendMFAAuthenticationCodeParams

NewSendMFAAuthenticationCodeParams creates a new SendMFAAuthenticationCodeParams object with the default values initialized.

func NewSendMFAAuthenticationCodeParamsWithContext added in v0.32.0 

func NewSendMFAAuthenticationCodeParamsWithContext(ctx context.Context) *SendMFAAuthenticationCodeParams

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

func NewSendMFAAuthenticationCodeParamsWithHTTPClient added in v0.32.0 

func NewSendMFAAuthenticationCodeParamsWithHTTPClient(client *http.Client) *SendMFAAuthenticationCodeParams

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

func NewSendMFAAuthenticationCodeParamsWithTimeout added in v0.32.0 

func NewSendMFAAuthenticationCodeParamsWithTimeout(timeout time.Duration) *SendMFAAuthenticationCodeParams

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

func (*SendMFAAuthenticationCodeParams) SetAuthInfoWriter added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetClientID added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) SetClientID(clientID string)

SetClientID adds the clientId to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetContext added in v0.32.0 

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

SetContext adds the context to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetFactor added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) SetFactor(factor string)

SetFactor adds the factor to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetHTTPClient added in v0.32.0 

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

SetHTTPClient adds the HTTPClient to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetHTTPClientTransport added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetMFAToken added in v0.39.0 

func (o *SendMFAAuthenticationCodeParams) SetMFAToken(mFAToken string)

SetMFAToken adds the mfaToken to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) SetTimeout added in v0.32.0 

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

SetTimeout adds the timeout to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithClientID added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) WithClientID(clientID string) *SendMFAAuthenticationCodeParams

WithClientID adds the clientID to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithContext added in v0.32.0 

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

WithContext adds the context to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithFactor added in v0.32.0 

func (o *SendMFAAuthenticationCodeParams) WithFactor(factor string) *SendMFAAuthenticationCodeParams

WithFactor adds the factor to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithHTTPClient added in v0.32.0 

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

WithHTTPClient adds the HTTPClient to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithMFAToken added in v0.39.0 

func (o *SendMFAAuthenticationCodeParams) WithMFAToken(mFAToken string) *SendMFAAuthenticationCodeParams

WithMFAToken adds the mFAToken to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WithTimeout added in v0.32.0 

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

WithTimeout adds the timeout to the send mfa authentication code params

func (*SendMFAAuthenticationCodeParams) WriteToRequest added in v0.32.0 

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

WriteToRequest writes these params to a swagger request

type SendMFAAuthenticationCodeReader added in v0.32.0 

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

SendMFAAuthenticationCodeReader is a Reader for the SendMFAAuthenticationCode structure.

func (*SendMFAAuthenticationCodeReader) ReadResponse added in v0.32.0 

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

ReadResponse reads a server response into the received o.

type SendMFAAuthenticationCodeTooManyRequests added in v0.32.0 

type SendMFAAuthenticationCodeTooManyRequests struct {
	Payload *iamclientmodels.RestErrorResponse
}

SendMFAAuthenticationCodeTooManyRequests handles this case with default header values. 

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>20007</td><td>too many requests</td></tr></table>

func NewSendMFAAuthenticationCodeTooManyRequests added in v0.32.0 

func NewSendMFAAuthenticationCodeTooManyRequests() *SendMFAAuthenticationCodeTooManyRequests

NewSendMFAAuthenticationCodeTooManyRequests creates a SendMFAAuthenticationCodeTooManyRequests with default headers values

func (*SendMFAAuthenticationCodeTooManyRequests) Error added in v0.32.0 

func (o *SendMFAAuthenticationCodeTooManyRequests) Error() string

func (*SendMFAAuthenticationCodeTooManyRequests) GetPayload added in v0.32.0 

func (o *SendMFAAuthenticationCodeTooManyRequests) GetPayload() *iamclientmodels.RestErrorResponse

func (*SendMFAAuthenticationCodeTooManyRequests) ToJSONString added in v0.32.0 

func (o *SendMFAAuthenticationCodeTooManyRequests) ToJSONString() string

type TokenGrantV3BadRequest 

type TokenGrantV3BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV3BadRequest handles this case with default header values. 

InvalidRequest

func NewTokenGrantV3BadRequest 

func NewTokenGrantV3BadRequest() *TokenGrantV3BadRequest

NewTokenGrantV3BadRequest creates a TokenGrantV3BadRequest with default headers values

func (*TokenGrantV3BadRequest) Error 

func (o *TokenGrantV3BadRequest) Error() string

func (*TokenGrantV3BadRequest) GetPayload 

func (o *TokenGrantV3BadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantV3BadRequest) ToJSONString added in v0.25.0 

func (o *TokenGrantV3BadRequest) ToJSONString() string

type TokenGrantV3Forbidden 

type TokenGrantV3Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV3Forbidden handles this case with default header values. 

Unauthorized access

func NewTokenGrantV3Forbidden 

func NewTokenGrantV3Forbidden() *TokenGrantV3Forbidden

NewTokenGrantV3Forbidden creates a TokenGrantV3Forbidden with default headers values

func (*TokenGrantV3Forbidden) Error 

func (o *TokenGrantV3Forbidden) Error() string

func (*TokenGrantV3Forbidden) GetPayload 

func (o *TokenGrantV3Forbidden) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantV3Forbidden) ToJSONString added in v0.25.0 

func (o *TokenGrantV3Forbidden) ToJSONString() string

type TokenGrantV3OK 

type TokenGrantV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenWithDeviceCookieResponseV3
}

TokenGrantV3OK handles this case with default header values. 

Token returned

func NewTokenGrantV3OK 

func NewTokenGrantV3OK() *TokenGrantV3OK

NewTokenGrantV3OK creates a TokenGrantV3OK with default headers values

func (*TokenGrantV3OK) Error 

func (o *TokenGrantV3OK) Error() string

func (*TokenGrantV3OK) GetPayload 

func (o *TokenGrantV3OK) GetPayload() *iamclientmodels.OauthmodelTokenWithDeviceCookieResponseV3

func (*TokenGrantV3OK) ToJSONString added in v0.25.0 

func (o *TokenGrantV3OK) ToJSONString() string

type TokenGrantV3Params 

type TokenGrantV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*AuthTrustID
	  Auth-Trust-Id for Device Cookie Validation (Used on grant type 'password')

	*/
	AuthTrustID *string
	/*DeviceID
	  DeviceID (Used on grant type 'password' to track login history) ex. 90252d14544846d79f367148e3f9a3d9

	*/
	DeviceID *string
	/*AdditionalData
	  Additional info, it will be passed to login success event.

	*/
	AdditionalData *string
	/*ClientID
	  client_id (used with grant type 'authorization_code')

	*/
	ClientID *string
	/*Code
	  The authorization code received from the authorization server (used with grant type 'authorization_code')

	*/
	Code *string
	/*CodeVerifier
	  Code verifier received from the authorization server

	*/
	CodeVerifier *string
	/*ExtendNamespace
	  extend namespace, Used on grant type 'urn:ietf:params:oauth:grant-type:extend_client_credentials'.

	*/
	ExtendNamespace *string
	/*ExtendExp
	  Extend expiration date of refresh token. Only available for grant type 'password'

	*/
	ExtendExp *bool
	/*Password
	  Password (used with grant type 'password'

	*/
	Password *string
	/*RedirectURI
	  Redirect URI (used with grant type 'authorization_code')

	*/
	RedirectURI *string
	/*RefreshToken
	  Refresh Token (used with grant type 'refresh_token'). This field is optional if the request header provides the "refresh_token" cookie

	*/
	RefreshToken *string
	/*Username
	  User Name (used with grant type 'password'

	*/
	Username *string
	/*GrantType
	  Grant Type

	*/
	GrantType string

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

TokenGrantV3Params contains all the parameters to send to the API endpoint for the token grant v3 operation typically these are written to a http.Request

func NewTokenGrantV3Params 

func NewTokenGrantV3Params() *TokenGrantV3Params

NewTokenGrantV3Params creates a new TokenGrantV3Params object with the default values initialized.

func NewTokenGrantV3ParamsWithContext 

func NewTokenGrantV3ParamsWithContext(ctx context.Context) *TokenGrantV3Params

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

func NewTokenGrantV3ParamsWithHTTPClient 

func NewTokenGrantV3ParamsWithHTTPClient(client *http.Client) *TokenGrantV3Params

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

func NewTokenGrantV3ParamsWithTimeout 

func NewTokenGrantV3ParamsWithTimeout(timeout time.Duration) *TokenGrantV3Params

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

func (*TokenGrantV3Params) SetAdditionalData added in v0.48.0 

func (o *TokenGrantV3Params) SetAdditionalData(additionalData *string)

SetAdditionalData adds the additionalData to the token grant v3 params

func (*TokenGrantV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *TokenGrantV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the token grant v3 params

func (*TokenGrantV3Params) SetAuthTrustID added in v0.29.0 

func (o *TokenGrantV3Params) SetAuthTrustID(authTrustID *string)

SetAuthTrustID adds the authTrustId to the token grant v3 params

func (*TokenGrantV3Params) SetClientID 

func (o *TokenGrantV3Params) SetClientID(clientID *string)

SetClientID adds the clientId to the token grant v3 params

func (*TokenGrantV3Params) SetCode 

func (o *TokenGrantV3Params) SetCode(code *string)

SetCode adds the code to the token grant v3 params

func (*TokenGrantV3Params) SetCodeVerifier 

func (o *TokenGrantV3Params) SetCodeVerifier(codeVerifier *string)

SetCodeVerifier adds the codeVerifier to the token grant v3 params

func (*TokenGrantV3Params) SetContext 

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

SetContext adds the context to the token grant v3 params

func (*TokenGrantV3Params) SetDeviceID 

func (o *TokenGrantV3Params) SetDeviceID(deviceID *string)

SetDeviceID adds the deviceId to the token grant v3 params

func (*TokenGrantV3Params) SetExtendExp added in v0.12.0 

func (o *TokenGrantV3Params) SetExtendExp(extendExp *bool)

SetExtendExp adds the extendExp to the token grant v3 params

func (*TokenGrantV3Params) SetExtendNamespace added in v0.59.0 

func (o *TokenGrantV3Params) SetExtendNamespace(extendNamespace *string)

SetExtendNamespace adds the extendNamespace to the token grant v3 params

func (*TokenGrantV3Params) SetGrantType 

func (o *TokenGrantV3Params) SetGrantType(grantType string)

SetGrantType adds the grantType to the token grant v3 params

func (*TokenGrantV3Params) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the token grant v3 params

func (*TokenGrantV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *TokenGrantV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the token grant v3 params

func (*TokenGrantV3Params) SetPassword added in v0.12.0 

func (o *TokenGrantV3Params) SetPassword(password *string)

SetPassword adds the password to the token grant v3 params

func (*TokenGrantV3Params) SetRedirectURI 

func (o *TokenGrantV3Params) SetRedirectURI(redirectURI *string)

SetRedirectURI adds the redirectUri to the token grant v3 params

func (*TokenGrantV3Params) SetRefreshToken 

func (o *TokenGrantV3Params) SetRefreshToken(refreshToken *string)

SetRefreshToken adds the refreshToken to the token grant v3 params

func (*TokenGrantV3Params) SetTimeout 

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

SetTimeout adds the timeout to the token grant v3 params

func (*TokenGrantV3Params) SetUsername added in v0.12.0 

func (o *TokenGrantV3Params) SetUsername(username *string)

SetUsername adds the username to the token grant v3 params

func (*TokenGrantV3Params) WithAdditionalData added in v0.48.0 

func (o *TokenGrantV3Params) WithAdditionalData(additionalData *string) *TokenGrantV3Params

WithAdditionalData adds the additionalData to the token grant v3 params

func (*TokenGrantV3Params) WithAuthTrustID added in v0.29.0 

func (o *TokenGrantV3Params) WithAuthTrustID(authTrustID *string) *TokenGrantV3Params

WithAuthTrustID adds the authTrustID to the token grant v3 params

func (*TokenGrantV3Params) WithClientID 

func (o *TokenGrantV3Params) WithClientID(clientID *string) *TokenGrantV3Params

WithClientID adds the clientID to the token grant v3 params

func (*TokenGrantV3Params) WithCode 

func (o *TokenGrantV3Params) WithCode(code *string) *TokenGrantV3Params

WithCode adds the code to the token grant v3 params

func (*TokenGrantV3Params) WithCodeVerifier 

func (o *TokenGrantV3Params) WithCodeVerifier(codeVerifier *string) *TokenGrantV3Params

WithCodeVerifier adds the codeVerifier to the token grant v3 params

func (*TokenGrantV3Params) WithContext 

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

WithContext adds the context to the token grant v3 params

func (*TokenGrantV3Params) WithDeviceID 

func (o *TokenGrantV3Params) WithDeviceID(deviceID *string) *TokenGrantV3Params

WithDeviceID adds the deviceID to the token grant v3 params

func (*TokenGrantV3Params) WithExtendExp added in v0.12.0 

func (o *TokenGrantV3Params) WithExtendExp(extendExp *bool) *TokenGrantV3Params

WithExtendExp adds the extendExp to the token grant v3 params

func (*TokenGrantV3Params) WithExtendNamespace added in v0.59.0 

func (o *TokenGrantV3Params) WithExtendNamespace(extendNamespace *string) *TokenGrantV3Params

WithExtendNamespace adds the extendNamespace to the token grant v3 params

func (*TokenGrantV3Params) WithGrantType 

func (o *TokenGrantV3Params) WithGrantType(grantType string) *TokenGrantV3Params

WithGrantType adds the grantType to the token grant v3 params

func (*TokenGrantV3Params) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the token grant v3 params

func (*TokenGrantV3Params) WithPassword added in v0.12.0 

func (o *TokenGrantV3Params) WithPassword(password *string) *TokenGrantV3Params

WithPassword adds the password to the token grant v3 params

func (*TokenGrantV3Params) WithRedirectURI 

func (o *TokenGrantV3Params) WithRedirectURI(redirectURI *string) *TokenGrantV3Params

WithRedirectURI adds the redirectURI to the token grant v3 params

func (*TokenGrantV3Params) WithRefreshToken 

func (o *TokenGrantV3Params) WithRefreshToken(refreshToken *string) *TokenGrantV3Params

WithRefreshToken adds the refreshToken to the token grant v3 params

func (*TokenGrantV3Params) WithTimeout 

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

WithTimeout adds the timeout to the token grant v3 params

func (*TokenGrantV3Params) WithUsername added in v0.12.0 

func (o *TokenGrantV3Params) WithUsername(username *string) *TokenGrantV3Params

WithUsername adds the username to the token grant v3 params

func (*TokenGrantV3Params) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type TokenGrantV3Reader 

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

TokenGrantV3Reader is a Reader for the TokenGrantV3 structure.

func (*TokenGrantV3Reader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type TokenGrantV3TooManyRequests added in v0.29.0 

type TokenGrantV3TooManyRequests struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV3TooManyRequests handles this case with default header values. 

Too many failed auth attempt

func NewTokenGrantV3TooManyRequests added in v0.29.0 

func NewTokenGrantV3TooManyRequests() *TokenGrantV3TooManyRequests

NewTokenGrantV3TooManyRequests creates a TokenGrantV3TooManyRequests with default headers values

func (*TokenGrantV3TooManyRequests) Error added in v0.29.0 

func (o *TokenGrantV3TooManyRequests) Error() string

func (*TokenGrantV3TooManyRequests) GetPayload added in v0.29.0 

func (o *TokenGrantV3TooManyRequests) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantV3TooManyRequests) ToJSONString added in v0.29.0 

func (o *TokenGrantV3TooManyRequests) ToJSONString() string

type TokenGrantV3Unauthorized 

type TokenGrantV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV3Unauthorized handles this case with default header values. 

Client authentication failed

func NewTokenGrantV3Unauthorized 

func NewTokenGrantV3Unauthorized() *TokenGrantV3Unauthorized

NewTokenGrantV3Unauthorized creates a TokenGrantV3Unauthorized with default headers values

func (*TokenGrantV3Unauthorized) Error 

func (o *TokenGrantV3Unauthorized) Error() string

func (*TokenGrantV3Unauthorized) GetPayload 

func (o *TokenGrantV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantV3Unauthorized) ToJSONString added in v0.25.0 

func (o *TokenGrantV3Unauthorized) ToJSONString() string

type TokenIntrospectionV3BadRequest added in v0.2.0 

type TokenIntrospectionV3BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenIntrospectionV3BadRequest handles this case with default header values. 

invalid input

func NewTokenIntrospectionV3BadRequest added in v0.2.0 

func NewTokenIntrospectionV3BadRequest() *TokenIntrospectionV3BadRequest

NewTokenIntrospectionV3BadRequest creates a TokenIntrospectionV3BadRequest with default headers values

func (*TokenIntrospectionV3BadRequest) Error added in v0.2.0 

func (o *TokenIntrospectionV3BadRequest) Error() string

func (*TokenIntrospectionV3BadRequest) GetPayload added in v0.2.0 

func (o *TokenIntrospectionV3BadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenIntrospectionV3BadRequest) ToJSONString added in v0.25.0 

func (o *TokenIntrospectionV3BadRequest) ToJSONString() string

type TokenIntrospectionV3OK added in v0.2.0 

type TokenIntrospectionV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenIntrospectResponse
}

TokenIntrospectionV3OK handles this case with default header values. 

OK

func NewTokenIntrospectionV3OK added in v0.2.0 

func NewTokenIntrospectionV3OK() *TokenIntrospectionV3OK

NewTokenIntrospectionV3OK creates a TokenIntrospectionV3OK with default headers values

func (*TokenIntrospectionV3OK) Error added in v0.2.0 

func (o *TokenIntrospectionV3OK) Error() string

func (*TokenIntrospectionV3OK) GetPayload added in v0.2.0 

func (o *TokenIntrospectionV3OK) GetPayload() *iamclientmodels.OauthmodelTokenIntrospectResponse

func (*TokenIntrospectionV3OK) ToJSONString added in v0.25.0 

func (o *TokenIntrospectionV3OK) ToJSONString() string

type TokenIntrospectionV3Params added in v0.2.0 

type TokenIntrospectionV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Token
	  Access Token / Refresh Token

	*/
	Token string

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

TokenIntrospectionV3Params contains all the parameters to send to the API endpoint for the token introspection v3 operation typically these are written to a http.Request

func NewTokenIntrospectionV3Params added in v0.2.0 

func NewTokenIntrospectionV3Params() *TokenIntrospectionV3Params

NewTokenIntrospectionV3Params creates a new TokenIntrospectionV3Params object with the default values initialized.

func NewTokenIntrospectionV3ParamsWithContext added in v0.2.0 

func NewTokenIntrospectionV3ParamsWithContext(ctx context.Context) *TokenIntrospectionV3Params

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

func NewTokenIntrospectionV3ParamsWithHTTPClient added in v0.2.0 

func NewTokenIntrospectionV3ParamsWithHTTPClient(client *http.Client) *TokenIntrospectionV3Params

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

func NewTokenIntrospectionV3ParamsWithTimeout added in v0.2.0 

func NewTokenIntrospectionV3ParamsWithTimeout(timeout time.Duration) *TokenIntrospectionV3Params

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

func (*TokenIntrospectionV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *TokenIntrospectionV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the token introspection v3 params

func (*TokenIntrospectionV3Params) SetContext added in v0.2.0 

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

SetContext adds the context to the token introspection v3 params

func (*TokenIntrospectionV3Params) SetHTTPClient added in v0.2.0 

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

SetHTTPClient adds the HTTPClient to the token introspection v3 params

func (*TokenIntrospectionV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *TokenIntrospectionV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the token introspection v3 params

func (*TokenIntrospectionV3Params) SetTimeout added in v0.2.0 

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

SetTimeout adds the timeout to the token introspection v3 params

func (*TokenIntrospectionV3Params) SetToken added in v0.2.0 

func (o *TokenIntrospectionV3Params) SetToken(token string)

SetToken adds the token to the token introspection v3 params

func (*TokenIntrospectionV3Params) WithContext added in v0.2.0 

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

WithContext adds the context to the token introspection v3 params

func (*TokenIntrospectionV3Params) WithHTTPClient added in v0.2.0 

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

WithHTTPClient adds the HTTPClient to the token introspection v3 params

func (*TokenIntrospectionV3Params) WithTimeout added in v0.2.0 

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

WithTimeout adds the timeout to the token introspection v3 params

func (*TokenIntrospectionV3Params) WithToken added in v0.2.0 

func (o *TokenIntrospectionV3Params) WithToken(token string) *TokenIntrospectionV3Params

WithToken adds the token to the token introspection v3 params

func (*TokenIntrospectionV3Params) WriteToRequest added in v0.2.0 

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

WriteToRequest writes these params to a swagger request

type TokenIntrospectionV3Reader added in v0.2.0 

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

TokenIntrospectionV3Reader is a Reader for the TokenIntrospectionV3 structure.

func (*TokenIntrospectionV3Reader) ReadResponse added in v0.2.0 

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

ReadResponse reads a server response into the received o.

type TokenIntrospectionV3Unauthorized added in v0.2.0 

type TokenIntrospectionV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenIntrospectionV3Unauthorized handles this case with default header values. 

invalid bearer or basic authorization header

func NewTokenIntrospectionV3Unauthorized added in v0.2.0 

func NewTokenIntrospectionV3Unauthorized() *TokenIntrospectionV3Unauthorized

NewTokenIntrospectionV3Unauthorized creates a TokenIntrospectionV3Unauthorized with default headers values

func (*TokenIntrospectionV3Unauthorized) Error added in v0.2.0 

func (o *TokenIntrospectionV3Unauthorized) Error() string

func (*TokenIntrospectionV3Unauthorized) GetPayload added in v0.2.0 

func (o *TokenIntrospectionV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenIntrospectionV3Unauthorized) ToJSONString added in v0.25.0 

func (o *TokenIntrospectionV3Unauthorized) ToJSONString() string

type TokenRevocationV3BadRequest 

type TokenRevocationV3BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenRevocationV3BadRequest handles this case with default header values. 

Invalid input

func NewTokenRevocationV3BadRequest 

func NewTokenRevocationV3BadRequest() *TokenRevocationV3BadRequest

NewTokenRevocationV3BadRequest creates a TokenRevocationV3BadRequest with default headers values

func (*TokenRevocationV3BadRequest) Error 

func (o *TokenRevocationV3BadRequest) Error() string

func (*TokenRevocationV3BadRequest) GetPayload 

func (o *TokenRevocationV3BadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenRevocationV3BadRequest) ToJSONString added in v0.25.0 

func (o *TokenRevocationV3BadRequest) ToJSONString() string

type TokenRevocationV3OK 

type TokenRevocationV3OK struct {
}

TokenRevocationV3OK handles this case with default header values. 

Token revoked or does not exist

func NewTokenRevocationV3OK 

func NewTokenRevocationV3OK() *TokenRevocationV3OK

NewTokenRevocationV3OK creates a TokenRevocationV3OK with default headers values

func (*TokenRevocationV3OK) Error 

func (o *TokenRevocationV3OK) Error() string

type TokenRevocationV3Params 

type TokenRevocationV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Token
	  Access token / Refresh token

	*/
	Token string

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

TokenRevocationV3Params contains all the parameters to send to the API endpoint for the token revocation v3 operation typically these are written to a http.Request

func NewTokenRevocationV3Params 

func NewTokenRevocationV3Params() *TokenRevocationV3Params

NewTokenRevocationV3Params creates a new TokenRevocationV3Params object with the default values initialized.

func NewTokenRevocationV3ParamsWithContext 

func NewTokenRevocationV3ParamsWithContext(ctx context.Context) *TokenRevocationV3Params

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

func NewTokenRevocationV3ParamsWithHTTPClient 

func NewTokenRevocationV3ParamsWithHTTPClient(client *http.Client) *TokenRevocationV3Params

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

func NewTokenRevocationV3ParamsWithTimeout 

func NewTokenRevocationV3ParamsWithTimeout(timeout time.Duration) *TokenRevocationV3Params

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

func (*TokenRevocationV3Params) SetAuthInfoWriter added in v0.17.0 

func (o *TokenRevocationV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the token revocation v3 params

func (*TokenRevocationV3Params) SetContext 

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

SetContext adds the context to the token revocation v3 params

func (*TokenRevocationV3Params) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the token revocation v3 params

func (*TokenRevocationV3Params) SetHTTPClientTransport added in v0.19.0 

func (o *TokenRevocationV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the token revocation v3 params

func (*TokenRevocationV3Params) SetTimeout 

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

SetTimeout adds the timeout to the token revocation v3 params

func (*TokenRevocationV3Params) SetToken 

func (o *TokenRevocationV3Params) SetToken(token string)

SetToken adds the token to the token revocation v3 params

func (*TokenRevocationV3Params) WithContext 

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

WithContext adds the context to the token revocation v3 params

func (*TokenRevocationV3Params) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the token revocation v3 params

func (*TokenRevocationV3Params) WithTimeout 

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

WithTimeout adds the timeout to the token revocation v3 params

func (*TokenRevocationV3Params) WithToken 

func (o *TokenRevocationV3Params) WithToken(token string) *TokenRevocationV3Params

WithToken adds the token to the token revocation v3 params

func (*TokenRevocationV3Params) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type TokenRevocationV3Reader 

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

TokenRevocationV3Reader is a Reader for the TokenRevocationV3 structure.

func (*TokenRevocationV3Reader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type TokenRevocationV3Unauthorized 

type TokenRevocationV3Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenRevocationV3Unauthorized handles this case with default header values. 

Invalid basic auth header

func NewTokenRevocationV3Unauthorized 

func NewTokenRevocationV3Unauthorized() *TokenRevocationV3Unauthorized

NewTokenRevocationV3Unauthorized creates a TokenRevocationV3Unauthorized with default headers values

func (*TokenRevocationV3Unauthorized) Error 

func (o *TokenRevocationV3Unauthorized) Error() string

func (*TokenRevocationV3Unauthorized) GetPayload 

func (o *TokenRevocationV3Unauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenRevocationV3Unauthorized) ToJSONString added in v0.25.0 

func (o *TokenRevocationV3Unauthorized) ToJSONString() string

type Verify2FACodeOK added in v0.15.0 

type Verify2FACodeOK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

Verify2FACodeOK handles this case with default header values. 

Token returned

func NewVerify2FACodeOK added in v0.15.0 

func NewVerify2FACodeOK() *Verify2FACodeOK

NewVerify2FACodeOK creates a Verify2FACodeOK with default headers values

func (*Verify2FACodeOK) Error added in v0.15.0 

func (o *Verify2FACodeOK) Error() string

func (*Verify2FACodeOK) GetPayload added in v0.15.0 

func (o *Verify2FACodeOK) GetPayload() *iamclientmodels.OauthmodelTokenResponseV3

func (*Verify2FACodeOK) ToJSONString added in v0.25.0 

func (o *Verify2FACodeOK) ToJSONString() string

type Verify2FACodeParams added in v0.15.0 

type Verify2FACodeParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Code
	  code

	*/
	Code string
	/*Factor
	  factor

	*/
	Factor string
	/*MFAToken
	  mfa token

	*/
	MFAToken string
	/*RememberDevice
	  remember device

	*/
	RememberDevice bool

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

Verify2FACodeParams contains all the parameters to send to the API endpoint for the verify2fa code operation typically these are written to a http.Request

func NewVerify2FACodeParams added in v0.15.0 

func NewVerify2FACodeParams() *Verify2FACodeParams

NewVerify2FACodeParams creates a new Verify2FACodeParams object with the default values initialized.

func NewVerify2FACodeParamsWithContext added in v0.15.0 

func NewVerify2FACodeParamsWithContext(ctx context.Context) *Verify2FACodeParams

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

func NewVerify2FACodeParamsWithHTTPClient added in v0.15.0 

func NewVerify2FACodeParamsWithHTTPClient(client *http.Client) *Verify2FACodeParams

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

func NewVerify2FACodeParamsWithTimeout added in v0.15.0 

func NewVerify2FACodeParamsWithTimeout(timeout time.Duration) *Verify2FACodeParams

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

func (*Verify2FACodeParams) SetAuthInfoWriter added in v0.17.0 

func (o *Verify2FACodeParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the verify2fa code params

func (*Verify2FACodeParams) SetCode added in v0.15.0 

func (o *Verify2FACodeParams) SetCode(code string)

SetCode adds the code to the verify2fa code params

func (*Verify2FACodeParams) SetContext added in v0.15.0 

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

SetContext adds the context to the verify2fa code params

func (*Verify2FACodeParams) SetFactor added in v0.15.0 

func (o *Verify2FACodeParams) SetFactor(factor string)

SetFactor adds the factor to the verify2fa code params

func (*Verify2FACodeParams) SetHTTPClient added in v0.15.0 

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

SetHTTPClient adds the HTTPClient to the verify2fa code params

func (*Verify2FACodeParams) SetHTTPClientTransport added in v0.19.0 

func (o *Verify2FACodeParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the verify2fa code params

func (*Verify2FACodeParams) SetMFAToken added in v0.39.0 

func (o *Verify2FACodeParams) SetMFAToken(mFAToken string)

SetMFAToken adds the mfaToken to the verify2fa code params

func (*Verify2FACodeParams) SetRememberDevice added in v0.15.0 

func (o *Verify2FACodeParams) SetRememberDevice(rememberDevice bool)

SetRememberDevice adds the rememberDevice to the verify2fa code params

func (*Verify2FACodeParams) SetTimeout added in v0.15.0 

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

SetTimeout adds the timeout to the verify2fa code params

func (*Verify2FACodeParams) WithCode added in v0.15.0 

func (o *Verify2FACodeParams) WithCode(code string) *Verify2FACodeParams

WithCode adds the code to the verify2fa code params

func (*Verify2FACodeParams) WithContext added in v0.15.0 

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

WithContext adds the context to the verify2fa code params

func (*Verify2FACodeParams) WithFactor added in v0.15.0 

func (o *Verify2FACodeParams) WithFactor(factor string) *Verify2FACodeParams

WithFactor adds the factor to the verify2fa code params

func (*Verify2FACodeParams) WithHTTPClient added in v0.15.0 

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

WithHTTPClient adds the HTTPClient to the verify2fa code params

func (*Verify2FACodeParams) WithMFAToken added in v0.39.0 

func (o *Verify2FACodeParams) WithMFAToken(mFAToken string) *Verify2FACodeParams

WithMFAToken adds the mFAToken to the verify2fa code params

func (*Verify2FACodeParams) WithRememberDevice added in v0.15.0 

func (o *Verify2FACodeParams) WithRememberDevice(rememberDevice bool) *Verify2FACodeParams

WithRememberDevice adds the rememberDevice to the verify2fa code params

func (*Verify2FACodeParams) WithTimeout added in v0.15.0 

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

WithTimeout adds the timeout to the verify2fa code params

func (*Verify2FACodeParams) WriteToRequest added in v0.15.0 

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

WriteToRequest writes these params to a swagger request

type Verify2FACodeReader added in v0.15.0 

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

Verify2FACodeReader is a Reader for the Verify2FACode structure.

func (*Verify2FACodeReader) ReadResponse added in v0.15.0 

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

ReadResponse reads a server response into the received o.

type Verify2FACodeUnauthorized added in v0.15.0 

type Verify2FACodeUnauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

Verify2FACodeUnauthorized handles this case with default header values. 

Unauthorized

func NewVerify2FACodeUnauthorized added in v0.15.0 

func NewVerify2FACodeUnauthorized() *Verify2FACodeUnauthorized

NewVerify2FACodeUnauthorized creates a Verify2FACodeUnauthorized with default headers values

func (*Verify2FACodeUnauthorized) Error added in v0.15.0 

func (o *Verify2FACodeUnauthorized) Error() string

func (*Verify2FACodeUnauthorized) GetPayload added in v0.15.0 

func (o *Verify2FACodeUnauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*Verify2FACodeUnauthorized) ToJSONString added in v0.25.0 

func (o *Verify2FACodeUnauthorized) ToJSONString() string

type VerifyTokenV3BadRequest added in v0.24.0 

type VerifyTokenV3BadRequest struct {
}

VerifyTokenV3BadRequest handles this case with default header values. 

Access Token not exist or expired

func NewVerifyTokenV3BadRequest added in v0.24.0 

func NewVerifyTokenV3BadRequest() *VerifyTokenV3BadRequest

NewVerifyTokenV3BadRequest creates a VerifyTokenV3BadRequest with default headers values

func (*VerifyTokenV3BadRequest) Error added in v0.24.0 

func (o *VerifyTokenV3BadRequest) Error() string

type VerifyTokenV3OK added in v0.24.0 

type VerifyTokenV3OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

VerifyTokenV3OK handles this case with default header values. 

Access Token verified

func NewVerifyTokenV3OK added in v0.24.0 

func NewVerifyTokenV3OK() *VerifyTokenV3OK

NewVerifyTokenV3OK creates a VerifyTokenV3OK with default headers values

func (*VerifyTokenV3OK) Error added in v0.24.0 

func (o *VerifyTokenV3OK) Error() string

func (*VerifyTokenV3OK) GetPayload added in v0.24.0 

func (o *VerifyTokenV3OK) GetPayload() *iamclientmodels.OauthmodelTokenResponseV3

func (*VerifyTokenV3OK) ToJSONString added in v0.25.0 

func (o *VerifyTokenV3OK) ToJSONString() string

type VerifyTokenV3Params added in v0.24.0 

type VerifyTokenV3Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Token
	  Token to be verified

	*/
	Token string

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

VerifyTokenV3Params contains all the parameters to send to the API endpoint for the verify token v3 operation typically these are written to a http.Request

func NewVerifyTokenV3Params added in v0.24.0 

func NewVerifyTokenV3Params() *VerifyTokenV3Params

NewVerifyTokenV3Params creates a new VerifyTokenV3Params object with the default values initialized.

func NewVerifyTokenV3ParamsWithContext added in v0.24.0 

func NewVerifyTokenV3ParamsWithContext(ctx context.Context) *VerifyTokenV3Params

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

func NewVerifyTokenV3ParamsWithHTTPClient added in v0.24.0 

func NewVerifyTokenV3ParamsWithHTTPClient(client *http.Client) *VerifyTokenV3Params

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

func NewVerifyTokenV3ParamsWithTimeout added in v0.24.0 

func NewVerifyTokenV3ParamsWithTimeout(timeout time.Duration) *VerifyTokenV3Params

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

func (*VerifyTokenV3Params) SetAuthInfoWriter added in v0.24.0 

func (o *VerifyTokenV3Params) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the verify token v3 params

func (*VerifyTokenV3Params) SetContext added in v0.24.0 

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

SetContext adds the context to the verify token v3 params

func (*VerifyTokenV3Params) SetHTTPClient added in v0.24.0 

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

SetHTTPClient adds the HTTPClient to the verify token v3 params

func (*VerifyTokenV3Params) SetHTTPClientTransport added in v0.24.0 

func (o *VerifyTokenV3Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the verify token v3 params

func (*VerifyTokenV3Params) SetTimeout added in v0.24.0 

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

SetTimeout adds the timeout to the verify token v3 params

func (*VerifyTokenV3Params) SetToken added in v0.24.0 

func (o *VerifyTokenV3Params) SetToken(token string)

SetToken adds the token to the verify token v3 params

func (*VerifyTokenV3Params) WithContext added in v0.24.0 

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

WithContext adds the context to the verify token v3 params

func (*VerifyTokenV3Params) WithHTTPClient added in v0.24.0 

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

WithHTTPClient adds the HTTPClient to the verify token v3 params

func (*VerifyTokenV3Params) WithTimeout added in v0.24.0 

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

WithTimeout adds the timeout to the verify token v3 params

func (*VerifyTokenV3Params) WithToken added in v0.24.0 

func (o *VerifyTokenV3Params) WithToken(token string) *VerifyTokenV3Params

WithToken adds the token to the verify token v3 params

func (*VerifyTokenV3Params) WriteToRequest added in v0.24.0 

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

WriteToRequest writes these params to a swagger request

type VerifyTokenV3Reader added in v0.24.0 

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

VerifyTokenV3Reader is a Reader for the VerifyTokenV3 structure.

func (*VerifyTokenV3Reader) ReadResponse added in v0.24.0 

func (o *VerifyTokenV3Reader) 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.