Topik ini menjelaskan metode yang digunakan untuk mengelola penugasan peran.
Parameter options dari tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.
Metode assignRole
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Menetapkan sebuah peran. Anda dapat menggunakan metode ini untuk menetapkan peran administrator tim kepada pengguna.
const result = await client.assignRole(params, options)Contoh
const user_id = 'xxx';
const group_id = 'xxxx';
await client.assignRole({
identity: {
identity_type: 'IT_User',
identity_id: user_id,
},
role_id: 'SystemGroupAdmin',
manage_resource_type: 'RT_Group',
manage_resource_id: group_id,
});Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IAssignRoleReq | Ya | Parameter yang digunakan untuk menetapkan sebuah peran. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IAssignRoleReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
identity | IIDentity | Ya | Pengenal unik dari pengguna atau grup yang akan diberikan peran. |
role_id | string | Ya | ID peran. Atur nilainya menjadi SystemGroupAdmin. |
manage_resource_type | string | Ya | Jenis sumber daya yang dapat dikelola oleh peran. Atur nilainya menjadi RT_Group. |
manage_resource_id | string | Ya | ID sumber daya yang dapat dikelola oleh peran, seperti ID grup. |
IIDentity parameter
Parameter | Tipe | Diperlukan | Deskripsi |
identity_type | string | Ya | Jenis objek yang akan diberikan peran. Nilai valid: IT_User dan IT_Group. |
identity_id | string | Ya | ID pengguna atau grup yang akan diberikan peran. |
Parameter respons
Tidak ada.
Metode cancelAssignRole
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Membatalkan penugasan sebuah peran. Anda dapat menggunakan metode ini untuk membatalkan penugasan peran administrator tim.
const result = await client.cancelAssignRole(params, options)Contoh
const user_id = 'xxx';
const group_id = 'xxxx';
await client.cancelAssignRole({
identity: {
identity_type: 'IT_User',
identity_id: user_id,
},
role_id: 'SystemGroupAdmin',
manage_resource_type: 'RT_Group',
manage_resource_id: group_id,
});Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | ICancelAssignRoleReq | Ya | Parameter permintaan yang digunakan untuk membatalkan penugasan sebuah peran. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
ICancelAssignRoleReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
identity | IIDentity | Ya | ID pengguna atau grup dari mana Anda ingin membatalkan penugasan peran. |
role_id | string | Ya | ID peran. Atur nilainya menjadi SystemGroupAdmin. |
manage_resource_type | string | Ya | Jenis sumber daya yang dapat dikelola oleh peran. Atur nilainya menjadi RT_Group. |
manage_resource_id | string | Ya | ID sumber daya yang dapat dikelola oleh peran, seperti ID grup. |
Parameter respons
Tidak ada.
Metode listAssignments
Untuk menggunakan metode ini, Anda harus memiliki izin admin atau izin administrator grup.
Meminta peran yang telah ditetapkan. Sebagai contoh, Anda dapat meminta administrator sebuah grup dengan menggunakan ID grup.
const result = await client.listAssignments(params, options)Contoh
const group_id = 'xxxx';
await client.listAssignments({
manage_resource_type: 'RT_Group',
manage_resource_id: group_id,
limit: 100,
});Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListAssignmentsReq | Ya | Parameter permintaan yang digunakan untuk meminta peran yang telah ditetapkan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IListAssignmentsReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
limit | long | Jumlah maksimum entri yang dikembalikan. Nilai valid: 1 hingga 100. Jumlah entri yang dikembalikan kurang dari atau sama dengan jumlah yang ditentukan. | |
marker | string | Penanda awal untuk paginasi. | |
manage_resource_type | string | Jenis sumber daya yang dikelola. Atur nilainya menjadi RT_Group. Ini menunjukkan bahwa administrator sebuah grup sedang diminta. | |
manage_resource_id | string | ID sumber daya yang dikelola, seperti ID grup. |
Parameter respons
Parameter | Tipe | Deskripsi |
assignment_list | IAssignment[] | null | Peran yang telah ditetapkan. |
next_marker | string | Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika next_marker kosong, tidak ada halaman berikutnya. |
IAssignment parameter
Parameter | Tipe | Deskripsi |
domain_id | string | ID domain. |
identity | IIDentity | ID pengguna atau grup yang diberikan peran. |
role_id | string | ID peran. |
manage_resource_type | string | Jenis sumber daya yang dikelola oleh peran. Hanya RT_Group yang mungkin dikembalikan, yang menunjukkan bahwa sebuah grup dikelola oleh peran. |
manage_resource_id | string | ID sumber daya yang dikelola oleh peran, seperti ID grup. |
creator | string | ID pengguna yang menetapkan peran. |
created_at | number | Waktu ketika peran ditetapkan. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |