Changed2

[{"label":"Latest (4.5.0)","version":"latest"},{"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 Identity Provider By ID

Description

Get a specific Identity Provider using it’s Id

Request

URL

get

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

Copy

Path Parameters

string

id Required

ID of the Identity Provider

Response

Response Body

200 OK

Returns IdentityProvider of type(s) application/json

{
    "status": "One among: ACTIVE, INACTIVE"
}

array of string

domainNames Optional

The Domains of the Identity Provider

string

id Optional

ID of the Identity Provider

array of VcIdentitySources

identitySources Optional

The Identity Sources of the Identity Provider

LdapInfo

ldap Optional

The LDAP configuration of the Identity Provider

string

name Optional

The user-friendly name for the Identity Provider

OidcInfo

oidc Optional

Identity management configuration when the Identity Provider is based on OIDC

string

status Optional

The status of the Identity Provider (set as ACTIVE for currently enabled Identity Provider)

string

type Optional

The type of the Identity Provider

Errors

ErrorResponse

401

Unauthorized Request

Error

500

Internal server error

Code Samples

cURL Command

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

vcf-for-vxrail

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

Get Identity Provider By ID

Request

URL

Path Parameters

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?