EOS_Connect_VerifyIdTokenCallbackInfo

EOS API reference page for EOS_Connect_VerifyIdTokenCallbackInfo

Choose your implementation method:

C

C#

This data structure is part of the Connect Interface.

Remarks

Output parameters for the EOS_Connect_VerifyIdToken Function.

Properties

EOS_Connect_VerifyIdTokenCallbackInfo

Property

Value

EOS_EResult ResultCode

The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.

void* ClientData

Context that was passed into EOS_Connect_VerifyIdToken

EOS_ProductUserId ProductUserId

The Product User ID associated with the ID token.

EOS_Bool bIsAccountInfoPresent

Flag set to indicate whether account information is available. Applications must always first check this value to be set before attempting to read the AccountType, AccountId, Platform and DeviceType fields. This flag is always false for users that authenticated using EOS Connect Device ID.

EOS_EExternalAccountType AccountIdType

The identity provider that the user authenticated with to EOS Connect. If bIsAccountInfoPresent is set, this field describes the external account type.

const char* AccountId

The external account ID of the authenticated user. This value may be set to an empty string.

const char* Platform

Platform that the user is connected from. This value may be set to an empty string.

const char* DeviceType

Identifies the device type that the user is connected from. Can be used to securely verify that the user is connected through a real Console device. This value may be set to an empty string.

const char* ClientId

Client ID of the authorized client.

const char* ProductId

Product ID.

const char* SandboxId

Sandbox ID.

const char* DeploymentId

Deployment ID.

Related API Members

This data structure is part of the Connect Interface.

Remarks

Output parameters for the {ConnectInterface.VerifyIdToken} Function.

Properties

Connect.VerifyIdTokenCallbackInfo

Property

Value

Result ResultCode

The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.

object ClientData

Context that was passed into EOS_Connect_VerifyIdToken

ProductUserId ProductUserId

The Product User ID associated with the ID token.

bool IsAccountInfoPresent

Flag set to indicate whether account information is available. Applications must always first check this value to be set before attempting to read the AccountType, AccountId, Platform and DeviceType fields. This flag is always false for users that authenticated using EOS Connect Device ID.

ExternalAccountType AccountIdType

The identity provider that the user authenticated with to EOS Connect. If bIsAccountInfoPresent is set, this field describes the external account type.

Utf8String AccountId

The external account ID of the authenticated user. This value may be set to an empty string.

Utf8String Platform

Platform that the user is connected from. This value may be set to an empty string.

Utf8String DeviceType

Identifies the device type that the user is connected from. Can be used to securely verify that the user is connected through a real Console device. This value may be set to an empty string.

Utf8String ClientId

Client ID of the authorized client.

Utf8String ProductId

Product ID.

Utf8String SandboxId

Sandbox ID.

Utf8String DeploymentId

Deployment ID.

Related API Members