EOS API reference page for EOS_Auth_CopyUserAuthToken

2 mins to read

This function is part of the Auth Interface.


Fetch a user auth token for an Epic Account ID. A user authentication token allows any code with possession (backend/client) to perform certain actions on behalf of the user. Because of this, for the purposes of user identity verification, the EOS_Auth_CopyIdToken API should be used instead.

Return Value

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

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

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

See Also




Parameter Type And NameUsage Information
EOS_HAuth Handle
const EOS_Auth_CopyUserAuthTokenOptions* OptionsStructure containing the api version of CopyUserAuthToken to use
EOS_EpicAccountId LocalUserIdThe Epic Account ID of the user being queried
EOS_Auth_Token** OutUserAuthTokenThe auth token for the given user, if it exists and is valid; use EOS_Auth_Token_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.