[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Update Embedded Identity Source

Description

Update the identity source associated with the embedded IDP by name, if it exists

Request

Request

URL

URL


patch
https://sfo-vcf01.rainpole.io/v1/identity-providers/{id}/identity-sources/{domainName}
Copy

Path Parameters

Path Parameters

string
id Required

ID of Identity Provider


string
domainName Required

Domain Name associated with the identity source


Request Body

Request Body

IdentitySourceSpec of type(s) application/json Required

Identity Source Spec

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

The LDAP specification when the protocol is LDAP


string
name Required

The user-friendly name for the identity Source

Response

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

Errors

Error
400

Bad Request


Error
404

Identity Source not found


Error
500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"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"}' https://sfo-vcf01.rainpole.io/v1/identity-providers/{id}/identity-sources/{domainName}


[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?