SetIdentityProviderUdPullConfiguration - Identity as a Service

Sets the inbound synchronization configuration for an IdP.

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 support 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:SetIdentityProviderUdPullConfiguration

update

*IdentityProvider

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
IdentityProviderId	string	Yes	The identity provider ID.	idp_my664lwkhpicbyzirog3xxxxx
IncrementalCallbackStatus	string	Yes	The status of incremental callback. This parameter specifies whether to process incremental callback data from the IdP. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
GroupSyncStatus	string	No	The group synchronization status. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
UdSyncScopeConfig	object	No	The inbound synchronization configuration.
SourceScopes	array	No	The list of source nodes for synchronization.
	string	No	The source node for synchronization.	ou_asdaq1addsxzdq1XXX
TargetScope	string	No	The target node for synchronization.	ou_asdaq1addsxzdq1XXX
PullProtectedRule	object	No	The inbound synchronization protection rule.
UserDeletedThreshold	integer	No	The threshold for the number of users to be deleted. If the number of users to be deleted exceeds this value, the synchronization task is stopped.	30
OrganizationalUnitDeletedThreshold	integer	No	The threshold for the number of organizational units to be deleted. If the number of organizational units to be deleted exceeds this value, the synchronization task is stopped.	10
GroupDeletedThreshold	integer	No	The threshold for the number of groups to be deleted. If the number of groups to be deleted exceeds this value, the synchronization task is stopped.	10
LdapUdPullConfig	object	No	The configurations of LDAP synchronization.
UserObjectClass	string	No	The user objectClass.	userPrincipalName, mail
OrganizationUnitObjectClass	string	No	The organizational unit objectClass.	organizationUnit,top
UserObjectClassCustomFilter	string	No	The custom user filter.	(\|(cn=test)(mail=test@test.com))
GroupObjectClass	string	No	The group objectClass.	group
GroupMemberAttributeName	string	No	The group member identifier.	member
GroupObjectClassCustomFilter	string	No	The custom group filter.	(\|(cn=test)(group=test@test.com))
PeriodicSyncStatus	string	No	The status of scheduled check. This parameter specifies whether to periodically check for data inconsistencies between IDaaS and the IdP. Valid values: disabled: The feature is disabled. enabled: The feature is enabled.	disabled
PeriodicSyncConfig	object	No	The scheduled synchronization configuration.
PeriodicSyncType	string	No	The type.	cron
PeriodicSyncCron	string	No	The cron expression. This parameter is required when periodicSyncType is set to cron.	0 45 1 * * ?
PeriodicSyncTimes	array	No	The time points for synchronization. This parameter is required when periodicSyncType is set to time. For example, if you set this parameter to [3, 5], the synchronization is performed from 03:00 to 04:00 and from 05:00 to 06:00.
	integer	No	The time point for synchronization.	3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.