AddUser - Quick BI - Alibaba Cloud Documentation Center

Menambahkan anggota organisasi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:AddUser

create

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AdminUser `deprecated`	boolean	No	Apakah akan menetapkan peran administrator organisasi. Nilai valid: true false Penting Parameter ini tidak digunakan lagi. Parameter ini akan diabaikan jika `RoleIds` ditentukan. .	true
AuthAdminUser `deprecated`	boolean	No	Apakah akan menetapkan peran administrator izin. Nilai valid: true false Penting Parameter ini tidak digunakan lagi. Parameter ini akan diabaikan jika `RoleIds` ditentukan. .	true
UserType	integer	Yes	Jenis anggota organisasi. Nilai valid: 1: developer 2: viewer 3: analyst.	1
AccountId	string	No	ID akun Alibaba Cloud. Peringatan Parameter `AccountId` akan menjadi wajib pada versi Quick BI yang dirilis setelah 31 Desember 2024. Kami menyarankan Anda memperbarui panggilan API untuk menyertakan parameter ini sebelum tanggal tersebut. .	191476xxxxx23754
AccountName `deprecated`	string	No	Nama akun Alibaba Cloud. Untuk sub-akun, gunakan format `master account:sub-account`. Contoh: `master_test@aliyun.com:subaccount`. Panjang maksimum adalah 50 karakter.	xxxxxx@163.com
NickName	string	Yes	Nama panggilan pengguna. Panjang maksimum adalah 50 karakter. Nama panggilan dapat berisi karakter Mandarin, huruf, angka, dan karakter khusus berikut: `_ \ / \| () []`.	张三
RoleIds	string	No	ID peran organisasi bawaan atau kustom yang akan ditetapkan. Anda dapat menentukan hingga tiga ID peran, dipisahkan dengan koma (,). Nilai valid untuk peran bawaan: `111111111`: administrator organisasi `111111112`: administrator izin `111111113`: pengguna reguler.	111111111,456
CopilotModules	string	No	Modul Copilot yang akan diaktifkan untuk pengguna. Untuk mengaktifkan beberapa modul, tentukan kodenya dipisahkan dengan koma (,). `qreport`: Q Report `qExploreNum`: Q Explore `smartQAskNum`: Q&A with Data `smartQDevNum`: Q-assisted Building.	qreport,qExploreNum

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The details of the newly added Alibaba Cloud user.
AccountName	string	The Alibaba Cloud account.	xxxxxx@163.com
AdminUser	boolean	Indicates whether the organization administrator role is assigned. Valid values: true false Penting This parameter is deprecated. It does not take effect when `RoleIdList` is specified.	true
AuthAdminUser	boolean	Indicates whether the permission administrator role is assigned. Valid values: true false Penting This parameter is deprecated. It does not take effect when `RoleIdList` is specified.	true
NickName	string	The nickname of the Alibaba Cloud account.	张三
RoleIdList	array	A list of organization role IDs assigned to the user.
	integer	The ID of an organization role. You can assign a maximum of three roles. Predefined roles include: organization administrator (predefined role): 111111111 permission administrator (predefined role): 111111112 standard user (predefined role): 111111113	111111111
CopilotModules	array	The Copilot modules for which the user has a quota.
	string	A Copilot module for which the user has a quota.	qreport
UserId	string	The user ID in Quick BI.	b5d8fd9348cc4327****afb604
UserType	integer	The user type. Valid values: 1: developer 2: viewer 3: analyst	1
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountName": "xxxxxx@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "NickName": "张三",
    "RoleIdList": [
      111111111
    ],
    "CopilotModules": [
      "qreport"
    ],
    "UserId": "b5d8fd9348cc4327****afb604",
    "UserType": 1
  },
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Organization.Developers.ReachedTheUpperLimit	The developers of the organization have reached the upper limit:%s
400	Organization.Viewers.ReachedTheUpperLimit	The visitors of the organization have reached the upper limit:%s.
400	Organization.Analysts.ReachedTheUpperLimit	The analysts of the organization have reached the upper limit:%s.
400	NickName.AlreadyIn.Organization	The alias already exists.
400	User.AlreadyIn.Organization	This user is already a member of the current organization.
400	Instance.Over.MaxLicense	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.
400	Workspace.Not.Exist	The group workspace does not exist.
400	Workspace.Type.Error	The type of group workspace is invalid.
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.
400	User.OrganizationRole.NotExist	User %s must have role in organization.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.
400	RoleCount.ExceedsLimit.Error	The user role cannot exceed three.
400	BindRole.NotExist.Error	Bind role not exist, %s.
400	DirtyData.Duplicate.User	Dirty data,duplicate user: %s.
400	Robot.Module.Exhausted	The Quota of %s module has been exhausted.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.