Add External Identity Provider

Add External Identity Provider

Add a new 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

{
    "name": "string",
    "type": "string"
}
{
    "certChain": [
        "string"
    ],
    "fedIdpSpec": {
        "directory": {
            "defaultDomain": "string",
            "directoryId": "string",
            "domains": [
                "string"
            ],
            "name": "string"
        },
        "name": "string",
        "oidcSpec": {
            "clientId": "string",
            "clientSecret": "string",
            "discoveryEndpoint": "string"
        },
        "syncClientTokenTTL": 0
    },
    "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

fedIdpSpec
Optional

The identity management configuration when the provider is via broker federation

ldap
Optional

The LDAP specification when the protocol is LDAP

string
name
Required

The user-friendly name for the Identity Provider

oidc
Optional

Identity management configuration when the Identity Provider is based on oidc

string
type
Required

The type of Identity Identity Provider

Responses
200

OK

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).

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