Obtaining Workspace User Information

This API is used to obtain workspace user information.

For details, see Calling APIs.

GET /v2/{project_id}/{workspace_id}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID
workspace_id	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	String	Maximum number of data connections that can be queried each time.
offset	No	String	Page number of data connections queried each time.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory for token authentication. Call the "Obtaining the User Token" API of IAM to obtain the value of X-Subject-Token in the response header.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of users in the current workspace
total_page	Integer	Number of pages of query results
data	Array of ApigWorkspaceUserbody objects	Workspace user list

**Table 5** ApigWorkspaceUserbody
Parameter	Type	Description
id	String	Record ID, which is the primary key ID
user_id	String	User ID
user_name	String	Username
domain_id	String	Tenant ID
domain_name	String	Tenant name
display_user_name	String	Tenant name
domain_owner	Boolean	Whether the user is the workspace owner
description	String	Workspace user description
workspace_id	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.
roles	Array of ApigRoleVo objects	Role list
create_time	Number	Creation time
create_user	String	Creator
update_time	Number	Update time
update_user	String	Updater
type	Integer	User type. 0 indicates user and 1 indicates user group.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

None

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Code	Description
200	The user information list is returned.
400	Bad request.
500	Internal server error.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.