FederatedIdentityProvider

FederatedIdentityProvider
FederatedIdentityProvider

Identity provider configuration

JSON Example 
{
    "certificateChain": [
        "string"
    ],
    "createdAt": 0,
    "directories": [
        {
            "defaultDomain": "string",
            "domains": [
                "string"
            ],
            "id": "string",
            "name": "string"
        }
    ],
    "id": "string",
    "idpConfig": {
        "oidcConfiguration": {
            "clientId": "string",
            "clientSecret": "string",
            "discoveryEndpoint": "string",
            "internalUserIdentifierAttribute": "string",
            "openIdUserIdentifierAttribute": "string"
        },
        "samlConfiguration": {
            "authenticationContext": "string",
            "metadataSourceType": "string",
            "metadataUrl": "string",
            "metadataXml": "string",
            "nameIdAttributeMappings": [
                {
                    "idpAttribute": "string",
                    "vidbAttribute": "string"
                }
            ],
            "nameIdFormatType": "string"
        }
    },
    "idpProtocol": "string",
    "idpType": "string",
    "name": "string",
    "provisionType": "string",
    "provisioningConfig": {
        "jitConfiguration": {
            "jitProvisioningGroups": [
                {
                    "domain": "string",
                    "groupNames": [
                        "string"
                    ]
                }
            ],
            "oidcJitConfiguration": {
                "internalUserIdentifierAttribute": "string",
                "openIdUserIdentifierAttribute": "string",
                "userAttributeMappings": [
                    {
                        "attributeName": "string",
                        "directoryName": "string"
                    }
                ]
            },
            "samlJitConfiguration": {
                "groupMembershipAttribute": "string",
                "passthroughClaimNames": [
                    "string"
                ]
            }
        },
        "ldapConfigurations": [
            {
                "domains": [
                    "string"
                ],
                "ldapBindConfiguration": {
                    "baseDn": "string",
                    "bindDn": "string",
                    "bindDnPassword": "string",
                    "communicationMode": "string",
                    "directorySearchAttribute": "string",
                    "dnsLookupCertificateChain": [
                        "string"
                    ],
                    "domainChanged": false,
                    "openLdapConfiguration": {
                        "bindUserFilterQuery": "string",
                        "directorySearchGroupAttribute": "string",
                        "directorySearchUserAttribute": "string",
                        "groupsFilterQuery": "string",
                        "membershipAttribute": "string",
                        "objectUuidAttribute": "string",
                        "uniquelyIdentifiableAttributeForGroup": "string",
                        "uniquelyIdentifiableAttributeForUser": "string",
                        "userMembershipsFilterQuery": "string",
                        "usersFilterQuery": "string"
                    },
                    "primaryDomainController": {
                        "certificate": "string",
                        "certificateName": "string",
                        "host": "string",
                        "port": 0,
                        "protocol": "string"
                    },
                    "secondaryDomainController": {
                        "certificate": "string",
                        "certificateName": "string",
                        "host": "string",
                        "port": 0,
                        "protocol": "string"
                    },
                    "syncMode": "string",
                    "type": "string"
                },
                "ldapConfigurationId": "string",
                "name": "string"
            }
        ]
    },
    "ssoRealmId": "string",
    "updatedAt": 0
}
array of string
certificateChain
Optional

List of certificate chain

integer As int64 As int64
createdAt
Optional

IDP creation timestamp

array of IdpDirectory
directories
Optional
Constraints: minItems: 0 maxItems: 1

IDP directory. Currently, only one directory is supported as part of IDP configuration.

string As uuid As uuid
id
Optional

Identity Provider Id

IdpConfig
idpConfig
Optional

IDP Configuration Details

string
idpProtocol
Required  

Indicates IDP Protocol.

Enumeration: OIDC, SAML, LDAP_BIND, UNKNOWN
string
idpType
Required  

Indicates IDP type

Enumeration: OKTA, PING, ENTRA_ID, SYMANTEC_IDSP, ADFS, ADLDAP, OPENLDAP, OTHER, UNKNOWN
string
name
Required  
Constraints: minLength: 1

Identity Provider name

string
provisionType
Required  

Indicates provision type for the given IDP configuration

Enumeration: JIT, SCIM, LDAP, UNKNOWN
ProvisioningConfig
provisioningConfig
Optional

User and Groups provisioning configuration

string As uuid As uuid
ssoRealmId
Required  

ID of the SSO Realm that has this Identity Provider configuration.

integer As int64 As int64
updatedAt
Optional

IDP last updated timestamp

Parameter To
Returned By