Add External Identity Provider

Add an External Identity Provider

Request

URI

POST

https://sfo-vcf01.rainpole.io/v1/identity-providers

COPY

Request Body

IdentityProviderSpec of type(s) application/json

Optional

Show optional properties

{
    "ldap": {
        "domainName": "string",
        "password": "string",
        "sourceDetails": {
            "groupsBaseDn": "string",
            "serverEndpoints": [
                {}
            ],
            "usersBaseDn": "string"
        },
        "type": "One among: OpenLdap, ActiveDirectory",
        "username": "string"
    },
    "name": "string",
    "oidc": {
        "clientId": "string",
        "clientSecret": "string",
        "discoveryEndpoint": "string"
    },
    "type": "string"
}

{
    "certChain": [
        "string"
    ],
    "ldap": {
        "domainAlias": "string",
        "domainName": "string",
        "password": "string",
        "sourceDetails": {
            "certChain": [
                "string"
            ],
            "groupsBaseDn": "string",
            "serverEndpoints": [
                "string"
            ],
            "usersBaseDn": "string"
        },
        "type": "One among: OpenLdap, ActiveDirectory",
        "username": "string"
    },
    "name": "string",
    "oidc": {
        "clientId": "string",
        "clientSecret": "string",
        "discoveryEndpoint": "string"
    },
    "type": "string"
}

array of string

certChain

Optional

The root certificate chain required to connect to the external server

LdapSpec

ldap

Required

The LDAP specification when the protocol is LDAP

string

name

Required

The user-friendly name for the Identity Provider

OidcSpec

oidc

Required

Identity management configuration when the Identity Provider is based on oidc

string

type

Required

The type of Identity Identity Provider

Responses

200

Operation doesn't return any data structure

201

Created

Operation doesn't return any data structure

400

Bad Request

Returns Error of type(s) */*

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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.

string

remediationMessage

Optional

The localized remediation error message

500

Internal server error

Returns Error of type(s) */*

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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