OidcRelyingParty

OidcRelyingParty

Information about a OIDC relying party.

JSON Example

{
    "id": "string",
    "clientId": "string",
    "clientName": "string",
    "clientSecret": "string",
    "redirectUris": [
        "string"
    ],
    "scope": [
        "string"
    ]
}

string

id

Optional

A unique identifier for the relying party.

string

clientId

Optional

System generated client id of the relying party as per RFC-7591 Section 3.2.1.

string

clientName

Required

Human readable name of the relying party.

string

clientSecret

Optional

Server generated client secret string. Must be unique for all relying parties. This field is hidden and is only returned in plaintext on a POST (during registration).

array of string

redirectUris

Required

Supported redirect URIs for this relying party.

array of string

scope

Optional

Not configurable by the client. A fixed list of the following six scope values:

• openid - as required per the OpenID Connect Core spec
• profile - as described in the OpenID Connect Core spec
• email - as described in the OpenID Connect Core spec
• phone - as described in the OpenID Connect Core spec
• groups - grants access to the groups claims.
• vcd_idp - grants access to the roles, org_id, org_display_name, and org_name claims.

Parameter To

Register Oidc Relying Party

Update Oidc Relying Party

Returned By

Get Oidc Relying Party

Regenerate Oidc Relying Party Secret

Register Oidc Relying Party

Update Oidc Relying Party