Use ListPermissions to retrieve user permissions in a workspace - Platform For AI

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

paiworkspace:ListPermissions

list

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{WorkspaceId}/permissions HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces.	123

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The returned struct.
RequestId	string	The request ID.	2AE63638-5420-56DC-B******8174039A0
Permissions	array<object>	The list of permissions.
	array<object>	A permission.
PermissionCode	string	The name of the permission point. The name is unique within the same region. For more information about permission points, see Appendix: Roles and permissions. For example, the value PaiDLC:GetTensorboard grants the permission to view Tensorboard details for the DLC feature.	PaiDLC:GetTensorboard
PermissionRules	array<object>	The list of permission rules.
	object	A permission rule.
Accessibility	string	The access type. Valid values: PUBLIC: All members in the current workspace can perform the operation. PRIVATE: Only the creator can perform the operation. ANY: Both the creator and non-creators can perform the operation.	PRIVATE
EntityAccessType	string	The entity access type. This parameter is invalid if Accessibility is set to PUBLIC. In this case, all users can perform the operation. If Accessibility is set to PRIVATE, the permission is determined by the value of EntityAccessType. Valid values: CREATOR: Only the creator can perform the operation. ANY: Both the creator and non-creators can perform the operation.	CREATOR
TotalCount	integer	The number of entries that meet the filter conditions.	1

Examples

Success response

JSON format

{
  "RequestId": "2AE63638-5420-56DC-B******8174039A0",
  "Permissions": [
    {
      "PermissionCode": "PaiDLC:GetTensorboard",
      "PermissionRules": [
        {
          "Accessibility": "PRIVATE",
          "EntityAccessType": "CREATOR"
        }
      ]
    }
  ],
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.