Get All Idps
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": [
{
"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"
}
],
"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
elements
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
"ErrorResponse Object"
array of
string
arguments
Optional
arguments
array of
cause
cause
Optional
Describes a single error cause
object
context
Optional
context
string
errorCode
Optional
errorCode
string
message
Optional
message
string
referenceToken
Optional
referenceToken
string
remediationMessage
Optional
remediationMessage
401
Unauthorized Request
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
arguments
Optional
arguments
array of
cause
cause
Optional
Describes a single error cause
object
context
Optional
context
string
errorCode
Optional
errorCode
string
message
Optional
message
string
referenceToken
Optional
referenceToken
string
remediationMessage
Optional
remediationMessage
500
Internal Server Error
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
arguments
Optional
arguments
array of
cause
cause
Optional
Describes a single error cause
object
context
Optional
context
string
errorCode
Optional
errorCode
string
message
Optional
message
string
referenceToken
Optional
referenceToken
string
remediationMessage
Optional
remediationMessage
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/identity-providers