Obtaining Workspace User Information
Function
This API is used to obtain workspace user information.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/{workspace_id}/users
|
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. |
|
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. |
Request 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. |
Response Parameters
Status code: 200
|
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 |
|
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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
role_id |
String |
Role ID |
|
role_code |
String |
Role code |
|
role_name |
String |
Role name |
|
description |
String |
Role description |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Returned error information. |
|
error_code |
String |
Returned error code. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Returned error information. |
|
error_code |
String |
Returned error code. |
Example Requests
None
Example Responses
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 Codes
|
Status Code |
Description |
|---|---|
|
200 |
The user information list is returned. |
|
400 |
Bad request. |
|
500 |
Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
