Obtaining Workspace Roles

This API is used to obtain the roles of a workspace.

For details, see Calling APIs.

GET /v2/{project_id}/users/role

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	DataArts Studio instance ID. For details about how to obtain it, see Instance ID and Workspace ID.
workspace_id	No	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

**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
[items]	Array of ApigRoleVo objects	List of roles in a DataArts Studio workspace

Status code: 400

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

Status code: 500

**Table 7** 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	Roles of the workspace are 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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel