Changed2

[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Update External Identity Provider

Description

Update the identity provider by its identifier, if it exists

Request

URL

patch

https://sfo-vcf01.rainpole.io/v1/identity-providers/{id}

Copy

Path Parameters

string

id Required

ID of Identity Provider

Request Body

IdentityProviderSpec of type(s) application/json Required

Identity Provider Spec

Show optional properties

{
	"ldap": {
		"domainName": "string",
		"password": "string",
		"sourceDetails": {
			"groupsBaseDn": "string",
			"serverEndpoints": [
				"string"
			],
			"usersBaseDn": "string"
		},
		"type": "One among: OpenLdap, ActiveDirectory",
		"username": "string"
	},
	"name": "string",
	"oidc": {
		"clientId": "string",
		"clientSecret": "string",
		"discoveryEndpoint": "string"
	},
	"type": "string"
}

{
	"certChain": [
		"string"
	],
	"ldap": {
		"domainAlias": "string",
		"domainName": "string",
		"password": "string",
		"sourceDetails": {
			"certChain": [
				"string"
			],
			"groupsBaseDn": "string",
			"serverEndpoints": [
				"string"
			],
			"usersBaseDn": "string"
		},
		"type": "One among: OpenLdap, ActiveDirectory",
		"username": "string"
	},
	"name": "string",
	"oidc": {
		"clientId": "string",
		"clientSecret": "string",
		"discoveryEndpoint": "string"
	},
	"type": "string"
}

LdapSpec

ldap Required

The LDAP specification when the protocol is LDAP

string

name Required

The user-friendly name for the Identity Provider

OidcSpec

oidc Required

The identity management configuration when the provider is based on oidc

string

type Required

The type of Identity Identity Provider

array of string

certChain Optional

The root certificate chain required to connect to the external server

Response

200 OK Response Body>

Response Body

200 OK

Returns object of type(s) */*

204 No Content Response Body>

Response Body

204 No Content

Returns object of type(s) */*

No content

Errors

Error

400

Bad Request

Error

404

Identity Provider not found

Error

500

Internal server error

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"certChain":["string"],"ldap":{"domainAlias":"string","domainName":"string","password":"string","sourceDetails":{"certChain":["string"],"groupsBaseDn":"string","serverEndpoints":["string"],"usersBaseDn":"string"},"type":"One among: OpenLdap, ActiveDirectory","username":"string"},"name":"string","oidc":{"clientId":"string","clientSecret":"string","discoveryEndpoint":"string"},"type":"string"}' https://sfo-vcf01.rainpole.io/v1/identity-providers/{id}

vcf

What's changed in 4.5.0?

INTRODUCED

New in this version

Identity Providers Operations

post

Add Embedded Identity Source Introduced

post

Add External Identity Provider Introduced

delete

Delete External Identity Provider Introduced

delete

Delete Identity Source Introduced

get

Get All IDPs Introduced

get

Get Identity Provider By ID Introduced

patch

Update Embedded Identity Source Introduced

patch

Update External Identity Provider Introduced

Update External Identity Provider

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Response Body

204 No Content

Errors

Code Samples

cURL Command

What's changed in 4.5.0?

On This Page

Identity Providers Operations

Was this page helpful?