AccelByte::Api::Oauth2 Class Reference

The API for getting OAuth2 access token. You should not use this directly; use UserAuthentication instead. Where the tokens are stored in memory for convenience. More...

#include <AccelByteOauth2Api.h>

Public Member Functions
	Oauth2 (FHttpRetrySchedulerBase &InHttpRef)
	Oauth2 (FHttpRetrySchedulerBase &InHttpRef, FString const &InIamServerUrl)
FAccelByteTaskWPtr	GetTokenWithAuthorizationCode (FString const &ClientId, FString const &ClientSecret, FString const &AuthorizationCode, FString const &RedirectUri, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using authorization code from AccelByte Launcher.
FAccelByteTaskWPtr	GetTokenWithAuthorizationCode (FString const &ClientId, FString const &ClientSecret, FString const &AuthorizationCode, FString const &RedirectUri, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using authorization code from AccelByte Launcher.
FAccelByteTaskWPtr	GetTokenWithPasswordCredentials (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from the user using a registered Email account.
FAccelByteTaskWPtr	GetTokenWithPasswordCredentials (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from the user using a registered Email Account with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithClientCredentials (FString const &ClientId, FString const &ClientSecret, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token from specified OAuth/IAM client.
FAccelByteTaskWPtr	GetTokenWithDeviceId (FString const &ClientId, FString const &ClientSecret, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), bool bCreateHeadless=true, TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.
FAccelByteTaskWPtr	GetTokenWithDeviceId (FString const &ClientId, FString const &ClientSecret, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), bool bCreateHeadless=true, TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.
FAccelByteTaskWPtr	GetTokenWithOtherPlatformToken (FString const &ClientId, FString const &ClientSecret, FString const &PlatformId, FString const &PlatformToken, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}, FString const &EncodedMacAddress=TEXT(""), FString const &DeviceId=TEXT(""))
	Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc.
FAccelByteTaskWPtr	GetTokenWithOtherPlatformToken (FString const &ClientId, FString const &ClientSecret, FString const &PlatformId, FString const &PlatformToken, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}, FString const &EncodedMacAddress=TEXT(""), FString const &DeviceId=TEXT(""))
	Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc. with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithRefreshToken (FString const &ClientId, FString const &ClientSecret, FString const &RefreshToken, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using specified refresh token as long as the refresh token is still valid.
FAccelByteTaskWPtr	GetTokenWithRefreshToken (FString const &ClientId, FString const &ClientSecret, FString const &RefreshToken, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using specified refresh token as long as the refresh token is still valid with 2FA enabled.
FAccelByteTaskWPtr	RefreshPlatformToken (FString const &ClientID, FString const &ClientSecret, FString const &PlatformID, FString const &PlatformToken, THandler< FPlatformTokenRefreshResponse > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token.
FAccelByteTaskWPtr	RevokeToken (FString const &AccessToken, FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Revoke specified access token to make it invalid.
FAccelByteTaskWPtr	RevokeToken (FString const &ClientId, FString const &ClientSecret, FString const &AccessToken, FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Revoke specified access token to make it invalid.
FAccelByteTaskWPtr	RevokeToken (FString const &ClientId, FString const &ClientSecret, FString const &AccessToken, FVoidHandler const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Revoke specified access token to make it invalid.
FAccelByteTaskWPtr	GetTokenWithAuthorizationCodeV3 (FString const &ClientId, FString const &ClientSecret, FString const &AuthorizationCode, FString const &RedirectUri, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using authorization code from AccelByte Launcher.
FAccelByteTaskWPtr	GetTokenWithAuthorizationCodeV3 (FString const &ClientId, FString const &ClientSecret, FString const &AuthorizationCode, FString const &RedirectUri, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using authorization code from AccelByte Launcher with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithPasswordCredentialsV3 (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, THandler< FOauth2Token > const &OnSuccess, FErrorHandler const &OnError, bool bRememberMe=false, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from the user using a registered Email account.
FAccelByteTaskWPtr	GetTokenWithPasswordCredentialsV3 (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberMe=false, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from the user using a registered Email account with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithSimultaneousPlatformToken (FString const &ClientId, FString const &ClientSecret, FString const &NativePlatformName, FString const &NativePlatformToken, FString const &SecondaryPlatformName, FString const &SecondaryPlatformToken, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Login with native platform and secondary platform. Currently support Windows only.
FAccelByteTaskWPtr	VerifyAndRememberNewDevice (FString const &ClientId, FString const &ClientSecret, FString const &MfaToken, EAccelByteLoginAuthFactorType AuthFactorType, FString const &Code, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberDevice=false, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Verify and Remember new device when user enabled 2FA.
FAccelByteTaskWPtr	CreateHeadlessAccountAndResponseToken (FString const &ClientId, FString const &ClientSecret, FString const &LinkingToken, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Log user in with create headless account after 3rd platform authenticated Will return a "user" session id.
FAccelByteTaskWPtr	AuthenticationWithPlatformLink (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, FString const &LinkingToken, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Log user in with authenticate a user account and perform platform link. It validates user's email and password.
FAccelByteTaskWPtr	VerifyToken (FString const &ClientId, FString const &ClientSecret, FString const &Token, FVoidHandler const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Verify OAuth2 token verification API.
FAccelByteTaskWPtr	GenerateOneTimeCode (FString const &AccessToken, FString const &PlatformId, THandler< FGeneratedOneTimeCode > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Generate one time linking code.
FAccelByteTaskWPtr	GenerateGameToken (FString const &ClientId, FString const &ClientSecret, FString const &Code, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Generate publisher user's game token. Required a code from request game token.
FAccelByteTaskWPtr	GenerateCodeForPublisherTokenExchange (FString const &AccessToken, FString const &PublisherNamespace, FString const &PublisherClientID, THandler< FCodeForTokenExchangeResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	This function generate a code that can be exchanged into publisher namespace token (i.e. by web portal).
FAccelByteTaskWPtr	RetrieveUserThirdPartyPlatformToken (FString const &Namespace, FString const &UserId, FString const &PlatformId, FString const &Authorization, THandler< FThirdPartyPlatformTokenData > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""))
	This function is used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members. Note: The third party platform and platform group covered for this is: (psn) ps4web, (psn) ps4, (psn) ps5, epicgames, twitch, awscognito.
FAccelByteTaskWPtr	GetTokenWithPasswordCredentialsV4 (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberMe=false, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from the user using a registered Email account with 2FA enabled and queue feature.
FAccelByteTaskWPtr	GetTokenWithDeviceIdV4 (FString const &ClientId, FString const &ClientSecret, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), bool bCreateHeadless=true, TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.
FAccelByteTaskWPtr	GetTokenWithAuthorizationCodeV4 (FString const &ClientId, FString const &ClientSecret, FString const &AuthorizationCode, FString const &RedirectUri, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using authorization code from AccelByte Launcher with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithOtherPlatformTokenV4 (FString const &ClientId, FString const &ClientSecret, FString const &PlatformId, FString const &PlatformToken, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bCreateHeadless=true, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FAccelByteLoginWithOtherPlatformOptionalParameters OptionalParams={}, FString const &DeviceId=TEXT(""), FString const &EncodedMacAddress=TEXT(""))
	Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc. with 2FA enabled.
FAccelByteTaskWPtr	VerifyAndRememberNewDeviceV4 (FString const &ClientId, FString const &ClientSecret, FString const &MfaToken, EAccelByteLoginAuthFactorType AuthFactorType, FString const &Code, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, bool bRememberDevice=false, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Verify and Remember new device when user enabled 2FA.
FAccelByteTaskWPtr	GenerateGameTokenV4 (FString const &ClientId, FString const &ClientSecret, FString const &Code, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Generate publisher user's game token. Required a code from request game token.
FAccelByteTaskWPtr	AuthenticationWithPlatformLinkV4 (FString const &ClientId, FString const &ClientSecret, FString const &Username, FString const &Password, FString const &LinkingToken, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Log user in with authenticate a user account and perform platform link. It validates user's email and password.
FAccelByteTaskWPtr	CreateHeadlessAccountAndResponseTokenV4 (FString const &ClientId, FString const &ClientSecret, FString const &LinkingToken, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Log user in with create headless account after 3rd platform authenticated Will return a "user" session id.
FAccelByteTaskWPtr	GetTokenWithSimultaneousPlatformTokenV4 (FString const &ClientId, FString const &ClientSecret, FString const &NativePlatformName, FString const &NativePlatformToken, FString const &SecondaryPlatformName, FString const &SecondaryPlatformToken, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Login with native platform and secondary platform. Currently support Windows only.
FAccelByteTaskWPtr	GetTokenWithRefreshTokenV4 (FString const &ClientId, FString const &ClientSecret, FString const &RefreshToken, THandler< FOauth2TokenV4 > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={})
	Get access token using specified refresh token as long as the refresh token is still valid with 2FA enabled.
FAccelByteTaskWPtr	GetTokenWithLoginTicket (FString const &ClientId, FString const &ClientSecret, FString const &LoginTicket, THandler< FOauth2Token > const &OnSuccess, FOAuthErrorHandler const &OnError, FString const &IamUrl=TEXT(""), TMap< FString, FString > AdditionalHeaders={}, FString const &DeviceId=TEXT(""))
	Get access token from exchange login ticket.

Detailed Description

The API for getting OAuth2 access token. You should not use this directly; use UserAuthentication instead. Where the tokens are stored in memory for convenience.

Member Function Documentation

AuthenticationWithPlatformLink()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::AuthenticationWithPlatformLink	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		FString const &	LinkingToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Log user in with authenticate a user account and perform platform link. It validates user's email and password.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
LinkingToken	Platform Linking Token.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

AuthenticationWithPlatformLinkV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::AuthenticationWithPlatformLinkV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		FString const &	LinkingToken,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Log user in with authenticate a user account and perform platform link. It validates user's email and password.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
LinkingToken	Platform Linking Token.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateHeadlessAccountAndResponseToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::CreateHeadlessAccountAndResponseToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	LinkingToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Log user in with create headless account after 3rd platform authenticated Will return a "user" session id.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
LinkingToken	Platform Linking Token.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

CreateHeadlessAccountAndResponseTokenV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::CreateHeadlessAccountAndResponseTokenV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	LinkingToken,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Log user in with create headless account after 3rd platform authenticated Will return a "user" session id.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
LinkingToken	Platform Linking Token.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateCodeForPublisherTokenExchange()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GenerateCodeForPublisherTokenExchange	(	FString const &	AccessToken,
		FString const &	PublisherNamespace,
		FString const &	PublisherClientID,
		THandler< FCodeForTokenExchangeResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

This function generate a code that can be exchanged into publisher namespace token (i.e. by web portal).

Parameters

AccessToken	Player's access token.
PublisherNamespace	The targeted game's publisher Namespace.
PublisherClientID	The targeted game's publisher ClientID.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateGameToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GenerateGameToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Code,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Generate publisher user's game token. Required a code from request game token.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The IAM service URL used to call the API.
Code	code from request game token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateGameTokenV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GenerateGameTokenV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Code,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Generate publisher user's game token. Required a code from request game token.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The IAM service URL used to call the API.
Code	code from request game token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GenerateOneTimeCode()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GenerateOneTimeCode	(	FString const &	AccessToken,
		FString const &	PlatformId,
		THandler< FGeneratedOneTimeCode > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Generate one time linking code.

Parameters

AccessToken	user Access Token or rather, Session Id.
PlatformId	The PlatformId. The platform ID.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithAuthorizationCode() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithAuthorizationCode	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AuthorizationCode,
		FString const &	RedirectUri,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using authorization code from AccelByte Launcher.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AuthorizationCode	This should be filled with "JUSTICE_AUTHORIZATION_CODE" environment variable.
RedirectUri	The URL the IAM server will redirect you to when the operation succeeded. Again, this doesn't work at all. Do not use this function!!!
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithAuthorizationCode() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithAuthorizationCode	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AuthorizationCode,
		FString const &	RedirectUri,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using authorization code from AccelByte Launcher.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AuthorizationCode	This should be filled with "JUSTICE_AUTHORIZATION_CODE" environment variable.
RedirectUri	The URL the IAM server will redirect you to when the operation succeeded. Again, this doesn't work at all. Do not use this function!!!
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithAuthorizationCodeV3() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithAuthorizationCodeV3	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AuthorizationCode,
		FString const &	RedirectUri,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using authorization code from AccelByte Launcher.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AuthorizationCode	This should be filled with "JUSTICE_AUTHORIZATION_CODE" environment variable.
RedirectUri	The URL the IAM server will redirect you to when the operation succeeded. Again, this doesn't work at all. Do not use this function!!!
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Note

When 2FA is enabled please use the method with FOAuthErrorHandler to get more details about the OAuth errors.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithAuthorizationCodeV3() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithAuthorizationCodeV3	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AuthorizationCode,
		FString const &	RedirectUri,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using authorization code from AccelByte Launcher with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AuthorizationCode	This should be filled with "JUSTICE_AUTHORIZATION_CODE" environment variable.
RedirectUri	The URL the IAM server will redirect you to when the operation succeeded. Again, this doesn't work at all. Do not use this function!!!
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithAuthorizationCodeV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithAuthorizationCodeV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AuthorizationCode,
		FString const &	RedirectUri,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using authorization code from AccelByte Launcher with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AuthorizationCode	This should be filled with "JUSTICE_AUTHORIZATION_CODE" environment variable.
RedirectUri	The URL the IAM server will redirect you to when the operation succeeded. Again, this doesn't work at all. Do not use this function!!!
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithClientCredentials()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithClientCredentials	(	FString const &	ClientId,
		FString const &	ClientSecret,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token from specified OAuth/IAM client.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithDeviceId() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithDeviceId	(	FString const &	ClientId,
		FString const &	ClientSecret,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		bool	bCreateHeadless = true,
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithDeviceId() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithDeviceId	(	FString const &	ClientId,
		FString const &	ClientSecret,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		bool	bCreateHeadless = true,
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithDeviceIdV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithDeviceIdV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		bool	bCreateHeadless = true,
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token using the user's device information and its unique Id. This will automatically obtain user's device information using a utilities function.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithLoginTicket()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithLoginTicket	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	LoginTicket,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from exchange login ticket.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Data	The Data required to exchange, also contain the login ticket itself.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithOtherPlatformToken() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithOtherPlatformToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	PlatformId,
		FString const &	PlatformToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FAccelByteLoginWithOtherPlatformOptionalParameters	OptionalParams = {},
		FString const &	EncodedMacAddress = TEXT(""),
		FString const &	DeviceId = TEXT("") )

Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
PlatformId	The PlatformId. The platform ID.
PlatformToken	The Token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.
OptionalParams	Will be passed to the backend.

Note

When 2FA is enabled please use the method with FOAuthErrorHandler to get more details about the OAuth errors.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithOtherPlatformToken() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithOtherPlatformToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	PlatformId,
		FString const &	PlatformToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bCreateHeadless = true,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FAccelByteLoginWithOtherPlatformOptionalParameters	OptionalParams = {},
		FString const &	EncodedMacAddress = TEXT(""),
		FString const &	DeviceId = TEXT("") )

Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc. with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
PlatformId	The PlatformId. The platform ID.
PlatformToken	The Token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
bCreateHeadless	(optional) A boolean flag to specify new account creation if needed, default value is true
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.
OptionalParams	Will be passed to the backend.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithOtherPlatformTokenV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithOtherPlatformTokenV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	PlatformId,
		FString const &	PlatformToken,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bCreateHeadless = true,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FAccelByteLoginWithOtherPlatformOptionalParameters	OptionalParams = {},
		FString const &	DeviceId = TEXT(""),
		FString const &	EncodedMacAddress = TEXT("") )

Get access token from the user with their native platform account, e.g., Steam, Google, Facebook, Twitter, Twitch, etc. with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
PlatformId	The PlatformId. The platform ID.
PlatformToken	The Token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
bCreateHeadless	(optional) A boolean flag to specify new account creation if needed, default value is true
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.
OptionalParams	Will be passed to the backend.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithPasswordCredentials() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithPasswordCredentials	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from the user using a registered Email account.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithPasswordCredentials() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithPasswordCredentials	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from the user using a registered Email Account with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithPasswordCredentialsV3() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithPasswordCredentialsV3	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bRememberMe = false,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from the user using a registered Email account.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
bRememberMe	This will use for refresh token expiration extension, default value is false.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Note

When 2FA is enabled please use the method with FOAuthErrorHandler to get more details about the OAuth errors.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithPasswordCredentialsV3() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithPasswordCredentialsV3	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bRememberMe = false,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from the user using a registered Email account with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
bRememberMe	This will use for refresh token expiration extension, default value is false.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithPasswordCredentialsV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithPasswordCredentialsV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Username,
		FString const &	Password,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bRememberMe = false,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Get access token from the user using a registered Email account with 2FA enabled and queue feature.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Username	The email address.
Password	The password.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
bRememberMe	This will use for refresh token expiration extension, default value is false.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithRefreshToken() [1/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithRefreshToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	RefreshToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using specified refresh token as long as the refresh token is still valid.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
RefreshToken	The issued refresh token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithRefreshToken() [2/2]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithRefreshToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	RefreshToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using specified refresh token as long as the refresh token is still valid with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
RefreshToken	The issued refresh token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithRefreshTokenV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithRefreshTokenV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	RefreshToken,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Get access token using specified refresh token as long as the refresh token is still valid with 2FA enabled.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
RefreshToken	The issued refresh token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithSimultaneousPlatformToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithSimultaneousPlatformToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	NativePlatformName,
		FString const &	NativePlatformToken,
		FString const &	SecondaryPlatformName,
		FString const &	SecondaryPlatformToken,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Login with native platform and secondary platform. Currently support Windows only.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
NativePlatformName	From the native subsystem
NativePlatformToken	The auth ticket from native identity interface
SecondaryPlatformName	From the secondary platform subsystem
SecondaryPlatformToken	The auth ticket from secondary platform interface
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

GetTokenWithSimultaneousPlatformTokenV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::GetTokenWithSimultaneousPlatformTokenV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	NativePlatformName,
		FString const &	NativePlatformToken,
		FString const &	SecondaryPlatformName,
		FString const &	SecondaryPlatformToken,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Login with native platform and secondary platform. Currently support Windows only.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
NativePlatformName	From the native subsystem
NativePlatformToken	The auth ticket from native identity interface
SecondaryPlatformName	From the secondary platform subsystem
SecondaryPlatformToken	The auth ticket from secondary platform interface
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RefreshPlatformToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::RefreshPlatformToken	(	FString const &	ClientID,
		FString const &	ClientSecret,
		FString const &	PlatformID,
		FString const &	PlatformToken,
		THandler< FPlatformTokenRefreshResponse > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Refresh the platform token that is stored in the IAM backend. Therefore we can prevent expiration on the backend. This endpoint also not generate any event or AB Access/Refresh Token.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
PlatformID	The targeted platform to be refreshed.
PlatformToken	The platform token that will used to refresh IAM storage.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RetrieveUserThirdPartyPlatformToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::RetrieveUserThirdPartyPlatformToken	(	FString const &	Namespace,
		FString const &	UserId,
		FString const &	PlatformId,
		FString const &	Authorization,
		THandler< FThirdPartyPlatformTokenData > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT("") )

This function is used for retrieving third party platform token for user that login using third party, if user have not link requested platform in game namespace, will try to retrieving third party platform token from publisher namespace. Passing platform group name or it's member will return same access token that can be used across the platform members. Note: The third party platform and platform group covered for this is: (psn) ps4web, (psn) ps4, (psn) ps5, epicgames, twitch, awscognito.

Parameters

Namespace	User's namespace
UserId	UserId.
PlatformId	Platform type value.
Authorization	Authorization.
OnSuccess	This will be called when the operation succeeded. The result is FThirdPartyPlatformTokenData.
OnError	This will be called when the operation failed.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RevokeToken() [1/3]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::RevokeToken	(	FString const &	AccessToken,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Revoke specified access token to make it invalid.

Parameters

AccessToken	Specified Access Token.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RevokeToken() [2/3]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::RevokeToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AccessToken,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Revoke specified access token to make it invalid.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AccessToken	user Access Token or rather, Session Id.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

RevokeToken() [3/3]

FAccelByteTaskWPtr AccelByte::Api::Oauth2::RevokeToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	AccessToken,
		FVoidHandler const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {} )

Revoke specified access token to make it invalid.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
AccessToken	user Access Token or rather, Session Id.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

VerifyAndRememberNewDevice()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::VerifyAndRememberNewDevice	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	MfaToken,
		EAccelByteLoginAuthFactorType	AuthFactorType,
		FString const &	Code,
		THandler< FOauth2Token > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bRememberDevice = false,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Verify and Remember new device when user enabled 2FA.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
MfaToken	Multi Factor Authentication Code, got error when user login with new device.
AuthFactorType	Type of authentication factor. Could be "EAccelByteLoginAuthFactorType::Authenticator" or "EAccelByteLoginAuthFactorType::BackupCode".
Code	Code to verify new device, could be obtain by 3rd party authenticator app or back up code depend on what type of AuthFactor user set as default
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
bRememberDevice	This will use for refresh token expiration extension, default value is false.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

VerifyAndRememberNewDeviceV4()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::VerifyAndRememberNewDeviceV4	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	MfaToken,
		EAccelByteLoginAuthFactorType	AuthFactorType,
		FString const &	Code,
		THandler< FOauth2TokenV4 > const &	OnSuccess,
		FOAuthErrorHandler const &	OnError,
		bool	bRememberDevice = false,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Verify and Remember new device when user enabled 2FA.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
MfaToken	Multi Factor Authentication Code, got error when user login with new device.
AuthFactorType	Type of authentication factor. Could be "EAccelByteLoginAuthFactorType::Authenticator" or "EAccelByteLoginAuthFactorType::BackupCode".
Code	Code to verify new device, could be obtain by 3rd party authenticator app or back up code depend on what type of AuthFactor user set as default
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
bRememberDevice	This will use for refresh token expiration extension, default value is false.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.

VerifyToken()

FAccelByteTaskWPtr AccelByte::Api::Oauth2::VerifyToken	(	FString const &	ClientId,
		FString const &	ClientSecret,
		FString const &	Token,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	IamUrl = TEXT(""),
		TMap< FString, FString >	AdditionalHeaders = {},
		FString const &	DeviceId = TEXT("") )

Verify OAuth2 token verification API.

Parameters

ClientId	The issued OAuth2 client credentials.
ClientSecret	The issued OAuth2 client credentials.
Token	Token to be verified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsOauth2Session.
OnError	This will be called when the operation failed.
IamUrl	(optional) The IAM service URL used to call the API, if it's an empty string then the value from FRegistry is used instead.
AdditionalHeaders	(optional) Additional headers that will be added to the HTTP Request.

Returns

AccelByteTask object to track and cancel the ongoing API operation.