List Linked Identity Providers
POSThttps://$CUSTOM-DOMAIN/management/v1/policies/login/idps/_search
Returns a list of identity providers that are linked in the login policy. This means, that they are configured for the organization and will be shown to the users. They will be shown if the organization is identified (per scope or user).
Request​
Header Parameters
x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
- application/json
- application/grpc
- application/grpc-web+proto
Bodyrequired
query object
Bodyrequired
query object
Bodyrequired
query object
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"idpId": "69629023906488334",
"idpName": "google",
"idpType": [
"IDP_TYPE_OIDC"
]
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: oauth2
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
ResponseClear