Manage account profiles - Get user members by role
Mendapatkan segmen anggota pengguna peran yang dibatasi ke ukuran tertentu.
GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers
GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
role_id
|
path | True |
string |
Pengidentifikasi peran. |
version
|
path | True |
string |
Versi Api. |
seek
|
query |
string |
Operasi pencarian untuk dilakukan pada anggota pengguna peran. Ini berguna dalam skenario paging di mana halaman berikutnya atau sebelumnya dari anggota pengguna diperlukan. |
|
size
|
query |
integer int32 |
Jumlah maksimum anggota pengguna yang akan dikembalikan, nilai tidak boleh lebih dari 500 dan tidak boleh lebih rendah dari 1 |
|
sort
|
query |
string |
Parameter pengurutan opsional untuk arah mengurutkan menurut, nilai yang diterima adalah Naik dan Turun, defaultnya adalah Naik |
|
sort
|
query |
string |
Parameter pengurutan opsional untuk bidang yang akan diurutkan, nilai yang diterima adalah DisplayName dan UserPrincipalName, defaultnya adalah UserPrincipalName. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
Authorization | True |
string |
Token Pembawa Otorisasi |
Accept | True |
string |
Jenis konten yang dapat diterima; aplikasi/json jenis yang dipercepat secara luas |
ms-correlationid |
string |
Digunakan untuk melacak permintaan secara internal. Jika ms-correlationid tidak disediakan, server akan menghasilkan yang baru untuk setiap permintaan |
|
ms-requestid |
string |
Digunakan untuk idempotensi permintaan. Jika ms-requestid tidak disediakan, server akan menghasilkan yang baru untuk setiap permintaan |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Permintaan berhasil. Isi respons berisi daftar anggota pengguna. Media Types: "application/json", "text/json" |
|
400 Bad Request |
Ada input yang hilang atau tidak valid. Isi respons akan memberikan detail kesalahan. Media Types: "application/json", "text/json" |
|
401 Unauthorized |
Permintaan tidak diautentikasi. Klien perlu mengautentikasi dengan layanan API mitra terlebih dahulu. Media Types: "application/json", "text/json" |
|
403 Forbidden |
Permintaan diautentikasi tetapi ditolak karena penelepon tidak memiliki hak untuk memanggilnya. Media Types: "application/json", "text/json" |
|
404 Not Found |
Sumber daya tidak ditemukan atau tidak tersedia dengan parameter input yang diberikan. Media Types: "application/json", "text/json" |
|
500 Internal Server Error |
Layanan API mitra atau salah satu dependensinya gagal memenuhi permintaan. Penelepon dapat mencoba kembali ini. Media Types: "application/json", "text/json" |
Definisi
Nama | Deskripsi |
---|---|
Microsoft. |
Berisi kumpulan sumber daya dengan properti JSON untuk mewakili output |
Microsoft. |
Tautan mewakili URI dan metode HTTP yang menunjukkan tindakan yang diinginkan untuk mengakses sumber daya. |
Microsoft. |
Mengacu pada atribut objek umum |
Microsoft. |
Tautan navigasi untuk sumber daya |
Microsoft. |
Menjelaskan informasi anggota pengguna. |
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Berisi kumpulan sumber daya dengan properti JSON untuk mewakili output
Nama | Jenis | Deskripsi |
---|---|---|
attributes |
Microsoft. |
Mendapatkan atribut . |
items |
Microsoft. |
Mendapatkan item koleksi. |
links |
Mendapatkan atau mengatur tautan. |
|
totalCount |
integer |
Mendapatkan jumlah total. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Tautan mewakili URI dan metode HTTP yang menunjukkan tindakan yang diinginkan untuk mengakses sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
headers |
System. |
Mendapatkan header tautan. |
method |
string |
Metode ini. |
uri |
string |
URI-ku. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Mengacu pada atribut objek umum
Nama | Jenis | Deskripsi |
---|---|---|
etag |
string |
Mendapatkan atau mengatur etag. Versi objek di penyedia. |
objectType |
string |
Jenis objek. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Tautan navigasi untuk sumber daya
Nama | Jenis | Deskripsi |
---|---|---|
next |
Halaman item berikutnya. |
|
previous |
Halaman item sebelumnya. |
|
self |
Uri diri. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Menjelaskan informasi anggota pengguna.
Nama | Jenis | Deskripsi |
---|---|---|
accountId |
string |
Mendapatkan atau mengatur id akun tempat penetapan peran terikat. |
attributes |
Microsoft. |
Mendapatkan atribut . |
displayName |
string |
Mendapatkan atau mengatur nama tampilan untuk pengguna. |
id |
string |
Pengidentifikasi anggota. |
roleId |
string |
Pengidentifikasi peran pengguna. |
userPrincipalName |
string |
Mendapatkan atau mengatur nama prinsipal pengguna. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Nama | Jenis | Deskripsi |
---|---|---|
key |
string |
|
value |
string |