Add External Identity Provider

Add a new external identity provider

Request

URI

POST

https://{api_host}/v1/identity-providers

COPY

Request Body

IdentityProviderSpec of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "type": "string"
}

{
    "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

Responses

201

Created

Operation doesn't return any data structure

400

Bad Request

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.

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.