Resolve Tenant Identity Provider Overrides

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Resolves the IdP overrides at the tenant level. Identity providers do not support default values; therefore, if no identity provider overrides are configured at the tenant level, then the response will contain an empty array of items.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
identity-provider:readApplicationThe subject can perform this request if the tenant specified in the URL path is associated with the subject's application.
TenantThe subject can perform this request if they are associated with the tenant specified in the URL path.
Tenant Inclusion ListThe subject can perform this request if the tenant specified in the URL path is included in the tenant inclusion list.
Tenant Exclusion ListThe subject can perform this request if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list.
SelfThe subject can perform this request if the subject belongs to the tenant specified in the URL path.

Field-Level Permissions

In addition to the permissions above, the following permissions are required in order to view specific identity provider fields. If the subject does not have one of the permissions below assigned to them, the associated field will return as undefined. Also, the permission boundaries that apply to the identity-provider:read permission also apply to the field-level permissions.

PermissionDescription
identity-provider:view-protocolRequired to view the protocol field.
Path Params
string
required
length between 1 and 26

The ID of the tenant that the resource or action is scoped to.

Query Params
string
enum
length between 1 and 25

Allows for filtering identity providers by their type

string
length between 1 and 70

Allows for filtering identity providers by their name

string
enum
length between 1 and 45

Allows for filtering identity providers by their status

Allowed:
string
length ≥ 0
Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

boolean
Defaults to true

Boolean indicating if the resolve API should recurse the tenant's ancestors for the case where tenant level overrides are disabled. If set to "false", then this API will only resolve the overrides for the tenant level regardless of whether tenant level overrides are enabled or not.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json