Changed1

[{"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

Get All IDPs

Description

Get a list of all Identity Providers

Request

Operation doesn't accept any path, query or header parameters.

URL

get

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

Copy

Response

Response Body

200 OK

Returns PageOfIdentityProvider of type(s) application/json

{
	"elements": [
		{
			"domainNames": [
				"string"
			],
			"id": "string",
			"identitySources": [
				{
					"domainNames": [
						"string"
					],
					"ldap": {
						"domainAlias": "string",
						"domainName": "string",
						"sourceDetails": {
							"certChain": [
								"string"
							],
							"groupsBaseDn": "string",
							"serverEndpoints": [
								"string"
							],
							"usersBaseDn": "string"
						},
						"type": "string",
						"username": "string"
					},
					"name": "string",
					"type": "string"
				}
			],
			"idpMessage": "string",
			"ldap": {
				"domainAlias": "string",
				"domainName": "string",
				"sourceDetails": {
					"certChain": [
						"string"
					],
					"groupsBaseDn": "string",
					"serverEndpoints": [
						"string"
					],
					"usersBaseDn": "string"
				},
				"type": "string",
				"username": "string"
			},
			"name": "string",
			"oidc": {
				"authEndpoint": "string",
				"authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
				"clientId": "string",
				"discoveryEndpoint": "string",
				"issuer": "string",
				"logoutEndpoint": "string",
				"publicKeyUri": "string",
				"tokenEndpoint": "string"
			},
			"status": "One among: ACTIVE, INACTIVE",
			"type": "string"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}

array of IdentityProvider

elements Optional

The list of elements included in this page

PageMetadata

pageMetadata Optional

Pageable elements pagination metadata information

Errors

ErrorResponse

400

Bad request

ErrorResponse

401

Unauthorized Request

ErrorResponse

500

Internal Server Error

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/identity-providers

vcf-for-vxrail

What's changed in 4.5.0?

INTRODUCED

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

Get All IDPs

Request

URL

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

What's changed in 4.5.0?

On This Page

Identity Providers Operations

Was this page helpful?