Get Identity Providers

Get Identity Providers

Get a list of all identity providers

Request
URI
GET
https://{api_host}/v1/identity-providers
COPY
Responses
200

OK

Returns PageOfIdentityProvider of type(s) application/json
{
    "elements": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "domainNames": [
                "string"
            ],
            "identitySources": [
                {
                    "name": "string",
                    "type": "string",
                    "domainNames": [
                        "string"
                    ],
                    "ldap": {
                        "type": "string",
                        "domainName": "string",
                        "domainAlias": "string",
                        "username": "string",
                        "sourceDetails": {
                            "usersBaseDn": "string",
                            "groupsBaseDn": "string",
                            "certChain": [
                                "string"
                            ],
                            "serverEndpoints": [
                                "string"
                            ]
                        }
                    }
                }
            ],
            "ldap": {
                "type": "string",
                "domainName": "string",
                "domainAlias": "string",
                "username": "string",
                "sourceDetails": {
                    "usersBaseDn": "string",
                    "groupsBaseDn": "string",
                    "certChain": [
                        "string"
                    ],
                    "serverEndpoints": [
                        "string"
                    ]
                }
            },
            "oidc": {
                "clientId": "string",
                "discoveryEndpoint": "string",
                "authEndpoint": "string",
                "authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
                "logoutEndpoint": "string",
                "issuer": "string",
                "publicKeyUri": "string",
                "tokenEndpoint": "string"
            },
            "status": "One among: ACTIVE, INACTIVE",
            "idpMessage": "string",
            "fedIdp": {
                "name": "string",
                "source": "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE",
                "directoryList": {
                    "directoryId": "string",
                    "name": "string",
                    "defaultDomain": "string",
                    "domains": [
                        "string"
                    ],
                    "federatedIdpSourceType": "One among: OKTA, MICROSOFT_ENTRA_ID, PING_FEDERATE"
                },
                "oidcInfo": {
                    "clientId": "string",
                    "discoveryEndpoint": "string",
                    "authEndpoint": "string",
                    "authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
                    "logoutEndpoint": "string",
                    "issuer": "string",
                    "publicKeyUri": "string",
                    "tokenEndpoint": "string"
                },
                "syncClientTokenTTL": 0,
                "syncClientTokenInfo": {
                    "expireIn": 0,
                    "expireAt": "string",
                    "token": "string",
                    "scimUrl": "string"
                }
            }
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
elements
Optional

The list of elements included in this page

pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad request

Returns ErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


401

Unauthorized Request

Returns ErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


500

Internal Server Error

Returns ErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken