Class PkceConfiguration

This class holds all information required to perform Proof Key Code Exchange (PKCE) authentication.

Inheritance

Object

PkceConfiguration

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.DigitalTwins.Identity

Assembly: solution.dll

Syntax

[Serializable]
public class PkceConfiguration

Fields

AllowAnonymous

Boolean value holding the capabilities of the app to support guest user access.

Declaration

public bool AllowAnonymous

Field Value

Type	Description
Boolean

AppName

The unique name of the app. Used to bind the app to browser redirection in login operation.

Declaration

public string AppName

Field Value

Type	Description
String

CacheRefreshToken

Boolean value holding the capabilities of the app to cache the refresh token.

Declaration

public bool CacheRefreshToken

Field Value

Type	Description
Boolean

Remarks

Caching the refresh token allows to skip authentication and resume a user session when the app is restarted. Set this value to false if your app requires a high security level. User will then be forced to login each time the application is started.

ClientId

The unique client identifier as registered with the authentication service.

Declaration

public string ClientId

Field Value

Type	Description
String

CustomLoginParams

The additional custom url formatted parameters to append to the LoginUrl.

Declaration

public string CustomLoginParams

Field Value

Type	Description
String

Remarks

See documentation of your authentication service to learn what additional parameters can be required.

LoginUrl

The login page url on the authentication service.

Declaration

public string LoginUrl

Field Value

Type	Description
String

LogoutUrl

The endpoint url on the authentication service to reach to revoke the set of tokens.

Declaration

public string LogoutUrl

Field Value

Type	Description
String

RefreshTokenUrl

The endpoint url on the authentication service to reach to refresh current set of tokens.

Declaration

public string RefreshTokenUrl

Field Value

Type	Description
String

TokenUrl

The endpoint url on the authentication service to reach to exchange returned login code for a valid set of tokens.

Declaration

public string TokenUrl

Field Value

Type	Description
String

Properties

DefaultConfiguration

This class holds all information required to perform authentication on default Unity authentication service.

Declaration

public static PkceConfiguration DefaultConfiguration { get; }

Property Value

Type	Description
PkceConfiguration

Methods

Sanitize()

This functions can be used after deserialization, to ensure the format is correct.

Declaration

public void Sanitize()