AddWorkspaceUsers - - Alibaba Cloud Dokümantasyon Merkezi

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

quickbi-public:AddWorkspaceUsers

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Çalışma alanı kimliği.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	Yes	Kullanıcı kimlikleri. Bunlar Alibaba Cloud UID'leri değil, Quick BI kullanıcı kimlikleridir. Virgül (,) ile ayrılmış birden fazla kullanıcı kimliği iletebilirsiniz.	de4bc5f9429141cc8091cdd1c15b****
RoleId	integer	Yes	Ön tanımlı çalışma alanı rolünün kimliği. Geçerli değerler: 25: depolama yönetimi yöneticisi 26: çalışma alanı geliştiricisi 27: depolama analizi analisti 30: çalışma alanı görüntüleyicisi Valid values: 25 : Yönetici. 26 : Geliştirici. 27 : Analist. 30 : Görüntüleyici.	25

Response elements

Element	Type	Description	Example
	object
Success	boolean	İsteğin başarılı olup olmadığını gösterir. Geçerli değerler: true: İstek başarılıdır. Bazı üyeler başarıyla eklenirken diğerleri başarısız olabilir. Başarısızlıkların nedenleri için yanıttaki FailureDetail alanına bakın. false: İstek başarısız oldu. Hiçbir veri kalıcı olarak depolanmaz.	true
RequestId	string	İstek kimliği.	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	İşlemin yürütme sonucu.
Failure	integer	Eklenmesi başarısız olan kullanıcı sayısı.	2
FailureDetail	object	Başarısızlıkların nedenleri.	{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Success	integer	Eklenen kullanıcı sayısı.	1
Total	integer	Eklenecek toplam kullanıcı sayısı.	3

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 2,
    "FailureDetail": {
      "2046274934845893": "AE0150010001: This user already exists.",
      "1213444447906552": "AE0150010001: This user already exists."
    },
    "Success": 1,
    "Total": 3
  }
}

Error codes

HTTP status code	Error code	Error message
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	User.RoleType.Valid	The role ID is invalid.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.
400	Workspace.Not.Exist	The group workspace does not exist.
400	ApiUser.Not.Exists	The specified user does not exist.
400	Viewer.AddInTo.Workspace	Organization members with viewer type are not allowed to add to workspace: %s.
400	User.AlreadyIn.Workspace	This user already exists.
400	User.AlreadyIn.Role	The user is already assigned this role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.