Synchronizing Domain Controller Users or User Groups

Synchronizes domain controller users or user groups.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:authConfigs:syncExternalUser

Write

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:authConfigs:syncExternalUser	Write	-	-	-	-

GET /v3/{project_id}/domains/sync-external-user

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
auth_config_id	Yes	String	Authentication configuration ID.
domain_id	Yes	String	Domain controller ID.
enterprise_id	No	String	ID of the enterprise project to which the users to be synchronized belongs.

None

Status code: 202

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for synchronizing users (or groups).

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

GET /v3/29dfe82ada564ac2b927e1ff036d9a9b/domains/sync-external-user?auth_config_id=xxx&domain_id=xxx&enterprise_id=0

Status code: 202

Response to the request for synchronizing users (or groups).

{
  "job_id" : "c619693f-6954-4f85-875a-28b51d759f17"
}

Status Code	Description
202	Response to the request for synchronizing users (or groups).
400	The request cannot be understood by the server due to malformed syntax.
401	Authorization failed.
403	No permissions.
404	Resources not found.
500	An internal service error occurred. For details, see the error code description.

Parent topic: Huawei Cloud Workspace

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.