Use ListMembers to retrieve workspace members - Platform For AI - Alibaba Cloud - Platform For AI

Lists the members of a workspace.

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:ListMembers

list

*All Resource

*

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the workspace list. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The paging Settings for the number of entries per page in a paged query. Default value: 20.	20
Roles	string	No	Filters members by role. Separate multiple roles with commas (,). Valid values: PAI.AlgoDeveloper: Algorithm developer. PAI.AlgoOperator: Algorithm O&M. PAI.LabelManager: Labeling administrator. PAI.MaxComputeDeveloper: MaxCompute developer. PAI.WorkspaceAdmin: Administrator. PAI.WorkspaceGuest: Guest. PAI.WorkspaceOwner: Owner.	PAI.AlgoDeveloper
MemberName	string	No	The member name. Fuzzy match is supported.	zhangsan
UserId	string	No	The ID of the user to query.	2788******129

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Members	array<object>	The list of members.
	object	The member details.
UserId	string	The user ID.	215139******88039
MemberName	string	The username.	user1
GmtCreateTime	string	The creation time in UTC. The time follows the ISO 8601 standard.	2021-01-21T17:12:35.232Z
Roles	array	The list of roles.
	string	The role name. For the mapping between role names and permissions, see Appendix: Roles and permissions. Valid values: PAI.AlgoDeveloper: Algorithm developer. PAI.AlgoOperator: Algorithm O&M. PAI.LabelManager: Labeling administrator. PAI.MaxComputeDeveloper: MaxCompute developer. PAI.WorkspaceAdmin: Administrator. PAI.WorkspaceGuest: Guest. PAI.WorkspaceOwner: Owner.	PAI.AlgoDeveloper
DisplayName	string	The display name of the member.	myDisplayName
MemberId	string	The member ID.	14588*****51688039
AccountName	string	The account name of the member.	testAccount
AccountType	string	The account type of the member. Valid values: 1: Alibaba Cloud account. 5: RAM user. 6: RAM role.	5
TotalCount	integer	The total number of members that meet the filter conditions.	1

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Members": [
    {
      "UserId": "215139******88039",
      "MemberName": "user1",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Roles": [
        "PAI.AlgoDeveloper"
      ],
      "DisplayName": "myDisplayName",
      "MemberId": "14588*****51688039",
      "AccountName": "testAccount",
      "AccountType": "5"
    }
  ],
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.