Querying the Result of a Task for Managing Federated Users (queryTask)

Scenario

This interface is used to query the result of a task for managing federated users.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/federationUserMgmt/queryTask (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	X-APP-Key	String	Yes	App key, which is the user ID.
2	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	requestBody	Object	Yes	Request for querying the result of a task for managing federated tasks.
1.1	taskId	String	Yes	ID of the task to be queried. The value is that of taskId in Table 3.

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	schema	Object	Yes	Response message.
1.1	resultCode	String	Yes	Return code. 0: success Other values indicate failure. For details, see Table 5.
1.2	resultMessage	String	No	Result description.
1.3	taskInfo	Object	No	Task information.
1.3.1	status	String	No	Task status. TODO DOING DONE
1.3.2	remark	String	No	Task remarks.
1.4	failDataList	Array [Object]	No	List of failed data.
1.4.1	federationUser	Object	No	Federated user information.
1.4.1.1	action	String	No	Operation type. CREATE MODIFY DISABLE
1.4.1.2	userName	String	No	Federated username.
1.4.1.3	userAccount	String	No	Federated user account.
1.4.1.4	email	String	No	Email address of a federated user.
1.4.1.5	roleIds	Array	No	List of role IDs assigned to a federated user.
1.4.2	failCode	String	No	Failure cause code. For details, see Table 4.
1.4.3	failMessage	String	No	Failure cause information.

**Table 4** failCode description
failCode	Description
60101040050	The input parameter {param} is invalid. {desc}.
60101060003	The mapping fails.
60101020076	The length of the account {loginId} does not meet the requirements.
60101020085	The account {loginId} contains invalid characters. Invalid characters: {invalidChars}.
60101060007	The federated user does not exist.
60101030013	The transferred role ID {roleId} does not exist in the database.
60101900002	Internal system error. Reason: {detail}.
60101000100	Failed to obtain user details.
60101000101	Failed to obtain the federated user mapping rule.
60101000102	Failed to obtain the third-party system ID.
60101000103	The obtained user details are empty.
60101000104	Failed to invoke the sum interface to obtain user role information.
60101000105	The user ID obtained during user creation is empty.
60101000108	The user already exists.
60101000109	Failed to map the input parameters to the federated user information.

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Business failure. Check the values of parameters in the request.

Error Codes

**Table 5** Error code
Error Code	Description
100-111	The value of taskId exceeds the length limit or is not a number.

Example

Request header:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

Request parameter:

{
  "taskId": "1659446191820726274"
 }

Response parameters:

{
     "failDataList": [],
     "resultCode": "0",
     "taskInfo": {
         "remark": "",
         "status": "DONE"
     },
     "resultMessage": "The query is successful."
 }

Parent topic: Federated User Management

Previous topic: Creating a Task for Managing Federated Users (createTask)

Next topic: Web Client Access