EOS_Auth_QueryIdTokenOptions

EOS API reference page for EOS_Auth_QueryIdTokenOptions

Choose your implementation method:

C

C#

This data structure is part of the Auth Interface.

Remarks

Input parameters for the EOS_Auth_QueryIdToken function.

Properties

EOS_Auth_QueryIdTokenOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_AUTH_QUERYIDTOKEN_API_LATEST.

EOS_EpicAccountId LocalUserId

The Epic Account ID of the local authenticated user.

EOS_EpicAccountId TargetAccountId

The target Epic Account ID for which to query an ID token. This account id may be the same as the input LocalUserId or another merged account id associated with the local user's Epic account. An ID token for the selected account id of a locally authenticated user will always be readily available. To retrieve it for the selected account ID, you can use EOS_Auth_CopyIdToken directly after a successful user login.

Related API Members

This data structure is part of the Auth Interface.

Remarks

Input parameters for the {AuthInterface.QueryIdToken} function.

Properties

Auth.QueryIdTokenOptions

Property

Value

int ApiVersion

API Version: Set this to EOS_AUTH_QUERYIDTOKEN_API_LATEST.

EpicAccountId LocalUserId

The Epic Account ID of the local authenticated user.

EpicAccountId TargetAccountId

The target Epic Account ID for which to query an ID token. This account id may be the same as the input LocalUserId or another merged account id associated with the local user's Epic account. An ID token for the selected account id of a locally authenticated user will always be readily available. To retrieve it for the selected account ID, you can use EOS_Auth_CopyIdToken directly after a successful user login.

Related API Members

Tags