Control SCIM Sync Status Programmatically in CloudSSO - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

SCIM synchronization must be enabled before you can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. Enabling or disabling SCIM synchronization has the following impacts:

When SCIM synchronization is enabled, you cannot modify or delete SCIM-synchronized users or groups, or change group membership. However, you can still modify user passwords and status.
When SCIM synchronization is disabled, you can modify or delete SCIM-synchronized users and groups, and change group membership.

The following example shows how to enable SCIM synchronization in the directory d-00fc2p61****.

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

cloudsso:SetSCIMSynchronizationStatus

update

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
SCIMSynchronizationStatus	string	No	The status of SCIM synchronization. Valid values: Enabled: SCIM synchronization is enabled. Disabled: SCIM synchronization is disabled.	Enabled

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01

Examples

Success response

JSON format

{
  "RequestId": "3BF1FC78-5D20-54CC-BAEB-8CC33AE21D01"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.