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

Update Open ID Provider Configuration

Description

Updates the OpenID Provider configuration.

Request

URL

put

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

Copy

Request Body

OpenIdProviderConfiguration of type(s) application/json Required

The updated OpenID Provider configuration.

Show optional properties

{
	"accessTokenTimeToLive": 0,
	"activeKey": {},
	"allowHttp": false,
	"authorizationCodeTimeToLive": 0,
	"idTokenTimeToLive": 0,
	"wellKnownEndpoint": "string"
}

{
	"accessTokenTimeToLive": 0,
	"activeKey": {
		"id": "string",
		"name": "string"
	},
	"allowHttp": false,
	"authorizationCodeTimeToLive": 0,
	"idTokenTimeToLive": 0,
	"wellKnownEndpoint": "string"
}

integer as int64

accessTokenTimeToLive Required

Access Token time to live (ttl) in seconds

EntityReference

activeKey Required

Entity reference of the active OpenID Provider key, which will be presented in the jwks endpoint.

boolean

allowHttp Required

Determines whether relying party redirect URIs may be http

integer as int64

authorizationCodeTimeToLive Required

Authorization Code time to live (ttl) in seconds

integer as int64

idTokenTimeToLive Required

ID Token time to live (ttl) in seconds

string as uri

wellKnownEndpoint Required

OpenID Provider endpoint serving provider configuration values (as described in OpenId Spec 4.1)

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

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

{
	"accessTokenTimeToLive": 0,
	"activeKey": {
		"id": "string",
		"name": "string"
	},
	"allowHttp": false,
	"authorizationCodeTimeToLive": 0,
	"idTokenTimeToLive": 0,
	"wellKnownEndpoint": "string"
}

integer as int64

accessTokenTimeToLive Required

Access Token time to live (ttl) in seconds

EntityReference

activeKey Required

Entity reference of the active OpenID Provider key, which will be presented in the jwks endpoint.

boolean

allowHttp Required

Determines whether relying party redirect URIs may be http

integer as int64

authorizationCodeTimeToLive Required

Authorization Code time to live (ttl) in seconds

integer as int64

idTokenTimeToLive Required

ID Token time to live (ttl) in seconds

string as uri

wellKnownEndpoint Required

OpenID Provider endpoint serving provider configuration values (as described in OpenId Spec 4.1)

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"accessTokenTimeToLive":0,"activeKey":{"id":"string","name":"string"},"allowHttp":false,"authorizationCodeTimeToLive":0,"idTokenTimeToLive":0,"wellKnownEndpoint":"string"}' https://{api_host}/cloudapi/1.0.0/openIdProvider

Vendor Extensions

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

x-vcloud-event: com/vmware/vcloud/event/openIdProviderConfiguration/modify

vmware-cloud-director

What's changed in latest?

INTRODUCED

Availability

Added in 37.2

Open ID Provider Configuration Operations

get

Get Open ID Provider Configuration Introduced

put

Update Open ID Provider Configuration Introduced

Update Open ID Provider Configuration

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

Open ID Provider Configuration Operations

Was this page helpful?