Get Identity Provider By Id

Get Identity Provider By Id

Get a specific identity irovider using its id

Request
URI
GET
https://{api_host}/v1/identity-providers/{id}
COPY
Path Parameters
string
id
Required

ID of the Identity Provider

Responses
200

OK

Returns IdentityProvider of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "type": "string",
    "domainNames": [
        "string"
    ],
    "identitySources": [
        {
            "name": "string",
            "type": "string",
            "domainNames": [
                "string"
            ],
            "ldap": {
                "type": "string",
                "domainName": "string",
                "domainAlias": "string",
                "username": "string",
                "sourceDetails": {
                    "usersBaseDn": "string",
                    "groupsBaseDn": "string",
                    "certChain": [
                        "string"
                    ],
                    "serverEndpoints": [
                        "string"
                    ]
                }
            }
        }
    ],
    "ldap": {
        "type": "string",
        "domainName": "string",
        "domainAlias": "string",
        "username": "string",
        "sourceDetails": {
            "usersBaseDn": "string",
            "groupsBaseDn": "string",
            "certChain": [
                "string"
            ],
            "serverEndpoints": [
                "string"
            ]
        }
    },
    "oidc": {
        "clientId": "string",
        "discoveryEndpoint": "string",
        "authEndpoint": "string",
        "authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
        "logoutEndpoint": "string",
        "issuer": "string",
        "publicKeyUri": "string",
        "tokenEndpoint": "string"
    },
    "status": "One among: ACTIVE, INACTIVE",
    "idpMessage": "string",
    "fedIdp": {
        "name": "string",
        "source": "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE",
        "directoryList": {
            "directoryId": "string",
            "name": "string",
            "defaultDomain": "string",
            "domains": [
                "string"
            ],
            "federatedIdpSourceType": "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE"
        },
        "oidcInfo": {
            "clientId": "string",
            "discoveryEndpoint": "string",
            "authEndpoint": "string",
            "authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
            "logoutEndpoint": "string",
            "issuer": "string",
            "publicKeyUri": "string",
            "tokenEndpoint": "string"
        },
        "syncClientTokenTTL": 0,
        "syncClientTokenInfo": {
            "expireIn": 0,
            "expireAt": "string",
            "token": "string",
            "scimUrl": "string"
        }
    }
}
string
id
Optional

ID of the Identity Provider

string
name
Optional

The user-friendly name for the Identity Provider

string
type
Optional

The type of the Identity Provider

array of string
domainNames
Optional

The Domains of the Identity Provider

array of VcIdentitySources
identitySources
Optional

The Identity Sources of the Identity Provider

LdapInfo
ldap
Optional

Represents Identity management configuration when the protocol is LDAP

OidcInfo
oidc
Optional

Represents Identity management configuration when the provider is based on OIDC

string
status
Optional

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

string
idpMessage
Optional

The message conveyed by VCF for managing the Identity Provider

FederatedIdentityProviderInfo
fedIdp
Optional

The identity management info when the provider is via broker federation


401

Unauthorized Request

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


500

Internal server error

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


On This Page
Identity Providers Operations
POST
Add Embedded Identity Source
POST
Add External Identity Provider
DELETE
Delete External Identity Provider
DELETE
Delete Identity Source
POST
Generate Sync Client Token
GET
Get Identity Provider By Id
GET
Get Identity Providers
GET
Get Sddc Ws1b Oidc Info
PATCH
Update Embedded Identity Source
PATCH
Update External Identity Provider