Choose your implementation method:
C
C#
This data structure is part of the Auth Interface.
Remarks
A structure that contains login credentials. What is required is dependent on the type of login being initiated. This is part of the input structure EOS_Auth_LoginOptions and related to device auth. Use of the ID and Token fields differs based on the Type. They should be null, unless specified: EOS_LCT_Password - ID is the email address, and Token is the password. EOS_LCT_ExchangeCode - Token is the exchange code. EOS_LCT_PersistentAuth - If targeting console platforms, Token is the long lived refresh token. Otherwise N/A. EOS_LCT_DeviceCode - N/A. EOS_LCT_Developer - ID is the host (e.g. localhost:6547), and Token is the credential name registered in the EOS Developer Authentication Tool. EOS_LCT_RefreshToken - Token is the refresh token. EOS_LCT_AccountPortal - SystemAuthCredentialsOptions may be required if targeting mobile platforms. Otherwise N/A. EOS_LCT_ExternalAuth - Token is the external auth token specified by ExternalType.
See Also
EOS_ELoginCredentialType, EOS_Auth_Login, EOS_Auth_DeletePersistentAuthOptions
Properties
EOS_Auth_Credentials
|
Property |
Value |
|---|---|
|
int32_t ApiVersion |
API Version: Set this to EOS_AUTH_CREDENTIALS_API_LATEST. |
|
const char* Id |
ID of the user logging in, based on EOS_ELoginCredentialType |
|
const char* Token |
Credentials or token related to the user logging in |
|
Type of login. Needed to identify the auth method to use |
|
|
void* SystemAuthCredentialsOptions |
This field is for system specific options, if any. If provided, the structure will be located in (System)/eos(system).h. The structure will be named EOS(System)_Auth_CredentialsOptions. |
|
EOS_EExternalCredentialType ExternalType |
Type of external login. Needed to identify the external auth method to use. Used when login type is set to EOS_LCT_ExternalAuth, ignored for other EOS_ELoginCredentialType methods. |
This data structure is part of the Auth Interface.
Remarks
A structure that contains login credentials. What is required is dependent on the type of login being initiated. This is part of the input structure {LoginOptions} and related to device auth. Use of the ID and Token fields differs based on the Type. They should be null, unless specified: {LoginCredentialType.Password} - ID is the email address, and Token is the password. {LoginCredentialType.ExchangeCode} - Token is the exchange code. {LoginCredentialType.PersistentAuth} - If targeting console platforms, Token is the long lived refresh token. Otherwise N/A. {LoginCredentialType.DeviceCode} - N/A. {LoginCredentialType.Developer} - ID is the host (e.g. localhost:6547), and Token is the credential name registered in the EOS Developer Authentication Tool. {LoginCredentialType.RefreshToken} - Token is the refresh token. {LoginCredentialType.AccountPortal} - SystemAuthCredentialsOptions may be required if targeting mobile platforms. Otherwise N/A. {LoginCredentialType.ExternalAuth} - Token is the external auth token specified by ExternalType.
See Also
{LoginCredentialType}, {AuthInterface.Login}, {DeletePersistentAuthOptions}
Properties
Auth.Credentials
|
Property |
Value |
|---|---|
|
int ApiVersion |
API Version: Set this to EOS_AUTH_CREDENTIALS_API_LATEST. |
|
string Id |
ID of the user logging in, based on EOS_ELoginCredentialType |
|
string Token |
Credentials or token related to the user logging in |
|
LoginCredentialType Type |
Type of login. Needed to identify the auth method to use |
|
System.IntPtr SystemAuthCredentialsOptions |
This field is for system specific options, if any. If provided, the structure will be located in (System)/eos(system).h. The structure will be named EOS(System)_Auth_CredentialsOptions. |
|
ExternalCredentialType ExternalType |
Type of external login. Needed to identify the external auth method to use. Used when login type is set to EOS_LCT_ExternalAuth, ignored for other EOS_ELoginCredentialType methods. |