List Identity Providers
POSThttps://$CUSTOM-DOMAIN/management/v1/idps/templates/_search
List Identity Providers
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
queries object[]
Bodyrequired
query object
queries object[]
Bodyrequired
query object
queries 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": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "Google",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"type": "PROVIDER_TYPE_UNSPECIFIED",
"config": {
"options": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true,
"autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
},
"ldap": {
"servers": [
"string"
],
"startTls": true,
"baseDn": "string",
"bindDn": "string",
"userBase": "string",
"userObjectClasses": [
"string"
],
"userFilters": [
"string"
],
"timeout": "string",
"attributes": {
"idAttribute": "string",
"firstNameAttribute": "string",
"lastNameAttribute": "string",
"displayNameAttribute": "string",
"nickNameAttribute": "string",
"preferredUsernameAttribute": "string",
"emailAttribute": "string",
"emailVerifiedAttribute": "string",
"phoneAttribute": "string",
"phoneVerifiedAttribute": "string",
"preferredLanguageAttribute": "string",
"avatarUrlAttribute": "string",
"profileAttribute": "string"
},
"rootCa": "string"
},
"google": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"oauth": {
"clientId": "client-id",
"authorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
"tokenEndpoint": "https://oauth2.googleapis.com/token",
"userEndpoint": "https://openidconnect.googleapis.com/v1/userinfo",
"scopes": [
"openid",
"profile",
"email"
],
"idAttribute": "user_id",
"usePkce": true
},
"oidc": {
"issuer": "https://accounts.google.com/",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
],
"isIdTokenMapping": true,
"usePkce": true
},
"jwt": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"github": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"githubEs": {
"clientId": "client-id",
"authorizationEndpoint": "string",
"tokenEndpoint": "string",
"userEndpoint": "string",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlab": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlabSelfHosted": {
"issuer": "string",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"azureAd": {
"clientId": "client-id",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
]
},
"apple": {
"clientId": "com.client.id",
"teamId": "ALT03JV3OS",
"keyId": "OGKDK25KD",
"scopes": [
"name",
"email"
]
},
"saml": {
"metadataXml": "string",
"binding": "SAML_BINDING_UNSPECIFIED",
"withSignedRequest": true,
"nameIdFormat": "SAML_NAME_ID_FORMAT_UNSPECIFIED",
"transientMappingAttributeName": "string",
"federatedLogoutEnabled": true
}
}
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "Google",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"type": "PROVIDER_TYPE_UNSPECIFIED",
"config": {
"options": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true,
"autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
},
"ldap": {
"servers": [
"string"
],
"startTls": true,
"baseDn": "string",
"bindDn": "string",
"userBase": "string",
"userObjectClasses": [
"string"
],
"userFilters": [
"string"
],
"timeout": "string",
"attributes": {
"idAttribute": "string",
"firstNameAttribute": "string",
"lastNameAttribute": "string",
"displayNameAttribute": "string",
"nickNameAttribute": "string",
"preferredUsernameAttribute": "string",
"emailAttribute": "string",
"emailVerifiedAttribute": "string",
"phoneAttribute": "string",
"phoneVerifiedAttribute": "string",
"preferredLanguageAttribute": "string",
"avatarUrlAttribute": "string",
"profileAttribute": "string"
},
"rootCa": "string"
},
"google": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"oauth": {
"clientId": "client-id",
"authorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
"tokenEndpoint": "https://oauth2.googleapis.com/token",
"userEndpoint": "https://openidconnect.googleapis.com/v1/userinfo",
"scopes": [
"openid",
"profile",
"email"
],
"idAttribute": "user_id",
"usePkce": true
},
"oidc": {
"issuer": "https://accounts.google.com/",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
],
"isIdTokenMapping": true,
"usePkce": true
},
"jwt": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"github": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"githubEs": {
"clientId": "client-id",
"authorizationEndpoint": "string",
"tokenEndpoint": "string",
"userEndpoint": "string",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlab": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlabSelfHosted": {
"issuer": "string",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"azureAd": {
"clientId": "client-id",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
]
},
"apple": {
"clientId": "com.client.id",
"teamId": "ALT03JV3OS",
"keyId": "OGKDK25KD",
"scopes": [
"name",
"email"
]
},
"saml": {
"metadataXml": "string",
"binding": "SAML_BINDING_UNSPECIFIED",
"withSignedRequest": true,
"nameIdFormat": "SAML_NAME_ID_FORMAT_UNSPECIFIED",
"transientMappingAttributeName": "string",
"federatedLogoutEnabled": true
}
}
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"state": "IDP_STATE_UNSPECIFIED",
"name": "Google",
"owner": "IDP_OWNER_TYPE_UNSPECIFIED",
"type": "PROVIDER_TYPE_UNSPECIFIED",
"config": {
"options": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true,
"autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
},
"ldap": {
"servers": [
"string"
],
"startTls": true,
"baseDn": "string",
"bindDn": "string",
"userBase": "string",
"userObjectClasses": [
"string"
],
"userFilters": [
"string"
],
"timeout": "string",
"attributes": {
"idAttribute": "string",
"firstNameAttribute": "string",
"lastNameAttribute": "string",
"displayNameAttribute": "string",
"nickNameAttribute": "string",
"preferredUsernameAttribute": "string",
"emailAttribute": "string",
"emailVerifiedAttribute": "string",
"phoneAttribute": "string",
"phoneVerifiedAttribute": "string",
"preferredLanguageAttribute": "string",
"avatarUrlAttribute": "string",
"profileAttribute": "string"
},
"rootCa": "string"
},
"google": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"oauth": {
"clientId": "client-id",
"authorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
"tokenEndpoint": "https://oauth2.googleapis.com/token",
"userEndpoint": "https://openidconnect.googleapis.com/v1/userinfo",
"scopes": [
"openid",
"profile",
"email"
],
"idAttribute": "user_id",
"usePkce": true
},
"oidc": {
"issuer": "https://accounts.google.com/",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
],
"isIdTokenMapping": true,
"usePkce": true
},
"jwt": {
"jwtEndpoint": "https://accounts.google.com",
"issuer": "https://accounts.google.com",
"keysEndpoint": "https://accounts.google.com/keys",
"headerName": "x-auth-token"
},
"github": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"githubEs": {
"clientId": "client-id",
"authorizationEndpoint": "string",
"tokenEndpoint": "string",
"userEndpoint": "string",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlab": {
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"gitlabSelfHosted": {
"issuer": "string",
"clientId": "client-id",
"scopes": [
"openid",
"profile",
"email"
]
},
"azureAd": {
"clientId": "client-id",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
]
},
"apple": {
"clientId": "com.client.id",
"teamId": "ALT03JV3OS",
"keyId": "OGKDK25KD",
"scopes": [
"name",
"email"
]
},
"saml": {
"metadataXml": "string",
"binding": "SAML_BINDING_UNSPECIFIED",
"withSignedRequest": true,
"nameIdFormat": "SAML_NAME_ID_FORMAT_UNSPECIFIED",
"transientMappingAttributeName": "string",
"federatedLogoutEnabled": true
}
}
}
]
}
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