RunSynchronizationJob - Identity as a Service - Alibaba Cloud Documentation Center

Creates and immediately runs a new synchronization task.

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:RunSynchronizationJob

create

*SynchronizationJob

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
TargetId	string	Yes	The ID of the synchronization target.	11111
TargetType	string	Yes	The type of the synchronization target. Valid values: identity_provider: The identity provider. application: The application.	application, identity_provider
Description	string	No	The description of the synchronization task.	描述
UserIdentityTypes	array	No	The list of unique user identifiers.
	string	No	The unique user identifier.	ding_talk
SynchronizationScopeConfig	object	No	The configuration of the synchronization scope.
OrganizationalUnitIds	array	No	The list of organizational unit IDs.
	string	No	The organizational unit ID.	ou_denmyslajnzh4f4hkuob5sxxxx
GroupIds	array	No	The list of group IDs.
	string	No	The group ID.	group_hrgy65sk32ry4d7476bkexxxx
UserIds	array	No	The list of user IDs.
	string	No	The user ID.	user_rgy65sk32ry4d747xxxx
PasswordInitialization	boolean	No	Specifies whether to initialize the password.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
SynchronizationJobId	string	The ID of the synchronization task.	sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedAction.IdentityProviderBeingLocked	The current identity source is locked, temporarily unable to operate.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.