Get All Idps

Get All Idps

Get a list of all Identity Providers

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/identity-providers
COPY
Responses
200

OK

Returns PageOfIdentityProvider of type(s) application/json 
{
    "elements": [
        {
            "domainNames": [
                "string"
            ],
            "id": "string",
            "identitySources": [
                {
                    "domainNames": [
                        "string"
                    ],
                    "ldap": {
                        "domainAlias": "string",
                        "domainName": "string",
                        "sourceDetails": {
                            "certChain": [
                                "string"
                            ],
                            "groupsBaseDn": "string",
                            "serverEndpoints": [
                                "string"
                            ],
                            "usersBaseDn": "string"
                        },
                        "type": "string",
                        "username": "string"
                    },
                    "name": "string",
                    "type": "string"
                }
            ],
            "idpMessage": "string",
            "ldap": {
                "domainAlias": "string",
                "domainName": "string",
                "sourceDetails": {
                    "certChain": [
                        "string"
                    ],
                    "groupsBaseDn": "string",
                    "serverEndpoints": [
                        "string"
                    ],
                    "usersBaseDn": "string"
                },
                "type": "string",
                "username": "string"
            },
            "name": "string",
            "oidc": {
                "authEndpoint": "string",
                "authMethod": "One among: CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT, PRIVATE_KEY_JWT",
                "clientId": "string",
                "discoveryEndpoint": "string",
                "issuer": "string",
                "logoutEndpoint": "string",
                "publicKeyUri": "string",
                "tokenEndpoint": "string"
            },
            "status": "One among: ACTIVE, INACTIVE",
            "type": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of IdentityProvider
elements
Optional

The list of elements included in this page

PageMetadata
pageMetadata
Optional

pageMetadata


400

Bad request

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

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


401

Unauthorized Request

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

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


500

Internal Server Error

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

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


On This Page
Identity Providers Operations
POST
Add Embedded Identity Source
POST
Add External Identity Provider
DELETE
Delete External Identity Provider
DELETE
Delete Identity Source
GET
Get All Idps
GET
Get Identity Provider By Id
PATCH
Update Embedded Identity Source
PATCH
Update External Identity Provider