ListIdentityProviders - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves a list of identity providers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eiam:ListIdentityProviders

list

*IdentityProvider

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page.	20
Direction	string	No	The data synchronization direction of the identity provider. Valid values: pull : inbound push : outbound	pull

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
IdentityProviders	array<object>	The list of identity providers.
	object	The information about the identity provider.
InstanceId	string	The instance ID.	idaas_pbf4dth34l2qb7mydpntXXX
IdentityProviderId	string	The identity provider ID.	idp_m5b5wd5s2hpq4t6iaehhXXX
IdentityProviderExternalId	string	The external ID of the identity provider.	test_123
Description	string	The description of the identity provider.	None
IdentityProviderName	string	The name of the identity provider.	xxxx
UdPullStatus	string	Indicates whether inbound synchronization is enabled. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
AuthnSourceType	string	The authentication method type. Valid values: OIDC: urn:alibaba:idaas:authntype:oidc SAML: urn:alibaba:idaas:authntype:saml2	urn:alibaba:idaas:authntype:oidc
AuthnSourceSupplier	string	The authentication source product, such as Okta, Google, or Azure AD. Valid values: DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk LDAP: urn:alibaba:idaas:idp:unknown:ldap Alibaba Cloud IDaaS: urn:alibaba:idaas:idp:alibaba:idaas WeCom: urn:alibaba:idaas:idp:tencent:wecom Lark: urn:alibaba:idaas:idp:bytedance:lark Active Directory: urn:alibaba:idaas:idp:microsoft:ad Azure Active Directory: urn:alibaba:idaas:idp:microsoft:aad Alibaba Cloud SASE: urn:alibaba:idaas:idp:alibaba:sase	urn:alibaba:idaas:idp:bytedance:lark
AuthnStatus	string	Indicates whether the identity provider supports authentication. Valid values: disabled: Authentication is disabled. enabled: Authentication is enabled.	disabled
IncrementalCallbackStatus	string	The incremental callback status. This indicates whether to process incremental callback data from the identity provider. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	enabled
UdPullTargetScope	string	The target node for synchronization.	ou_2buqmxsa3ltyqkjgpwfijurXXX
IdentityProviderType	string	The synchronization type of the identity provider. Inbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:pull Outbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:push Inbound WeCom: urn:alibaba:idaas:idp:tencent:wecom:pull Inbound Lark: urn:alibaba:idaas:idp:bytedance:lark:pull Inbound AD: urn:alibaba:idaas:idp:microsoft:ad:pull Inbound LDAP: urn:alibaba:idaas:idp:unknown:ldap:pull Standard OIDC: urn:alibaba:idaas:idp:standard:oidc Custom OIDC for SASE: urn:alibaba:idaas:idp:alibaba:sase	urn:alibaba:idaas:idp:bytedance:lark:pull
AdvancedStatus	string	Indicates whether advanced configuration is enabled. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
UdPushStatus	string	Indicates whether outbound synchronization is enabled. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
LockReason	string	The reason why the identity provider is locked.	financial
LastStatusCheckJobResult	string	The result of the last status check. A sync task can be triggered only when the status check of the identity provider returns `success`.	success
CreateTime	integer	The time when the identity provider was created. This is a UNIX timestamp. Unit: milliseconds.	1712561597000
UpdateTime	integer	The time when the identity provider was last updated. This is a UNIX timestamp. Unit: milliseconds.	1712561597000
LogoUrl	string	The URL of the custom logo for the identity provider.	https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx
PeriodicSyncStatus	string	The periodic check status. This indicates whether to periodically check for data inconsistencies between IDaaS and the identity provider.	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.