Update Oidc Relying Party

Updates an OIDC relying party.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/openIdProvider/relyingParties/{id}

COPY

Path Parameters

string

Required

OIDC relying party's ID

string

Required

OIDC relying party's ID

Request Body

OidcRelyingParty of type(s) application/json

Optional

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

string

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.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns OidcRelyingParty of type(s) application/json;version=38.0

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

string

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.