EOS_Auth_CopyIdToken

EOS API reference page for EOS_Auth_CopyIdToken

2 min read

This function is part of the Auth Interface.

Remarks

Fetch an ID token for an Epic Account ID. ID tokens are used to securely verify user identities with online services. The most common use case is using an ID token to authenticate the local user by their selected account ID, which is the account ID that should be used to access any game-scoped data for the current application. 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.

Return Value

  • EOS_Success if the information is available and passed out in OutUserIdToken

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if the Id token is not found or expired.

See Also

EOS_Auth_IdToken_Release

Parameters

EOS_Auth_CopyIdToken

Parameter Type And NameUsage Information
EOS_HAuth Handle
const EOS_Auth_CopyIdTokenOptions* OptionsStructure containing the account ID for which to copy an ID token.
EOS_Auth_IdToken** OutIdTokenAn ID token for the given user, if it exists and is valid; use EOS_Auth_IdToken_Release when finished.

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.