ListProjectRoles API Overview for Workspace Role Management - DataWorks - Alibaba Cloud - DataWorks

Returns a paginated list of roles in a workspace.

Operation description

This feature is available in DataWorks Basic Edition and higher.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListProjectRoles

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can find the ID on the Workspace Management page in the DataWorks console. This parameter specifies the DataWorks workspace for which you want to list roles.	21229
Codes	array	No	An array of workspace role codes.
	string	No	The code of a workspace role. `role_project_admin`: Workspace Admin `role_project_dev`: Developer `role_project_dg_admin`: Data Governance Admin `role_project_guest`: Guest `role_project_security`: Security Admin `role_project_deploy`: Deployer `role_project_owner`: Workspace Owner `role_project_data_analyst`: Data Analyst `role_project_pe`: O&M `role_project_erd`: Model Designer	role_project_guest
Names	array	No	An array of workspace role names.
	string	No	The name of a workspace role.	Visitors
Type	string	No	The type of the workspace role. `UserCustom`: Custom Role `System`: System Role	System
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries to return per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID. Use this ID to locate logs and troubleshoot issues.	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	The pagination information.
PageSize	string	The number of entries per page.	10
PageNumber	string	The returned page number.	1
TotalCount	string	The total number of matching entries.	42
ProjectRoles	array<object>	A list of workspace roles.
	array<object>	Details of a workspace role.
ProjectId	integer	The ID of the DataWorks workspace. Note: For system-defined roles, this parameter returns -1.	21229
Code	string	The code of the workspace role.	role_project_guest
Name	string	The name of the workspace role.	Visitors
Type	string	The type of the workspace role.	System
ModulePermissions	array<object>
	object
ModuleId	integer		2
ModuleName	string		HoloStudio
PermissionType	string		Read

Examples

Success response

JSON format

{
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": "10",
    "PageNumber": "1",
    "TotalCount": "42",
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System",
        "ModulePermissions": [
          {
            "ModuleId": 2,
            "ModuleName": "HoloStudio",
            "PermissionType": "Read"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.