Class SignInWithExternalTokenRequest

the request body for external token authentication

Inheritance

object

SignInWithExternalTokenRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.PlayerAuthentication

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "SignInWithExternalTokenRequest")]
[Preserve]
public class SignInWithExternalTokenRequest

Constructors

SignInWithExternalTokenRequest(string, bool, string, OculusConfig, AppleGameCenterConfig, SteamConfig)

Initializes a new instance of the SignInWithExternalTokenRequest class.

Declaration

[Preserve]
public SignInWithExternalTokenRequest(string nonce = null, bool signInOnly = false, string token = null, OculusConfig oculusConfig = null, AppleGameCenterConfig appleGameCenterConfig = null, SteamConfig steamConfig = null)

Parameters

Type	Name	Description
string	nonce	String value used to associate a client session with an Id token, and to mitigate replay attacks. If this field is provided, the nonce claim in response Id token has a matching value..
bool	signInOnly	Whether the API should only attempt to sign-in and do not create a new player if the player does not exist..
string	token	External token that can be verified to represent a player from the id provider. This may be an id token or an access token. (required).
OculusConfig	oculusConfig	oculusConfig.
AppleGameCenterConfig	appleGameCenterConfig	appleGameCenterConfig.
SteamConfig	steamConfig	steamConfig.

Properties

AppleGameCenterConfig

Gets or Sets AppleGameCenterConfig

Declaration

[DataMember(Name = "appleGameCenterConfig", EmitDefaultValue = false)]
[Preserve]
public AppleGameCenterConfig AppleGameCenterConfig { get; set; }

Property Value

Type	Description
AppleGameCenterConfig

Nonce

String value used to associate a client session with an Id token, and to mitigate replay attacks. If this field is provided, the nonce claim in response Id token has a matching value.

Declaration

[DataMember(Name = "nonce", EmitDefaultValue = false)]
[Preserve]
public string Nonce { get; set; }

Property Value

Type	Description
string	String value used to associate a client session with an Id token, and to mitigate replay attacks. If this field is provided, the nonce claim in response Id token has a matching value.

OculusConfig

Gets or Sets OculusConfig

Declaration

[DataMember(Name = "oculusConfig", EmitDefaultValue = false)]
[Preserve]
public OculusConfig OculusConfig { get; set; }

Property Value

Type	Description
OculusConfig

SignInOnly

Whether the API should only attempt to sign-in and do not create a new player if the player does not exist.

Declaration

[DataMember(Name = "signInOnly", EmitDefaultValue = true)]
[Preserve]
public bool SignInOnly { get; set; }

Property Value

Type	Description
bool	Whether the API should only attempt to sign-in and do not create a new player if the player does not exist.

SteamConfig

Gets or Sets SteamConfig

Declaration

[DataMember(Name = "steamConfig", EmitDefaultValue = false)]
[Preserve]
public SteamConfig SteamConfig { get; set; }

Property Value

Type	Description
SteamConfig

Token

External token that can be verified to represent a player from the id provider. This may be an id token or an access token.

Declaration

[DataMember(Name = "token", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Token { get; set; }

Property Value

Type	Description
string	External token that can be verified to represent a player from the id provider. This may be an id token or an access token.