IdentityProviderSpec

IdentityProviderSpec
IdentityProviderSpec

Identity Provider Spec

JSON Example
{
    "name": "string",
    "type": "string",
    "certChain": [
        "string"
    ],
    "ldap": {
        "type": "One among: OpenLdap, ActiveDirectory",
        "domainName": "string",
        "domainAlias": "string",
        "username": "string",
        "password": "string",
        "sourceDetails": {
            "usersBaseDn": "string",
            "groupsBaseDn": "string",
            "certChain": [
                "string"
            ],
            "serverEndpoints": [
                "string"
            ]
        }
    },
    "oidc": {
        "clientId": "string",
        "clientSecret": "string",
        "discoveryEndpoint": "string"
    },
    "fedIdpSpec": {
        "name": "string",
        "directory": {
            "directoryId": "string",
            "name": "string",
            "defaultDomain": "string",
            "domains": [
                "string"
            ],
            "federatedIdpSourceType": "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE"
        },
        "oidcSpec": {
            "clientId": "string",
            "clientSecret": "string",
            "discoveryEndpoint": "string"
        },
        "syncClientTokenTTL": 0
    }
}
string
name
Required

The user-friendly name for the Identity Provider

string
type
Required

The type of Identity Identity Provider

array of string
certChain
Optional

The root certificate chain required to connect to the external server

LdapSpec
ldap
Optional

The LDAP specification when the protocol is LDAP

OidcSpec
oidc
Optional

Identity management configuration when the Identity Provider is based on oidc

FederatedIdentityProviderSpec
fedIdpSpec
Optional

The identity management configuration when the provider is via broker federation

Parameter To