IdentityProvider

IdentityProvider
IdentityProvider

Represents Identity Provider and its attributes

JSON Example 
{
    "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
Read-Only

ID of the Identity Provider

string
name
Read-Only

The user-friendly name for the Identity Provider

string
type
Read-Only

The type of the Identity Provider

array of string
domainNames
Read-Only

The Domains of the Identity Provider

array of VcIdentitySources
identitySources
Read-Only

The Identity Sources of the Identity Provider

LdapInfo
ldap
Read-Only

Represents Identity management configuration when the protocol is LDAP

OidcInfo
oidc
Read-Only

Represents Identity management configuration when the provider is based on OIDC

string
status
Read-Only

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

string
idpMessage
Read-Only

The message conveyed by VCF for managing the Identity Provider

FederatedIdentityProviderInfo
fedIdp
Read-Only

The identity management info when the provider is via broker federation

Property Of
Returned By