Relativity.Identity.V2.LoginProfileModels.OpenIDConnectProvider

OpenIDConnectProvider

public class OpenIDConnectProvider : ISerializable

Represents an OpenID Connect external identity provider.

Documentation

public Uri Authority { get; set; }

The uri to the external OpenID Connect provider.

public string Caption { get; set; }

The caption text to be used for the button.

public string ClientID { get; set; }

The client identifier registered at the provider.

public string ClientSecret { get; set; }

The client secret registered at the provider. Used only in code flow.

public string Description { get; set; }

A description for this provider.

public bool DisplayOnLoginPage { get; set; }

Whether a button for this provider is displayed on the Relativity login page.

public OAuth2Flow Flow { get; set; }

The authentication flow used to communicate with the external provider.

public bool IsEnabled { get; set; }

Whether this provider is enabled.

public JITSettings JITSettings { get; set; }

An object containing properties for Just In Time Provisioning.

public string Name { get; set; }

A name for this provider; must be unique within the profile.

public IReadOnlyCollection<string> OpenIdScopes { get; set; }

The list of OpenID Connect scopes to request. 'openid' is a default scope that is included in this list of scopes.

public Uri RedirectUri { get; set; }

The redirect uri that needs to get set at the identity provider.

public string Resource { get; set; }

The target service or resource to which access is being requested.

public List<ResponseType> ResponseType { get; set; }

The response type that defines what authorization processing flow to follow.

public Uri SiteUri { get; set; }

The site uri of the Relativity instance.

public string SubjectClaimType { get; set; }

The claim type to use for getting the user's subject mapping. Defaults to "sub".

public string TrustedIPs { get; set; }

The set of trusted IP addresses that the OIDC provider is allowed to login with.

public OpenIDConnectProvider()

Represents an OpenId Connect external identity provider.

protected OpenIDConnectProvider(SerializationInfo info, StreamingContext context)

Used with deserializing an OpenIDConnectProvider object.

public void AddScope(string scope)

Add a scope to the OIDC Provider. 'openid' exists as a scope on the provider by default.

public void AddScopesRange(IEnumerable<string> scopes)

Adds a collection of scopes.

public void ClearScopes()

Clears the scopes. 'openid' is a default scope and will not be removed.

public bool ContainsScope(string scope)

Checks if the scope is already assigned to the provider.

public virtual void GetObjectData(SerializationInfo info, StreamingContext context)

Used with serializing an OpenIDConnectProvider object.

public IList<string> GetScopes()

Returns a clone of the scopes list.

public bool RemoveScope(string scope)

Remove a scope from the Provider. 'openid' is a default scope and will not be removed.

public void SetScopes(IEnumerable<string> scopes)

Sets the scopes based on an existing collection.