Authentication provider type (REST)

Authentication Provider Types are types of authentication flows that the system can be configured to allow users to authenticate. Authentication Provider Types cannot be added or removed from a system, but they can be enabled or disabled.

The OAuth2 Client Manager service allows you to interact with OAuth2 Clients from browser-based and cross-platform applications. The service provides the same set of operations as the .NET interface.

The IAuthProviderTypeManager service allows you to interact with authentication provider types from browser-based and cross-platform applications. The service provides the same set of operations as the .NET interface. For more information, see Authentication provider type (.NET) .

This page contains the following information:

Authentication provider type fundamentals

Before programmatically interacting with authentication provider types, familiarize yourself with the Relativity authentication provider user interface and review the information in the RelativityOne Documentation site.

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set the {versionNumber} placeholder to the version of the REST API that you want to use, using the format lowercase v and the version number, for example v1 or v2
  • Set other path parameters in the URLs to the Artifact ID of a given entity, for example setting {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

Use these addtional guidelines when working with authentication providers:

  • Contracts and data models related to the API are contained in the Relativity.Identity.SDK NuGet package.
  • Wrap the IAuthProviderTypeManager interface proxy in a using block.

Read an authentication provider type

Read all authentication provider types

Update an authentication provider type