ListIdentityProviders
Query the list of identity providers.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
Instance ID. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| PageNumber |
integer |
No |
Page number. |
1 |
| PageSize |
integer |
No |
Page size. |
20 |
| Direction |
string |
No |
The direction of the identity provider. Valid values:
|
pull |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
Request ID. |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| TotalCount |
integer |
Total number of entries. |
100 |
| IdentityProviders |
array<object> |
List of identity provider information. |
|
|
object |
Identity provider information. |
||
| InstanceId |
string |
Instance ID. |
idaas_pbf4dth34l2qb7mydpntXXX |
| IdentityProviderId |
string |
Identity provider ID. |
idp_m5b5wd5s2hpq4t6iaehhXXX |
| IdentityProviderExternalId |
string |
External ID of the identity provider. |
test_123 |
| Description |
string |
Description of the identity provider. |
None |
| IdentityProviderName |
string |
Name of the identity provider. |
xxxx |
| UdPullStatus |
string |
Whether the inbound sync feature is supported. Valid values:
|
disabled |
| AuthnSourceType |
string |
The authentication source type, OIDC or SAML. Valid values:
|
urn:alibaba:idaas:authntype:oidc |
| AuthnSourceSupplier |
string |
The authentication source product, such as Okta, Google, or Azure AD. Valid values:
|
urn:alibaba:idaas:idp:bytedance:lark |
| AuthnStatus |
string |
Whether the corresponding IdP supports authentication. Valid values:
|
disabled |
| IncrementalCallbackStatus |
string |
The incremental callback status, indicating whether incremental callback data from the IdP is processed. Valid values:
|
enabled |
| UdPullTargetScope |
string |
The target node for synchronization. |
ou_2buqmxsa3ltyqkjgpwfijurXXX |
| IdentityProviderType |
string |
The synchronization type of the identity provider.
|
urn:alibaba:idaas:idp:bytedance:lark:pull |
| AdvancedStatus |
string |
Whether the advanced configuration is enabled. Valid values:
|
disabled |
| UdPushStatus |
string |
Whether the outbound sync feature is enabled. Valid values:
|
disabled |
| LockReason |
string |
The lock reason. |
financial |
| LastStatusCheckJobResult |
string |
The last status check result. Before synchronization, a sync task can only be triggered when the identity provider status check result is success. |
success |
| CreateTime |
integer |
The creation time, in Unix timestamp format, measured in milliseconds. |
1712561597000 |
| UpdateTime |
integer |
The update time, in Unix timestamp format, measured in milliseconds. |
1712561597000 |
| LogoUrl |
string |
The custom logo URL of the identity provider. |
https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx |
| PeriodicSyncStatus |
string |
The periodic sync status, indicating whether the data differences between EIAM and the identity provider are periodically checked. |
disabled |
Examples
Success response
JSON format
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"TotalCount": 100,
"IdentityProviders": [
{
"InstanceId": "idaas_pbf4dth34l2qb7mydpntXXX",
"IdentityProviderId": "idp_m5b5wd5s2hpq4t6iaehhXXX",
"IdentityProviderExternalId": "test_123",
"Description": "None",
"IdentityProviderName": "xxxx\n",
"UdPullStatus": "disabled",
"AuthnSourceType": "urn:alibaba:idaas:authntype:oidc",
"AuthnSourceSupplier": "urn:alibaba:idaas:idp:bytedance:lark",
"AuthnStatus": "disabled",
"IncrementalCallbackStatus": "enabled",
"UdPullTargetScope": "ou_2buqmxsa3ltyqkjgpwfijurXXX",
"IdentityProviderType": "urn:alibaba:idaas:idp:bytedance:lark:pull",
"AdvancedStatus": "disabled",
"UdPushStatus": "disabled",
"LockReason": "financial",
"LastStatusCheckJobResult": "success",
"CreateTime": 1712561597000,
"UpdateTime": 1712561597000,
"LogoUrl": "https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx",
"PeriodicSyncStatus": "disabled"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.