o_auth2_0_v4

package
v0.75.0 Latest Latest
Warning

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

Go to latest
Published: Nov 22, 2024 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PlatformTokenGrantV4S256Constant  = "S256"
	PlatformTokenGrantV4PlainConstant = "plain"
)

Get the enum in PlatformTokenGrantV4Params

View Source
const (
	SimultaneousLoginV4EpicgamesConstant = "epicgames"
	SimultaneousLoginV4SteamConstant     = "steam"
)

Get the enum in SimultaneousLoginV4Params

View Source
const (
	SimultaneousLoginV4S256Constant  = "S256"
	SimultaneousLoginV4PlainConstant = "plain"
)

Get the enum in SimultaneousLoginV4Params

View Source
const (
	TokenGrantV4AuthorizationCodeConstant                                  = "authorization_code"
	TokenGrantV4ClientCredentialsConstant                                  = "client_credentials"
	TokenGrantV4PasswordConstant                                           = "password"
	TokenGrantV4RefreshTokenConstant                                       = "refresh_token"
	TokenGrantV4UrnIetfParamsOauthGrantTypeExtendClientCredentialsConstant = "urn:ietf:params:oauth:grant-type:extend_client_credentials"
	TokenGrantV4UrnIetfParamsOauthGrantTypeLoginQueueTicketConstant        = "urn:ietf:params:oauth:grant-type:login_queue_ticket"
)

Get the enum in TokenGrantV4Params

View Source
const (
	TokenGrantV4S256Constant  = "S256"
	TokenGrantV4PlainConstant = "plain"
)

Get the enum in TokenGrantV4Params

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationWithPlatformLinkV4Accepted

type AuthenticationWithPlatformLinkV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

AuthenticationWithPlatformLinkV4Accepted handles this case with default header values.

Login queue ticket returned

func NewAuthenticationWithPlatformLinkV4Accepted

func NewAuthenticationWithPlatformLinkV4Accepted() *AuthenticationWithPlatformLinkV4Accepted

NewAuthenticationWithPlatformLinkV4Accepted creates a AuthenticationWithPlatformLinkV4Accepted with default headers values

func (*AuthenticationWithPlatformLinkV4Accepted) Error

func (*AuthenticationWithPlatformLinkV4Accepted) GetPayload

func (*AuthenticationWithPlatformLinkV4Accepted) ToJSONString

type AuthenticationWithPlatformLinkV4BadRequest

type AuthenticationWithPlatformLinkV4BadRequest struct {
	Payload *iamclientmodels.RestErrorResponse
}

AuthenticationWithPlatformLinkV4BadRequest handles this case with default header values.

Invalid username or password.

func NewAuthenticationWithPlatformLinkV4BadRequest

func NewAuthenticationWithPlatformLinkV4BadRequest() *AuthenticationWithPlatformLinkV4BadRequest

NewAuthenticationWithPlatformLinkV4BadRequest creates a AuthenticationWithPlatformLinkV4BadRequest with default headers values

func (*AuthenticationWithPlatformLinkV4BadRequest) Error

func (*AuthenticationWithPlatformLinkV4BadRequest) GetPayload

func (*AuthenticationWithPlatformLinkV4BadRequest) ToJSONString

type AuthenticationWithPlatformLinkV4Conflict

type AuthenticationWithPlatformLinkV4Conflict struct {
	Payload *iamclientmodels.RestErrorResponse
}

AuthenticationWithPlatformLinkV4Conflict handles this case with default header values.

User already link this platform's another account'.

func NewAuthenticationWithPlatformLinkV4Conflict

func NewAuthenticationWithPlatformLinkV4Conflict() *AuthenticationWithPlatformLinkV4Conflict

NewAuthenticationWithPlatformLinkV4Conflict creates a AuthenticationWithPlatformLinkV4Conflict with default headers values

func (*AuthenticationWithPlatformLinkV4Conflict) Error

func (*AuthenticationWithPlatformLinkV4Conflict) GetPayload

func (*AuthenticationWithPlatformLinkV4Conflict) ToJSONString

type AuthenticationWithPlatformLinkV4Forbidden

type AuthenticationWithPlatformLinkV4Forbidden struct {
	Payload *iamclientmodels.RestErrorResponse
}

AuthenticationWithPlatformLinkV4Forbidden handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>10213</td><td>country is blocked</td></tr></table>

func NewAuthenticationWithPlatformLinkV4Forbidden

func NewAuthenticationWithPlatformLinkV4Forbidden() *AuthenticationWithPlatformLinkV4Forbidden

NewAuthenticationWithPlatformLinkV4Forbidden creates a AuthenticationWithPlatformLinkV4Forbidden with default headers values

func (*AuthenticationWithPlatformLinkV4Forbidden) Error

func (*AuthenticationWithPlatformLinkV4Forbidden) GetPayload

func (*AuthenticationWithPlatformLinkV4Forbidden) ToJSONString

type AuthenticationWithPlatformLinkV4OK

type AuthenticationWithPlatformLinkV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

AuthenticationWithPlatformLinkV4OK handles this case with default header values.

Succeed to authenticate and link platform account.

func NewAuthenticationWithPlatformLinkV4OK

func NewAuthenticationWithPlatformLinkV4OK() *AuthenticationWithPlatformLinkV4OK

NewAuthenticationWithPlatformLinkV4OK creates a AuthenticationWithPlatformLinkV4OK with default headers values

func (*AuthenticationWithPlatformLinkV4OK) Error

func (*AuthenticationWithPlatformLinkV4OK) GetPayload

func (*AuthenticationWithPlatformLinkV4OK) ToJSONString

func (o *AuthenticationWithPlatformLinkV4OK) ToJSONString() string

type AuthenticationWithPlatformLinkV4Params

type AuthenticationWithPlatformLinkV4Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*ExtendExp
	  Extend expiration date of refresh token

	*/
	ExtendExp *bool
	/*ClientID
	  Client ID

	*/
	ClientID string
	/*LinkingToken
	  Platform linking Token

	*/
	LinkingToken string
	/*Password
	  Account password

	*/
	Password string
	/*Username
	  Account username

	*/
	Username string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

AuthenticationWithPlatformLinkV4Params contains all the parameters to send to the API endpoint for the authentication with platform link v4 operation typically these are written to a http.Request

func NewAuthenticationWithPlatformLinkV4Params

func NewAuthenticationWithPlatformLinkV4Params() *AuthenticationWithPlatformLinkV4Params

NewAuthenticationWithPlatformLinkV4Params creates a new AuthenticationWithPlatformLinkV4Params object with the default values initialized.

func NewAuthenticationWithPlatformLinkV4ParamsWithContext

func NewAuthenticationWithPlatformLinkV4ParamsWithContext(ctx context.Context) *AuthenticationWithPlatformLinkV4Params

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

func NewAuthenticationWithPlatformLinkV4ParamsWithHTTPClient

func NewAuthenticationWithPlatformLinkV4ParamsWithHTTPClient(client *http.Client) *AuthenticationWithPlatformLinkV4Params

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

func NewAuthenticationWithPlatformLinkV4ParamsWithTimeout

func NewAuthenticationWithPlatformLinkV4ParamsWithTimeout(timeout time.Duration) *AuthenticationWithPlatformLinkV4Params

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

func (*AuthenticationWithPlatformLinkV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetClientID

func (o *AuthenticationWithPlatformLinkV4Params) SetClientID(clientID string)

SetClientID adds the clientId to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetContext

SetContext adds the context to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetExtendExp

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

SetExtendExp adds the extendExp to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetFlightId

func (o *AuthenticationWithPlatformLinkV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*AuthenticationWithPlatformLinkV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetLinkingToken

func (o *AuthenticationWithPlatformLinkV4Params) SetLinkingToken(linkingToken string)

SetLinkingToken adds the linkingToken to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetPassword

func (o *AuthenticationWithPlatformLinkV4Params) SetPassword(password string)

SetPassword adds the password to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetTimeout

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

SetTimeout adds the timeout to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) SetUsername

func (o *AuthenticationWithPlatformLinkV4Params) SetUsername(username string)

SetUsername adds the username to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithClientID

WithClientID adds the clientID to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithContext

WithContext adds the context to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithExtendExp

WithExtendExp adds the extendExp to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithLinkingToken

WithLinkingToken adds the linkingToken to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithPassword

WithPassword adds the password to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithTimeout

WithTimeout adds the timeout to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WithUsername

WithUsername adds the username to the authentication with platform link v4 params

func (*AuthenticationWithPlatformLinkV4Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type AuthenticationWithPlatformLinkV4Reader

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

AuthenticationWithPlatformLinkV4Reader is a Reader for the AuthenticationWithPlatformLinkV4 structure.

func (*AuthenticationWithPlatformLinkV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type AuthenticationWithPlatformLinkV4Unauthorized

type AuthenticationWithPlatformLinkV4Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

AuthenticationWithPlatformLinkV4Unauthorized handles this case with default header values.

Need 2FA.

func NewAuthenticationWithPlatformLinkV4Unauthorized

func NewAuthenticationWithPlatformLinkV4Unauthorized() *AuthenticationWithPlatformLinkV4Unauthorized

NewAuthenticationWithPlatformLinkV4Unauthorized creates a AuthenticationWithPlatformLinkV4Unauthorized with default headers values

func (*AuthenticationWithPlatformLinkV4Unauthorized) Error

func (*AuthenticationWithPlatformLinkV4Unauthorized) GetPayload

func (*AuthenticationWithPlatformLinkV4Unauthorized) ToJSONString

type Client

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

Client for o auth2 0 v4 API

func (*Client) AuthenticationWithPlatformLinkV4 deprecated

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

AuthenticationWithPlatformLinkV4 authentication with platform link This endpoint is being used to authenticate a user account and perform platform link. It validates user's email / username and password. If user already enable 2FA, then invoke _/mfa/verify_ using **mfa_token** from this endpoint response.

## Device Cookie Validation

Device Cookie is used to protect the user account from brute force login attack, [more detail from OWASP](https://owasp.org/www-community/Slow_Down_Online_Guessing_Attacks_with_Device_Cookies). This endpoint will read device cookie from cookie **auth-trust-id**. If device cookie not found, it will generate a new one and set it into cookie when successfully authenticate.

func (*Client) AuthenticationWithPlatformLinkV4Short

func (a *Client) AuthenticationWithPlatformLinkV4Short(params *AuthenticationWithPlatformLinkV4Params, authInfo runtime.ClientAuthInfoWriter) (*AuthenticationWithPlatformLinkV4OK, error)

AuthenticationWithPlatformLinkV4Short authentication with platform link This endpoint is being used to authenticate a user account and perform platform link. It validates user's email / username and password. If user already enable 2FA, then invoke _/mfa/verify_ using **mfa_token** from this endpoint response.

## Device Cookie Validation

Device Cookie is used to protect the user account from brute force login attack, [more detail from OWASP](https://owasp.org/www-community/Slow_Down_Online_Guessing_Attacks_with_Device_Cookies). This endpoint will read device cookie from cookie **auth-trust-id**. If device cookie not found, it will generate a new one and set it into cookie when successfully authenticate.

func (*Client) GenerateTokenByNewHeadlessAccountV4 deprecated

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

GenerateTokenByNewHeadlessAccountV4 create headless account and response token This endpoint is being used to create headless account after 3rd platform authenticated, and response token . The 'linkingToken' in request body is received from "/platforms/{platformId}/token" when 3rd platform account is not linked to justice account yet.

func (*Client) GenerateTokenByNewHeadlessAccountV4Short

func (a *Client) GenerateTokenByNewHeadlessAccountV4Short(params *GenerateTokenByNewHeadlessAccountV4Params, authInfo runtime.ClientAuthInfoWriter) (*GenerateTokenByNewHeadlessAccountV4OK, error)

GenerateTokenByNewHeadlessAccountV4Short create headless account and response token This endpoint is being used to create headless account after 3rd platform authenticated, and response token . The 'linkingToken' in request body is received from "/platforms/{platformId}/token" when 3rd platform account is not linked to justice account yet.

func (*Client) PlatformTokenGrantV4 deprecated

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

PlatformTokenGrantV4 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 or idToken returned by Google OAuth - **googleplaygames**: The platform_token�s value is the authorization code or idToken returned by Google play games 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 or idToken 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: - Steam group(steamnetwork): - steam - steamopenid - PSN group(psn) - ps4web - ps4 - ps5 - XBOX group(xbox) - live - xblweb - Oculus group(oculusgroup) - oculus - oculusweb

## 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) PlatformTokenGrantV4Short

func (a *Client) PlatformTokenGrantV4Short(params *PlatformTokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV4OK, error)

PlatformTokenGrantV4Short 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 or idToken returned by Google OAuth - **googleplaygames**: The platform_token�s value is the authorization code or idToken returned by Google play games 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 or idToken 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: - Steam group(steamnetwork): - steam - steamopenid - PSN group(psn) - ps4web - ps4 - ps5 - XBOX group(xbox) - live - xblweb - Oculus group(oculusgroup) - oculus - oculusweb

## 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) RequestTargetTokenResponseV4 deprecated

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

RequestTargetTokenResponseV4 generate target token by code This endpoint is being used to generate target token. It requires basic header with ClientID and Secret, it should match the ClientID when call `/iam/v3/namespace/{namespace}/token/request` The code should be generated from `/iam/v3/namespace/{namespace}/token/request`.

func (*Client) RequestTargetTokenResponseV4Short

func (a *Client) RequestTargetTokenResponseV4Short(params *RequestTargetTokenResponseV4Params, authInfo runtime.ClientAuthInfoWriter) (*RequestTargetTokenResponseV4OK, error)

RequestTargetTokenResponseV4Short generate target token by code This endpoint is being used to generate target token. It requires basic header with ClientID and Secret, it should match the ClientID when call `/iam/v3/namespace/{namespace}/token/request` The code should be generated from `/iam/v3/namespace/{namespace}/token/request`.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) SimultaneousLoginV4 deprecated

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

SimultaneousLoginV4 simultaneous login # This endpoint is in ALPHA, avoid using this endpoint fow now, reach out to AB support for inquiries

Simultaneous login flow.

The primary goals of this project are to entitle players to authenticate on a native PC platform(Steam/Epic) and the PlayStation platform, link their accounts, and provide support for platform sync with a valid 3rd platform access token.

## Given a valid native ticket and empty simultaneous ticket, these cases will be failed - Native ticket's account is not linked AGS account yet - Native ticket's account is linked AGS account, but AGS account is not linked simultaneous platform yet - Native ticket's account is linked AGS account, AGS account is linked simultaneous platform but there is no available simultaneous token.(only if this platform is expected to store the platform token)

## Given a valid native ticket and empty simultaneous ticket, this case will be success - Native ticket's account already linked AGS account, this AGS account already linked simultaneous platform. There is valid simultaneous token.(this is required only when this simultaneous is expected to cache platform token)

## Given a valid native ticket token and valid simultaneous ticket, these cases will be failed #### Native ticket's account is already linked with AGS account - Native linked AGS account is linked this simultaneous platform but is different with simultaneous ticket's account - Native linked AGS account is not linked with simultaneous but has a linking history with simultaneous platform and it is different with simultaneous ticket's account #### Native ticket's account is not linked with AGS account and Simultaneous ticket's account is already linked wth AGS account - Simultaneous linked AGS account is linked this native platform but is different with native ticket's account - Simultaneous linked AGS account is not linked with native but has a linking history with native platform and it is different with native ticket's account

## Given a valid native ticket and valid simultaneous ticket, these cases will be success - Native ticket's account & Simultaneous ticket's account are both not linked to AGS account yet - Native ticket's account & Simultaneous ticket's account are already linked to same AGS account

func (*Client) SimultaneousLoginV4Short

func (a *Client) SimultaneousLoginV4Short(params *SimultaneousLoginV4Params, authInfo runtime.ClientAuthInfoWriter) (*SimultaneousLoginV4OK, error)

SimultaneousLoginV4Short simultaneous login # This endpoint is in ALPHA, avoid using this endpoint fow now, reach out to AB support for inquiries

Simultaneous login flow.

The primary goals of this project are to entitle players to authenticate on a native PC platform(Steam/Epic) and the PlayStation platform, link their accounts, and provide support for platform sync with a valid 3rd platform access token.

## Given a valid native ticket and empty simultaneous ticket, these cases will be failed - Native ticket's account is not linked AGS account yet - Native ticket's account is linked AGS account, but AGS account is not linked simultaneous platform yet - Native ticket's account is linked AGS account, AGS account is linked simultaneous platform but there is no available simultaneous token.(only if this platform is expected to store the platform token)

## Given a valid native ticket and empty simultaneous ticket, this case will be success - Native ticket's account already linked AGS account, this AGS account already linked simultaneous platform. There is valid simultaneous token.(this is required only when this simultaneous is expected to cache platform token)

## Given a valid native ticket token and valid simultaneous ticket, these cases will be failed #### Native ticket's account is already linked with AGS account - Native linked AGS account is linked this simultaneous platform but is different with simultaneous ticket's account - Native linked AGS account is not linked with simultaneous but has a linking history with simultaneous platform and it is different with simultaneous ticket's account #### Native ticket's account is not linked with AGS account and Simultaneous ticket's account is already linked wth AGS account - Simultaneous linked AGS account is linked this native platform but is different with native ticket's account - Simultaneous linked AGS account is not linked with native but has a linking history with native platform and it is different with native ticket's account

## Given a valid native ticket and valid simultaneous ticket, these cases will be success - Native ticket's account & Simultaneous ticket's account are both not linked to AGS account yet - Native ticket's account & Simultaneous ticket's account are already linked to same AGS account

func (*Client) TokenGrantV4 deprecated

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

TokenGrantV4 oauth2 access token generation endpoint v4 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. 2. Grant Type == `password`: The grant type to use for authenticating a user, whether it's by email / username and password combination or through platform. 3. Grant Type == `refresh_token`: Used to get a new access token for a valid refresh token. 4. Grant Type == `client_credentials`: It generates a token by checking the client credentials provided through Authorization header. 5. 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 allows publisher/studio 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. 6. Grant Type == `urn:ietf:params:oauth:grant-type:login_queue_ticket`: It generates a token by validating the login queue ticket against login queue service.

## 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) TokenGrantV4Short

func (a *Client) TokenGrantV4Short(params *TokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV4OK, error)

TokenGrantV4Short oauth2 access token generation endpoint v4 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. 2. Grant Type == `password`: The grant type to use for authenticating a user, whether it's by email / username and password combination or through platform. 3. Grant Type == `refresh_token`: Used to get a new access token for a valid refresh token. 4. Grant Type == `client_credentials`: It generates a token by checking the client credentials provided through Authorization header. 5. 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 allows publisher/studio 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. 6. Grant Type == `urn:ietf:params:oauth:grant-type:login_queue_ticket`: It generates a token by validating the login queue ticket against login queue service.

## 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) Verify2FACodeV4 deprecated

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

Verify2FACodeV4 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) Verify2FACodeV4Short

func (a *Client) Verify2FACodeV4Short(params *Verify2FACodeV4Params, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeV4OK, error)

Verify2FACodeV4Short 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

type ClientService

type ClientService interface {
	AuthenticationWithPlatformLinkV4(params *AuthenticationWithPlatformLinkV4Params, authInfo runtime.ClientAuthInfoWriter) (*AuthenticationWithPlatformLinkV4OK, *AuthenticationWithPlatformLinkV4Accepted, *AuthenticationWithPlatformLinkV4BadRequest, *AuthenticationWithPlatformLinkV4Unauthorized, *AuthenticationWithPlatformLinkV4Forbidden, *AuthenticationWithPlatformLinkV4Conflict, error)
	AuthenticationWithPlatformLinkV4Short(params *AuthenticationWithPlatformLinkV4Params, authInfo runtime.ClientAuthInfoWriter) (*AuthenticationWithPlatformLinkV4OK, error)
	GenerateTokenByNewHeadlessAccountV4(params *GenerateTokenByNewHeadlessAccountV4Params, authInfo runtime.ClientAuthInfoWriter) (*GenerateTokenByNewHeadlessAccountV4OK, *GenerateTokenByNewHeadlessAccountV4Accepted, *GenerateTokenByNewHeadlessAccountV4BadRequest, *GenerateTokenByNewHeadlessAccountV4Unauthorized, *GenerateTokenByNewHeadlessAccountV4NotFound, error)
	GenerateTokenByNewHeadlessAccountV4Short(params *GenerateTokenByNewHeadlessAccountV4Params, authInfo runtime.ClientAuthInfoWriter) (*GenerateTokenByNewHeadlessAccountV4OK, error)
	Verify2FACodeV4(params *Verify2FACodeV4Params, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeV4OK, *Verify2FACodeV4Accepted, *Verify2FACodeV4Unauthorized, error)
	Verify2FACodeV4Short(params *Verify2FACodeV4Params, authInfo runtime.ClientAuthInfoWriter) (*Verify2FACodeV4OK, error)
	PlatformTokenGrantV4(params *PlatformTokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV4OK, *PlatformTokenGrantV4Accepted, *PlatformTokenGrantV4BadRequest, *PlatformTokenGrantV4Unauthorized, *PlatformTokenGrantV4Forbidden, *PlatformTokenGrantV4ServiceUnavailable, error)
	PlatformTokenGrantV4Short(params *PlatformTokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenGrantV4OK, error)
	SimultaneousLoginV4(params *SimultaneousLoginV4Params, authInfo runtime.ClientAuthInfoWriter) (*SimultaneousLoginV4OK, *SimultaneousLoginV4Accepted, *SimultaneousLoginV4BadRequest, *SimultaneousLoginV4Unauthorized, *SimultaneousLoginV4Conflict, *SimultaneousLoginV4InternalServerError, error)
	SimultaneousLoginV4Short(params *SimultaneousLoginV4Params, authInfo runtime.ClientAuthInfoWriter) (*SimultaneousLoginV4OK, error)
	TokenGrantV4(params *TokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV4OK, *TokenGrantV4Accepted, *TokenGrantV4BadRequest, *TokenGrantV4Unauthorized, *TokenGrantV4Forbidden, *TokenGrantV4TooManyRequests, error)
	TokenGrantV4Short(params *TokenGrantV4Params, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantV4OK, error)
	RequestTargetTokenResponseV4(params *RequestTargetTokenResponseV4Params, authInfo runtime.ClientAuthInfoWriter) (*RequestTargetTokenResponseV4OK, *RequestTargetTokenResponseV4Accepted, error)
	RequestTargetTokenResponseV4Short(params *RequestTargetTokenResponseV4Params, authInfo runtime.ClientAuthInfoWriter) (*RequestTargetTokenResponseV4OK, 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 v4 API client.

type GenerateTokenByNewHeadlessAccountV4Accepted

type GenerateTokenByNewHeadlessAccountV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

GenerateTokenByNewHeadlessAccountV4Accepted handles this case with default header values.

Succeed to create headless account and response token info.

func NewGenerateTokenByNewHeadlessAccountV4Accepted

func NewGenerateTokenByNewHeadlessAccountV4Accepted() *GenerateTokenByNewHeadlessAccountV4Accepted

NewGenerateTokenByNewHeadlessAccountV4Accepted creates a GenerateTokenByNewHeadlessAccountV4Accepted with default headers values

func (*GenerateTokenByNewHeadlessAccountV4Accepted) Error

func (*GenerateTokenByNewHeadlessAccountV4Accepted) GetPayload

func (*GenerateTokenByNewHeadlessAccountV4Accepted) ToJSONString

type GenerateTokenByNewHeadlessAccountV4BadRequest

type GenerateTokenByNewHeadlessAccountV4BadRequest struct {
	Payload *iamclientmodels.RestErrorResponse
}

GenerateTokenByNewHeadlessAccountV4BadRequest handles this case with default header values.

Invalid platform linking token or clientID not match.

func NewGenerateTokenByNewHeadlessAccountV4BadRequest

func NewGenerateTokenByNewHeadlessAccountV4BadRequest() *GenerateTokenByNewHeadlessAccountV4BadRequest

NewGenerateTokenByNewHeadlessAccountV4BadRequest creates a GenerateTokenByNewHeadlessAccountV4BadRequest with default headers values

func (*GenerateTokenByNewHeadlessAccountV4BadRequest) Error

func (*GenerateTokenByNewHeadlessAccountV4BadRequest) GetPayload

func (*GenerateTokenByNewHeadlessAccountV4BadRequest) ToJSONString

type GenerateTokenByNewHeadlessAccountV4NotFound

type GenerateTokenByNewHeadlessAccountV4NotFound struct {
	Payload *iamclientmodels.RestErrorResponse
}

GenerateTokenByNewHeadlessAccountV4NotFound handles this case with default header values.

Platform linking token not found.

func NewGenerateTokenByNewHeadlessAccountV4NotFound

func NewGenerateTokenByNewHeadlessAccountV4NotFound() *GenerateTokenByNewHeadlessAccountV4NotFound

NewGenerateTokenByNewHeadlessAccountV4NotFound creates a GenerateTokenByNewHeadlessAccountV4NotFound with default headers values

func (*GenerateTokenByNewHeadlessAccountV4NotFound) Error

func (*GenerateTokenByNewHeadlessAccountV4NotFound) GetPayload

func (*GenerateTokenByNewHeadlessAccountV4NotFound) ToJSONString

type GenerateTokenByNewHeadlessAccountV4OK

type GenerateTokenByNewHeadlessAccountV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

GenerateTokenByNewHeadlessAccountV4OK handles this case with default header values.

Succeed to create headless account and response token info.

func NewGenerateTokenByNewHeadlessAccountV4OK

func NewGenerateTokenByNewHeadlessAccountV4OK() *GenerateTokenByNewHeadlessAccountV4OK

NewGenerateTokenByNewHeadlessAccountV4OK creates a GenerateTokenByNewHeadlessAccountV4OK with default headers values

func (*GenerateTokenByNewHeadlessAccountV4OK) Error

func (*GenerateTokenByNewHeadlessAccountV4OK) GetPayload

func (*GenerateTokenByNewHeadlessAccountV4OK) ToJSONString

type GenerateTokenByNewHeadlessAccountV4Params

type GenerateTokenByNewHeadlessAccountV4Params struct {

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

	*/
	AdditionalData *string
	/*ExtendExp
	  Extend expiration date of refresh token

	*/
	ExtendExp *bool
	/*LinkingToken
	  Platform linking Token

	*/
	LinkingToken string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

GenerateTokenByNewHeadlessAccountV4Params contains all the parameters to send to the API endpoint for the generate token by new headless account v4 operation typically these are written to a http.Request

func NewGenerateTokenByNewHeadlessAccountV4Params

func NewGenerateTokenByNewHeadlessAccountV4Params() *GenerateTokenByNewHeadlessAccountV4Params

NewGenerateTokenByNewHeadlessAccountV4Params creates a new GenerateTokenByNewHeadlessAccountV4Params object with the default values initialized.

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithContext

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithContext(ctx context.Context) *GenerateTokenByNewHeadlessAccountV4Params

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

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithHTTPClient

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithHTTPClient(client *http.Client) *GenerateTokenByNewHeadlessAccountV4Params

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

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithTimeout

func NewGenerateTokenByNewHeadlessAccountV4ParamsWithTimeout(timeout time.Duration) *GenerateTokenByNewHeadlessAccountV4Params

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

func (*GenerateTokenByNewHeadlessAccountV4Params) SetAdditionalData

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

SetAdditionalData adds the additionalData to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetContext

SetContext adds the context to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetExtendExp

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

SetExtendExp adds the extendExp to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetFlightId

func (o *GenerateTokenByNewHeadlessAccountV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*GenerateTokenByNewHeadlessAccountV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetLinkingToken

func (o *GenerateTokenByNewHeadlessAccountV4Params) SetLinkingToken(linkingToken string)

SetLinkingToken adds the linkingToken to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) SetTimeout

SetTimeout adds the timeout to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithAdditionalData

WithAdditionalData adds the additionalData to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithContext

WithContext adds the context to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithExtendExp

WithExtendExp adds the extendExp to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithLinkingToken

WithLinkingToken adds the linkingToken to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WithTimeout

WithTimeout adds the timeout to the generate token by new headless account v4 params

func (*GenerateTokenByNewHeadlessAccountV4Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type GenerateTokenByNewHeadlessAccountV4Reader

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

GenerateTokenByNewHeadlessAccountV4Reader is a Reader for the GenerateTokenByNewHeadlessAccountV4 structure.

func (*GenerateTokenByNewHeadlessAccountV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GenerateTokenByNewHeadlessAccountV4Unauthorized

type GenerateTokenByNewHeadlessAccountV4Unauthorized struct {
	Payload *iamclientmodels.RestErrorResponse
}

GenerateTokenByNewHeadlessAccountV4Unauthorized handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>10213</td><td>country is blocked</td></tr></table>

func NewGenerateTokenByNewHeadlessAccountV4Unauthorized

func NewGenerateTokenByNewHeadlessAccountV4Unauthorized() *GenerateTokenByNewHeadlessAccountV4Unauthorized

NewGenerateTokenByNewHeadlessAccountV4Unauthorized creates a GenerateTokenByNewHeadlessAccountV4Unauthorized with default headers values

func (*GenerateTokenByNewHeadlessAccountV4Unauthorized) Error

func (*GenerateTokenByNewHeadlessAccountV4Unauthorized) GetPayload

func (*GenerateTokenByNewHeadlessAccountV4Unauthorized) ToJSONString

type PlatformTokenGrantV4Accepted

type PlatformTokenGrantV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

PlatformTokenGrantV4Accepted handles this case with default header values.

Login ticket returned

func NewPlatformTokenGrantV4Accepted

func NewPlatformTokenGrantV4Accepted() *PlatformTokenGrantV4Accepted

NewPlatformTokenGrantV4Accepted creates a PlatformTokenGrantV4Accepted with default headers values

func (*PlatformTokenGrantV4Accepted) Error

func (*PlatformTokenGrantV4Accepted) GetPayload

func (*PlatformTokenGrantV4Accepted) ToJSONString

func (o *PlatformTokenGrantV4Accepted) ToJSONString() string

type PlatformTokenGrantV4BadRequest

type PlatformTokenGrantV4BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV4BadRequest handles this case with default header values.

General request error

func NewPlatformTokenGrantV4BadRequest

func NewPlatformTokenGrantV4BadRequest() *PlatformTokenGrantV4BadRequest

NewPlatformTokenGrantV4BadRequest creates a PlatformTokenGrantV4BadRequest with default headers values

func (*PlatformTokenGrantV4BadRequest) Error

func (*PlatformTokenGrantV4BadRequest) GetPayload

func (*PlatformTokenGrantV4BadRequest) ToJSONString

func (o *PlatformTokenGrantV4BadRequest) ToJSONString() string

type PlatformTokenGrantV4Forbidden

type PlatformTokenGrantV4Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV4Forbidden handles this case with default header values.

Forbidden

func NewPlatformTokenGrantV4Forbidden

func NewPlatformTokenGrantV4Forbidden() *PlatformTokenGrantV4Forbidden

NewPlatformTokenGrantV4Forbidden creates a PlatformTokenGrantV4Forbidden with default headers values

func (*PlatformTokenGrantV4Forbidden) Error

func (*PlatformTokenGrantV4Forbidden) GetPayload

func (*PlatformTokenGrantV4Forbidden) ToJSONString

func (o *PlatformTokenGrantV4Forbidden) ToJSONString() string

type PlatformTokenGrantV4OK

type PlatformTokenGrantV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

PlatformTokenGrantV4OK handles this case with default header values.

Token returned

func NewPlatformTokenGrantV4OK

func NewPlatformTokenGrantV4OK() *PlatformTokenGrantV4OK

NewPlatformTokenGrantV4OK creates a PlatformTokenGrantV4OK with default headers values

func (*PlatformTokenGrantV4OK) Error

func (o *PlatformTokenGrantV4OK) Error() string

func (*PlatformTokenGrantV4OK) GetPayload

func (*PlatformTokenGrantV4OK) ToJSONString

func (o *PlatformTokenGrantV4OK) ToJSONString() string

type PlatformTokenGrantV4Params

type PlatformTokenGrantV4Params 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
	/*ServiceLabel
	  Service label, it's used to validate PSN app when set AppId on ps5/ps4

	*/
	ServiceLabel *float64
	/*SkipSetCookie
	  If need skip set cookie. Default is false

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

	*/
	PlatformID string
	/*CodeChallenge
	  Value generated by transforming code verifier using code challenge method.

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

	*/
	CodeChallengeMethod *string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

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

func NewPlatformTokenGrantV4Params

func NewPlatformTokenGrantV4Params() *PlatformTokenGrantV4Params

NewPlatformTokenGrantV4Params creates a new PlatformTokenGrantV4Params object with the default values initialized.

func NewPlatformTokenGrantV4ParamsWithContext

func NewPlatformTokenGrantV4ParamsWithContext(ctx context.Context) *PlatformTokenGrantV4Params

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

func NewPlatformTokenGrantV4ParamsWithHTTPClient

func NewPlatformTokenGrantV4ParamsWithHTTPClient(client *http.Client) *PlatformTokenGrantV4Params

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

func NewPlatformTokenGrantV4ParamsWithTimeout

func NewPlatformTokenGrantV4ParamsWithTimeout(timeout time.Duration) *PlatformTokenGrantV4Params

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

func (*PlatformTokenGrantV4Params) SetAdditionalData

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

SetAdditionalData adds the additionalData to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetClientID

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

SetClientID adds the clientId to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetCodeChallenge

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

SetCodeChallenge adds the codeChallenge to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetCodeChallengeMethod

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

SetCodeChallengeMethod adds the codeChallengeMethod to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetContext

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

SetContext adds the context to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetCreateHeadless

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

SetCreateHeadless adds the createHeadless to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetDeviceID

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

SetDeviceID adds the deviceId to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetFlightId

func (o *PlatformTokenGrantV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*PlatformTokenGrantV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetHTTPClientTransport

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

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

func (*PlatformTokenGrantV4Params) SetMacAddress

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

SetMacAddress adds the macAddress to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetPlatformID

func (o *PlatformTokenGrantV4Params) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetPlatformToken

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

SetPlatformToken adds the platformToken to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetServiceLabel added in v0.71.0

func (o *PlatformTokenGrantV4Params) SetServiceLabel(serviceLabel *float64)

SetServiceLabel adds the serviceLabel to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetSkipSetCookie

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

SetSkipSetCookie adds the skipSetCookie to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) SetTimeout

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

SetTimeout adds the timeout to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithAdditionalData

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

WithAdditionalData adds the additionalData to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithClientID

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

WithClientID adds the clientID to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithCodeChallenge

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

WithCodeChallenge adds the codeChallenge to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithCodeChallengeMethod

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

WithCodeChallengeMethod adds the codeChallengeMethod to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithContext

WithContext adds the context to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithCreateHeadless

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

WithCreateHeadless adds the createHeadless to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithDeviceID

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

WithDeviceID adds the deviceID to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithMacAddress

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

WithMacAddress adds the macAddress to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithPlatformID

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

WithPlatformID adds the platformID to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithPlatformToken

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

WithPlatformToken adds the platformToken to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithServiceLabel added in v0.71.0

func (o *PlatformTokenGrantV4Params) WithServiceLabel(serviceLabel *float64) *PlatformTokenGrantV4Params

WithServiceLabel adds the serviceLabel to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithSkipSetCookie

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

WithSkipSetCookie adds the skipSetCookie to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WithTimeout

WithTimeout adds the timeout to the platform token grant v4 params

func (*PlatformTokenGrantV4Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type PlatformTokenGrantV4Reader

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

PlatformTokenGrantV4Reader is a Reader for the PlatformTokenGrantV4 structure.

func (*PlatformTokenGrantV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type PlatformTokenGrantV4ServiceUnavailable

type PlatformTokenGrantV4ServiceUnavailable struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV4ServiceUnavailable handles this case with default header values.

Third Party Server timeout or unavailable

func NewPlatformTokenGrantV4ServiceUnavailable

func NewPlatformTokenGrantV4ServiceUnavailable() *PlatformTokenGrantV4ServiceUnavailable

NewPlatformTokenGrantV4ServiceUnavailable creates a PlatformTokenGrantV4ServiceUnavailable with default headers values

func (*PlatformTokenGrantV4ServiceUnavailable) Error

func (*PlatformTokenGrantV4ServiceUnavailable) GetPayload

func (*PlatformTokenGrantV4ServiceUnavailable) ToJSONString

type PlatformTokenGrantV4Unauthorized

type PlatformTokenGrantV4Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenGrantV4Unauthorized handles this case with default header values.

Client authentication failed

func NewPlatformTokenGrantV4Unauthorized

func NewPlatformTokenGrantV4Unauthorized() *PlatformTokenGrantV4Unauthorized

NewPlatformTokenGrantV4Unauthorized creates a PlatformTokenGrantV4Unauthorized with default headers values

func (*PlatformTokenGrantV4Unauthorized) Error

func (*PlatformTokenGrantV4Unauthorized) GetPayload

func (*PlatformTokenGrantV4Unauthorized) ToJSONString

func (o *PlatformTokenGrantV4Unauthorized) ToJSONString() string

type RequestTargetTokenResponseV4Accepted

type RequestTargetTokenResponseV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

RequestTargetTokenResponseV4Accepted handles this case with default header values.

Login queue ticket returned

func NewRequestTargetTokenResponseV4Accepted

func NewRequestTargetTokenResponseV4Accepted() *RequestTargetTokenResponseV4Accepted

NewRequestTargetTokenResponseV4Accepted creates a RequestTargetTokenResponseV4Accepted with default headers values

func (*RequestTargetTokenResponseV4Accepted) Error

func (*RequestTargetTokenResponseV4Accepted) GetPayload

func (*RequestTargetTokenResponseV4Accepted) ToJSONString

func (o *RequestTargetTokenResponseV4Accepted) ToJSONString() string

type RequestTargetTokenResponseV4OK

type RequestTargetTokenResponseV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

RequestTargetTokenResponseV4OK handles this case with default header values.

Succeed to exchange token.

func NewRequestTargetTokenResponseV4OK

func NewRequestTargetTokenResponseV4OK() *RequestTargetTokenResponseV4OK

NewRequestTargetTokenResponseV4OK creates a RequestTargetTokenResponseV4OK with default headers values

func (*RequestTargetTokenResponseV4OK) Error

func (*RequestTargetTokenResponseV4OK) GetPayload

func (*RequestTargetTokenResponseV4OK) ToJSONString

func (o *RequestTargetTokenResponseV4OK) ToJSONString() string

type RequestTargetTokenResponseV4Params

type RequestTargetTokenResponseV4Params struct {

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

	*/
	AdditionalData *string
	/*Code
	  code from request target token response

	*/
	Code string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

RequestTargetTokenResponseV4Params contains all the parameters to send to the API endpoint for the request target token response v4 operation typically these are written to a http.Request

func NewRequestTargetTokenResponseV4Params

func NewRequestTargetTokenResponseV4Params() *RequestTargetTokenResponseV4Params

NewRequestTargetTokenResponseV4Params creates a new RequestTargetTokenResponseV4Params object with the default values initialized.

func NewRequestTargetTokenResponseV4ParamsWithContext

func NewRequestTargetTokenResponseV4ParamsWithContext(ctx context.Context) *RequestTargetTokenResponseV4Params

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

func NewRequestTargetTokenResponseV4ParamsWithHTTPClient

func NewRequestTargetTokenResponseV4ParamsWithHTTPClient(client *http.Client) *RequestTargetTokenResponseV4Params

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

func NewRequestTargetTokenResponseV4ParamsWithTimeout

func NewRequestTargetTokenResponseV4ParamsWithTimeout(timeout time.Duration) *RequestTargetTokenResponseV4Params

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

func (*RequestTargetTokenResponseV4Params) SetAdditionalData

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

SetAdditionalData adds the additionalData to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetCode

func (o *RequestTargetTokenResponseV4Params) SetCode(code string)

SetCode adds the code to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetContext

SetContext adds the context to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetFlightId

func (o *RequestTargetTokenResponseV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*RequestTargetTokenResponseV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) SetTimeout

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

SetTimeout adds the timeout to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WithAdditionalData

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

WithAdditionalData adds the additionalData to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WithCode

WithCode adds the code to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WithContext

WithContext adds the context to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WithTimeout

WithTimeout adds the timeout to the request target token response v4 params

func (*RequestTargetTokenResponseV4Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type RequestTargetTokenResponseV4Reader

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

RequestTargetTokenResponseV4Reader is a Reader for the RequestTargetTokenResponseV4 structure.

func (*RequestTargetTokenResponseV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type SimultaneousLoginV4Accepted

type SimultaneousLoginV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

SimultaneousLoginV4Accepted handles this case with default header values.

Login ticket returned.

func NewSimultaneousLoginV4Accepted

func NewSimultaneousLoginV4Accepted() *SimultaneousLoginV4Accepted

NewSimultaneousLoginV4Accepted creates a SimultaneousLoginV4Accepted with default headers values

func (*SimultaneousLoginV4Accepted) Error

func (*SimultaneousLoginV4Accepted) GetPayload

func (*SimultaneousLoginV4Accepted) ToJSONString

func (o *SimultaneousLoginV4Accepted) ToJSONString() string

type SimultaneousLoginV4BadRequest

type SimultaneousLoginV4BadRequest struct {
	Payload *iamclientmodels.RestErrorResponse
}

SimultaneousLoginV4BadRequest handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>10216</td><td>Native ticket is required</td></tr></table>

func NewSimultaneousLoginV4BadRequest

func NewSimultaneousLoginV4BadRequest() *SimultaneousLoginV4BadRequest

NewSimultaneousLoginV4BadRequest creates a SimultaneousLoginV4BadRequest with default headers values

func (*SimultaneousLoginV4BadRequest) Error

func (*SimultaneousLoginV4BadRequest) GetPayload

func (*SimultaneousLoginV4BadRequest) ToJSONString

func (o *SimultaneousLoginV4BadRequest) ToJSONString() string

type SimultaneousLoginV4Conflict

type SimultaneousLoginV4Conflict struct {
	Payload *iamclientmodels.RestErrorResponse
}

SimultaneousLoginV4Conflict handles this case with default header values.

<table><tr><td>errorCode</td><td>errorMessage</td></tr><tr><td>10215</td><td>Simultaneous ticket is required</td></tr><tr><td>10220</td><td>Native ticket's account linked AGS account is different with the one which simultaneous ticket's linked to</td></tr><tr><td>10219</td><td>Native ticket's account linked AGS is already linked simultaneous but different with the input simultaneous ticket's</td></tr><tr><td>10217</td><td>Native ticket's account linked AGS account has different linking history with input simultaneous ticket's</td></tr><tr><td>10221</td><td>Simultaneous ticket's account linked AGS is already linked native but different with the input native ticket's</td></tr><tr><td>10218</td><td>Simultaneous ticket's account linked AGS account has different linking history with input native ticket's</td></tr></table>

func NewSimultaneousLoginV4Conflict

func NewSimultaneousLoginV4Conflict() *SimultaneousLoginV4Conflict

NewSimultaneousLoginV4Conflict creates a SimultaneousLoginV4Conflict with default headers values

func (*SimultaneousLoginV4Conflict) Error

func (*SimultaneousLoginV4Conflict) GetPayload

func (*SimultaneousLoginV4Conflict) ToJSONString

func (o *SimultaneousLoginV4Conflict) ToJSONString() string

type SimultaneousLoginV4InternalServerError

type SimultaneousLoginV4InternalServerError struct {
	Payload *iamclientmodels.RestErrorResponse
}

SimultaneousLoginV4InternalServerError 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 NewSimultaneousLoginV4InternalServerError

func NewSimultaneousLoginV4InternalServerError() *SimultaneousLoginV4InternalServerError

NewSimultaneousLoginV4InternalServerError creates a SimultaneousLoginV4InternalServerError with default headers values

func (*SimultaneousLoginV4InternalServerError) Error

func (*SimultaneousLoginV4InternalServerError) GetPayload

func (*SimultaneousLoginV4InternalServerError) ToJSONString

type SimultaneousLoginV4OK

type SimultaneousLoginV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

SimultaneousLoginV4OK handles this case with default header values.

Token returned.

func NewSimultaneousLoginV4OK

func NewSimultaneousLoginV4OK() *SimultaneousLoginV4OK

NewSimultaneousLoginV4OK creates a SimultaneousLoginV4OK with default headers values

func (*SimultaneousLoginV4OK) Error

func (o *SimultaneousLoginV4OK) Error() string

func (*SimultaneousLoginV4OK) GetPayload

func (*SimultaneousLoginV4OK) ToJSONString

func (o *SimultaneousLoginV4OK) ToJSONString() string

type SimultaneousLoginV4Params

type SimultaneousLoginV4Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*SimultaneousPlatform
	  Simultaneous platform

	*/
	SimultaneousPlatform *string
	/*SimultaneousTicket
	  Simultaneous ticket, can be authCode,authTicket,authToken

	*/
	SimultaneousTicket *string
	/*NativePlatform
	  Native platform id

	*/
	NativePlatform string
	/*NativePlatformTicket
	  Native platform ticket

	*/
	NativePlatformTicket string
	/*CodeChallenge
	  Value generated by transforming code verifier using code challenge method.

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

	*/
	CodeChallengeMethod *string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

SimultaneousLoginV4Params contains all the parameters to send to the API endpoint for the simultaneous login v4 operation typically these are written to a http.Request

func NewSimultaneousLoginV4Params

func NewSimultaneousLoginV4Params() *SimultaneousLoginV4Params

NewSimultaneousLoginV4Params creates a new SimultaneousLoginV4Params object with the default values initialized.

func NewSimultaneousLoginV4ParamsWithContext

func NewSimultaneousLoginV4ParamsWithContext(ctx context.Context) *SimultaneousLoginV4Params

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

func NewSimultaneousLoginV4ParamsWithHTTPClient

func NewSimultaneousLoginV4ParamsWithHTTPClient(client *http.Client) *SimultaneousLoginV4Params

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

func NewSimultaneousLoginV4ParamsWithTimeout

func NewSimultaneousLoginV4ParamsWithTimeout(timeout time.Duration) *SimultaneousLoginV4Params

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

func (*SimultaneousLoginV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetCodeChallenge

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

SetCodeChallenge adds the codeChallenge to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetCodeChallengeMethod

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

SetCodeChallengeMethod adds the codeChallengeMethod to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetContext

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

SetContext adds the context to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetFlightId

func (o *SimultaneousLoginV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*SimultaneousLoginV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetNativePlatform

func (o *SimultaneousLoginV4Params) SetNativePlatform(nativePlatform string)

SetNativePlatform adds the nativePlatform to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetNativePlatformTicket

func (o *SimultaneousLoginV4Params) SetNativePlatformTicket(nativePlatformTicket string)

SetNativePlatformTicket adds the nativePlatformTicket to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetSimultaneousPlatform

func (o *SimultaneousLoginV4Params) SetSimultaneousPlatform(simultaneousPlatform *string)

SetSimultaneousPlatform adds the simultaneousPlatform to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetSimultaneousTicket

func (o *SimultaneousLoginV4Params) SetSimultaneousTicket(simultaneousTicket *string)

SetSimultaneousTicket adds the simultaneousTicket to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) SetTimeout

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

SetTimeout adds the timeout to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithCodeChallenge

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

WithCodeChallenge adds the codeChallenge to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithCodeChallengeMethod

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

WithCodeChallengeMethod adds the codeChallengeMethod to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithContext

WithContext adds the context to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithNativePlatform

func (o *SimultaneousLoginV4Params) WithNativePlatform(nativePlatform string) *SimultaneousLoginV4Params

WithNativePlatform adds the nativePlatform to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithNativePlatformTicket

func (o *SimultaneousLoginV4Params) WithNativePlatformTicket(nativePlatformTicket string) *SimultaneousLoginV4Params

WithNativePlatformTicket adds the nativePlatformTicket to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithSimultaneousPlatform

func (o *SimultaneousLoginV4Params) WithSimultaneousPlatform(simultaneousPlatform *string) *SimultaneousLoginV4Params

WithSimultaneousPlatform adds the simultaneousPlatform to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithSimultaneousTicket

func (o *SimultaneousLoginV4Params) WithSimultaneousTicket(simultaneousTicket *string) *SimultaneousLoginV4Params

WithSimultaneousTicket adds the simultaneousTicket to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WithTimeout

WithTimeout adds the timeout to the simultaneous login v4 params

func (*SimultaneousLoginV4Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type SimultaneousLoginV4Reader

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

SimultaneousLoginV4Reader is a Reader for the SimultaneousLoginV4 structure.

func (*SimultaneousLoginV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type SimultaneousLoginV4Unauthorized

type SimultaneousLoginV4Unauthorized struct {
	Payload *iamclientmodels.RestErrorResponse
}

SimultaneousLoginV4Unauthorized 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 NewSimultaneousLoginV4Unauthorized

func NewSimultaneousLoginV4Unauthorized() *SimultaneousLoginV4Unauthorized

NewSimultaneousLoginV4Unauthorized creates a SimultaneousLoginV4Unauthorized with default headers values

func (*SimultaneousLoginV4Unauthorized) Error

func (*SimultaneousLoginV4Unauthorized) GetPayload

func (*SimultaneousLoginV4Unauthorized) ToJSONString

func (o *SimultaneousLoginV4Unauthorized) ToJSONString() string

type TokenGrantV4Accepted

type TokenGrantV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

TokenGrantV4Accepted handles this case with default header values.

Login ticket returned

func NewTokenGrantV4Accepted

func NewTokenGrantV4Accepted() *TokenGrantV4Accepted

NewTokenGrantV4Accepted creates a TokenGrantV4Accepted with default headers values

func (*TokenGrantV4Accepted) Error

func (o *TokenGrantV4Accepted) Error() string

func (*TokenGrantV4Accepted) GetPayload

func (*TokenGrantV4Accepted) ToJSONString

func (o *TokenGrantV4Accepted) ToJSONString() string

type TokenGrantV4BadRequest

type TokenGrantV4BadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV4BadRequest handles this case with default header values.

InvalidRequest

func NewTokenGrantV4BadRequest

func NewTokenGrantV4BadRequest() *TokenGrantV4BadRequest

NewTokenGrantV4BadRequest creates a TokenGrantV4BadRequest with default headers values

func (*TokenGrantV4BadRequest) Error

func (o *TokenGrantV4BadRequest) Error() string

func (*TokenGrantV4BadRequest) GetPayload

func (*TokenGrantV4BadRequest) ToJSONString

func (o *TokenGrantV4BadRequest) ToJSONString() string

type TokenGrantV4Forbidden

type TokenGrantV4Forbidden struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV4Forbidden handles this case with default header values.

Unauthorized access

func NewTokenGrantV4Forbidden

func NewTokenGrantV4Forbidden() *TokenGrantV4Forbidden

NewTokenGrantV4Forbidden creates a TokenGrantV4Forbidden with default headers values

func (*TokenGrantV4Forbidden) Error

func (o *TokenGrantV4Forbidden) Error() string

func (*TokenGrantV4Forbidden) GetPayload

func (*TokenGrantV4Forbidden) ToJSONString

func (o *TokenGrantV4Forbidden) ToJSONString() string

type TokenGrantV4OK

type TokenGrantV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenWithDeviceCookieResponseV3
}

TokenGrantV4OK handles this case with default header values.

Token returned

func NewTokenGrantV4OK

func NewTokenGrantV4OK() *TokenGrantV4OK

NewTokenGrantV4OK creates a TokenGrantV4OK with default headers values

func (*TokenGrantV4OK) Error

func (o *TokenGrantV4OK) Error() string

func (*TokenGrantV4OK) ToJSONString

func (o *TokenGrantV4OK) ToJSONString() string

type TokenGrantV4Params

type TokenGrantV4Params 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
	/*ClientSecret
	  Confidential Client Secret (used with grant type 'authorization_code' when using confidential client with client_secret_post authentication method, i.e. not using HTTP Basic authentication)

	*/
	ClientSecret *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
	/*LoginQueueTicket
	  Login queue ticket(used with grant type `urn:ietf:params:oauth:grant-type:login_queue_ticket`)

	*/
	LoginQueueTicket *string
	/*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
	/*CodeChallenge
	  Value generated by transforming code verifier using code challenge method.

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

	*/
	CodeChallengeMethod *string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

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

func NewTokenGrantV4Params

func NewTokenGrantV4Params() *TokenGrantV4Params

NewTokenGrantV4Params creates a new TokenGrantV4Params object with the default values initialized.

func NewTokenGrantV4ParamsWithContext

func NewTokenGrantV4ParamsWithContext(ctx context.Context) *TokenGrantV4Params

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

func NewTokenGrantV4ParamsWithHTTPClient

func NewTokenGrantV4ParamsWithHTTPClient(client *http.Client) *TokenGrantV4Params

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

func NewTokenGrantV4ParamsWithTimeout

func NewTokenGrantV4ParamsWithTimeout(timeout time.Duration) *TokenGrantV4Params

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

func (*TokenGrantV4Params) SetAdditionalData

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

SetAdditionalData adds the additionalData to the token grant v4 params

func (*TokenGrantV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the token grant v4 params

func (*TokenGrantV4Params) SetAuthTrustID

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

SetAuthTrustID adds the authTrustId to the token grant v4 params

func (*TokenGrantV4Params) SetClientID

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

SetClientID adds the clientId to the token grant v4 params

func (*TokenGrantV4Params) SetClientSecret added in v0.71.0

func (o *TokenGrantV4Params) SetClientSecret(clientSecret *string)

SetClientSecret adds the clientSecret to the token grant v4 params

func (*TokenGrantV4Params) SetCode

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

SetCode adds the code to the token grant v4 params

func (*TokenGrantV4Params) SetCodeChallenge

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

SetCodeChallenge adds the codeChallenge to the token grant v4 params

func (*TokenGrantV4Params) SetCodeChallengeMethod

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

SetCodeChallengeMethod adds the codeChallengeMethod to the token grant v4 params

func (*TokenGrantV4Params) SetCodeVerifier

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

SetCodeVerifier adds the codeVerifier to the token grant v4 params

func (*TokenGrantV4Params) SetContext

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

SetContext adds the context to the token grant v4 params

func (*TokenGrantV4Params) SetDeviceID

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

SetDeviceID adds the deviceId to the token grant v4 params

func (*TokenGrantV4Params) SetExtendExp

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

SetExtendExp adds the extendExp to the token grant v4 params

func (*TokenGrantV4Params) SetExtendNamespace

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

SetExtendNamespace adds the extendNamespace to the token grant v4 params

func (*TokenGrantV4Params) SetFlightId

func (o *TokenGrantV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*TokenGrantV4Params) SetGrantType

func (o *TokenGrantV4Params) SetGrantType(grantType string)

SetGrantType adds the grantType to the token grant v4 params

func (*TokenGrantV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the token grant v4 params

func (*TokenGrantV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the token grant v4 params

func (*TokenGrantV4Params) SetLoginQueueTicket

func (o *TokenGrantV4Params) SetLoginQueueTicket(loginQueueTicket *string)

SetLoginQueueTicket adds the loginQueueTicket to the token grant v4 params

func (*TokenGrantV4Params) SetPassword

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

SetPassword adds the password to the token grant v4 params

func (*TokenGrantV4Params) SetRedirectURI

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

SetRedirectURI adds the redirectUri to the token grant v4 params

func (*TokenGrantV4Params) SetRefreshToken

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

SetRefreshToken adds the refreshToken to the token grant v4 params

func (*TokenGrantV4Params) SetTimeout

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

SetTimeout adds the timeout to the token grant v4 params

func (*TokenGrantV4Params) SetUsername

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

SetUsername adds the username to the token grant v4 params

func (*TokenGrantV4Params) WithAdditionalData

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

WithAdditionalData adds the additionalData to the token grant v4 params

func (*TokenGrantV4Params) WithAuthTrustID

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

WithAuthTrustID adds the authTrustID to the token grant v4 params

func (*TokenGrantV4Params) WithClientID

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

WithClientID adds the clientID to the token grant v4 params

func (*TokenGrantV4Params) WithClientSecret added in v0.71.0

func (o *TokenGrantV4Params) WithClientSecret(clientSecret *string) *TokenGrantV4Params

WithClientSecret adds the clientSecret to the token grant v4 params

func (*TokenGrantV4Params) WithCode

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

WithCode adds the code to the token grant v4 params

func (*TokenGrantV4Params) WithCodeChallenge

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

WithCodeChallenge adds the codeChallenge to the token grant v4 params

func (*TokenGrantV4Params) WithCodeChallengeMethod

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

WithCodeChallengeMethod adds the codeChallengeMethod to the token grant v4 params

func (*TokenGrantV4Params) WithCodeVerifier

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

WithCodeVerifier adds the codeVerifier to the token grant v4 params

func (*TokenGrantV4Params) WithContext

WithContext adds the context to the token grant v4 params

func (*TokenGrantV4Params) WithDeviceID

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

WithDeviceID adds the deviceID to the token grant v4 params

func (*TokenGrantV4Params) WithExtendExp

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

WithExtendExp adds the extendExp to the token grant v4 params

func (*TokenGrantV4Params) WithExtendNamespace

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

WithExtendNamespace adds the extendNamespace to the token grant v4 params

func (*TokenGrantV4Params) WithGrantType

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

WithGrantType adds the grantType to the token grant v4 params

func (*TokenGrantV4Params) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the token grant v4 params

func (*TokenGrantV4Params) WithLoginQueueTicket

func (o *TokenGrantV4Params) WithLoginQueueTicket(loginQueueTicket *string) *TokenGrantV4Params

WithLoginQueueTicket adds the loginQueueTicket to the token grant v4 params

func (*TokenGrantV4Params) WithPassword

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

WithPassword adds the password to the token grant v4 params

func (*TokenGrantV4Params) WithRedirectURI

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

WithRedirectURI adds the redirectURI to the token grant v4 params

func (*TokenGrantV4Params) WithRefreshToken

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

WithRefreshToken adds the refreshToken to the token grant v4 params

func (*TokenGrantV4Params) WithTimeout

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

WithTimeout adds the timeout to the token grant v4 params

func (*TokenGrantV4Params) WithUsername

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

WithUsername adds the username to the token grant v4 params

func (*TokenGrantV4Params) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type TokenGrantV4Reader

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

TokenGrantV4Reader is a Reader for the TokenGrantV4 structure.

func (*TokenGrantV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type TokenGrantV4TooManyRequests

type TokenGrantV4TooManyRequests struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV4TooManyRequests handles this case with default header values.

Too many failed auth attempt

func NewTokenGrantV4TooManyRequests

func NewTokenGrantV4TooManyRequests() *TokenGrantV4TooManyRequests

NewTokenGrantV4TooManyRequests creates a TokenGrantV4TooManyRequests with default headers values

func (*TokenGrantV4TooManyRequests) Error

func (*TokenGrantV4TooManyRequests) GetPayload

func (*TokenGrantV4TooManyRequests) ToJSONString

func (o *TokenGrantV4TooManyRequests) ToJSONString() string

type TokenGrantV4Unauthorized

type TokenGrantV4Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantV4Unauthorized handles this case with default header values.

Client authentication failed

func NewTokenGrantV4Unauthorized

func NewTokenGrantV4Unauthorized() *TokenGrantV4Unauthorized

NewTokenGrantV4Unauthorized creates a TokenGrantV4Unauthorized with default headers values

func (*TokenGrantV4Unauthorized) Error

func (o *TokenGrantV4Unauthorized) Error() string

func (*TokenGrantV4Unauthorized) GetPayload

func (*TokenGrantV4Unauthorized) ToJSONString

func (o *TokenGrantV4Unauthorized) ToJSONString() string

type Verify2FACodeV4Accepted

type Verify2FACodeV4Accepted struct {
	Payload *iamclientmodels.OauthmodelLoginQueueTicketResponse
}

Verify2FACodeV4Accepted handles this case with default header values.

Login queue ticket returned

func NewVerify2FACodeV4Accepted

func NewVerify2FACodeV4Accepted() *Verify2FACodeV4Accepted

NewVerify2FACodeV4Accepted creates a Verify2FACodeV4Accepted with default headers values

func (*Verify2FACodeV4Accepted) Error

func (o *Verify2FACodeV4Accepted) Error() string

func (*Verify2FACodeV4Accepted) GetPayload

func (*Verify2FACodeV4Accepted) ToJSONString

func (o *Verify2FACodeV4Accepted) ToJSONString() string

type Verify2FACodeV4OK

type Verify2FACodeV4OK struct {
	Payload *iamclientmodels.OauthmodelTokenResponseV3
}

Verify2FACodeV4OK handles this case with default header values.

Token returned

func NewVerify2FACodeV4OK

func NewVerify2FACodeV4OK() *Verify2FACodeV4OK

NewVerify2FACodeV4OK creates a Verify2FACodeV4OK with default headers values

func (*Verify2FACodeV4OK) Error

func (o *Verify2FACodeV4OK) Error() string

func (*Verify2FACodeV4OK) GetPayload

func (*Verify2FACodeV4OK) ToJSONString

func (o *Verify2FACodeV4OK) ToJSONString() string

type Verify2FACodeV4Params

type Verify2FACodeV4Params 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

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

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

func NewVerify2FACodeV4Params

func NewVerify2FACodeV4Params() *Verify2FACodeV4Params

NewVerify2FACodeV4Params creates a new Verify2FACodeV4Params object with the default values initialized.

func NewVerify2FACodeV4ParamsWithContext

func NewVerify2FACodeV4ParamsWithContext(ctx context.Context) *Verify2FACodeV4Params

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

func NewVerify2FACodeV4ParamsWithHTTPClient

func NewVerify2FACodeV4ParamsWithHTTPClient(client *http.Client) *Verify2FACodeV4Params

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

func NewVerify2FACodeV4ParamsWithTimeout

func NewVerify2FACodeV4ParamsWithTimeout(timeout time.Duration) *Verify2FACodeV4Params

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

func (*Verify2FACodeV4Params) SetAuthInfoWriter

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

SetAuthInfoWriter adds the authInfoWriter to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetCode

func (o *Verify2FACodeV4Params) SetCode(code string)

SetCode adds the code to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetContext

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

SetContext adds the context to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetFactor

func (o *Verify2FACodeV4Params) SetFactor(factor string)

SetFactor adds the factor to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetFlightId

func (o *Verify2FACodeV4Params) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*Verify2FACodeV4Params) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetHTTPClientTransport

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

SetHTTPClient adds the HTTPClient Transport to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetMFAToken

func (o *Verify2FACodeV4Params) SetMFAToken(mFAToken string)

SetMFAToken adds the mfaToken to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetRememberDevice

func (o *Verify2FACodeV4Params) SetRememberDevice(rememberDevice bool)

SetRememberDevice adds the rememberDevice to the verify2fa code v4 params

func (*Verify2FACodeV4Params) SetTimeout

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

SetTimeout adds the timeout to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithCode

WithCode adds the code to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithContext

WithContext adds the context to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithFactor

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

WithFactor adds the factor to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithMFAToken

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

WithMFAToken adds the mFAToken to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithRememberDevice

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

WithRememberDevice adds the rememberDevice to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WithTimeout

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

WithTimeout adds the timeout to the verify2fa code v4 params

func (*Verify2FACodeV4Params) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type Verify2FACodeV4Reader

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

Verify2FACodeV4Reader is a Reader for the Verify2FACodeV4 structure.

func (*Verify2FACodeV4Reader) ReadResponse

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

ReadResponse reads a server response into the received o.

type Verify2FACodeV4Unauthorized

type Verify2FACodeV4Unauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

Verify2FACodeV4Unauthorized handles this case with default header values.

Unauthorized

func NewVerify2FACodeV4Unauthorized

func NewVerify2FACodeV4Unauthorized() *Verify2FACodeV4Unauthorized

NewVerify2FACodeV4Unauthorized creates a Verify2FACodeV4Unauthorized with default headers values

func (*Verify2FACodeV4Unauthorized) Error

func (*Verify2FACodeV4Unauthorized) GetPayload

func (*Verify2FACodeV4Unauthorized) ToJSONString

func (o *Verify2FACodeV4Unauthorized) ToJSONString() string

Jump to

Keyboard shortcuts

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