Changed1

[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Register OIDC Relying Party

Description

Registers a new OIDC relying party.

Request

URL

post

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

Copy

Request Body

OidcRelyingParty of type(s) application/json Required

Show optional properties

{
	"clientName": "string",
	"redirectUris": [
		"string"
	]
}

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

string

clientName Required

Human readable name of the relying party.

array of string

redirectUris Required

Supported redirect URIs for this relying party.

string

clientId Optional

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

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).

string

id Optional

A unique identifier for the 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

Response

Response Body

200 OK

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

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

string

clientName Required

Human readable name of the relying party.

array of string

redirectUris Required

Supported redirect URIs for this relying party.

string

clientId Optional

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

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).

string

id Optional

A unique identifier for the 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.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"clientId":"string","clientName":"string","clientSecret":"string","id":"string","redirectUris":["string"],"scope":["string"]}' https://{api_host}/cloudapi/1.0.0/openIdProvider/relyingParties

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-event: com/vmware/vcloud/event/oidcRelyingParty/create

vmware-cloud-director

What's changed in latest?

INTRODUCED

Availability

Added in 37.2

OIDC Relying Party Operations

delete

Delete OIDC Relying Party Introduced

get

Get OIDC Relying Party Introduced

get

Query OIDC Relying Parties Introduced

post

Regenerate OIDC Relying Party Secret Introduced

post

put

Update OIDC Relying Party Introduced

Register OIDC Relying Party

Request

URL

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

What's changed in latest?

Availability

On This Page

OIDC Relying Party Operations

Was this page helpful?