Relativity.Identity.V1.OAuth2ClientModels.OAuth2Client

OAuth2Client

public class OAuth2Client

Model representing an OAuth2 Client used with obtaining access tokens and authenticating web requests.

Documentation

public int AccessTokenLifetimeInMinutes { get; set; }

How long the access token is valid in minutes

public IList<Claim> Claims { get; set; }

List of additional claims the OAuth2 Client will recieve in access tokens. Only specific claim types are allowed by the system. Use the SupportedClaimsTypes function on the OAuth2Manager to get the list of available claim types.

public int? ContextUser { get; set; }

The user that will be used for permissions and auditing

public bool Enabled { get; set; }

Determines if authentication request are attempted or denied

public OAuth2Flow Flow { get; set; }

The flow (grant type) of the OAuth2 Client

public string Id { get; set; }

The unique Id of the OAuth2 Client

public bool IsSystem { get; set; }

Determines if the client is backend client used for management

public string Name { get; set; }

Unique name for the OAuth2 Client

public IList<Uri> RedirectUris { get; set; }

List of the Uris that the server will redirect to

public IList<string> Scopes { get; }

List of Scopes this Client is allowed to request

public string Secret { get; set; }

The current secret for the client

public OAuth2Client()

An OAuth2 Client used with obtaining access tokens and authenticating web requests.