Authenticate

Name

Authenticate - Authenticates the user on the Auth server.

Synopsis

Namespace: LoadBalancer.Client.Auth

public Task<AuthenticateResult> Authenticate(AuthenticateParameters parameters)

Parameters

AuthenticateParameters consists of the following parameters:

• Provider string - Identifies a specific platform, such as Steam, PlayStation, Xbox.
• Token string - The authentication token generated by such platform as Steam, PlayStation, Xbox.
• Params KeyValueCollection - User-defined parameters that may be necessary for authentication purposes. They are typically utilized in custom implementations of the authentication service.
• UserName string - Identifies the username which is used for the simplified username/password authentication.
• Password string - Identifies the password which is used for the simplified username/password authentication.

Return Value

The AuthenticateResult containing:

• AuthToken string - Identifies the authentication token generated by the auth service. This token is used further to authenticate the client on all services(e.g. Auth, Jump, Game).