Manage account profiles - Get user members by role
Lekéri a szerepkör felhasználói tagjainak egy adott méretre leképezett szegmensét.
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}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
role_id
|
path | True |
string |
A szerepkör azonosítója. |
version
|
path | True |
string |
Api-verzió. |
seek
|
query |
string |
A szerepkör felhasználói tagjain végrehajtandó keresési művelet. Ez olyan lapozási forgatókönyvekben hasznos, ahol a felhasználói tagok következő vagy előző lapjaira van szükség. |
|
size
|
query |
integer int32 |
A visszaadandó felhasználói tagok maximális száma, az érték nem haladhatja meg az 500-as értéket, és nem lehet alacsonyabb 1-nél |
|
sort
|
query |
string |
A rendezési irány választható rendezési paramétere, az elfogadott értékek növekvőek és csökkenők, az alapértelmezett érték a Növekvő |
|
sort
|
query |
string |
A mező választható rendezési paramétere, amely szerint rendezhet. Az elfogadott értékek a DisplayName és a UserPrincipalName, az alapértelmezett érték a UserPrincipalName. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Authorization | True |
string |
Engedélyezési tulajdonos jogkivonata |
Accept | True |
string |
Elfogadható tartalomtípus; széles körben elérhető típusú alkalmazás/json |
ms-correlationid |
string |
A kérések belső nyomon követésére szolgál. Ha nincs megadva ms-correlationid, a kiszolgáló minden kéréshez létrehoz egy újat |
|
ms-requestid |
string |
A kérések idempotensségéhez használatos. Ha nincs megadva ms-requestid, a kiszolgáló minden kéréshez létrehoz egy újat |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A kérés sikeres volt. A válasz törzse tartalmazza a felhasználói tagok listáját. Media Types: "application/json", "text/json" |
|
400 Bad Request |
Hiányzó vagy érvénytelen bemenet volt. A válasz törzse adja meg a hiba részleteit. Media Types: "application/json", "text/json" |
|
401 Unauthorized |
A kérelem hitelesítése nem történt meg. Az ügyfélnek először a partner API szolgáltatással kell hitelesítenie magát. Media Types: "application/json", "text/json" |
|
403 Forbidden |
A kérés hitelesítése megtörtént, de a rendszer elutasította, mivel a hívónak nincs jogosultsága meghívni. Media Types: "application/json", "text/json" |
|
404 Not Found |
Az erőforrás nem található vagy nem érhető el a megadott bemeneti paraméterekkel. Media Types: "application/json", "text/json" |
|
500 Internal Server Error |
A partner API-szolgáltatás vagy annak egyik függősége nem tudta teljesíteni a kérést. Előfordulhat, hogy a hívók újrapróbálkoznak. Media Types: "application/json", "text/json" |
Definíciók
Name | Description |
---|---|
Microsoft. |
JSON-tulajdonságokkal rendelkező erőforrások gyűjteményét tartalmazza a kimenet megjelenítéséhez |
Microsoft. |
A hivatkozás egy URI-t és egy HTTP-metódust jelöl, amely az erőforrás eléréséhez szükséges műveletet jelöli. |
Microsoft. |
A gyakori objektumattribútumokra hivatkozik |
Microsoft. |
Az erőforrás navigációs hivatkozásai |
Microsoft. |
A felhasználó tagadatait ismerteti. |
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
JSON-tulajdonságokkal rendelkező erőforrások gyűjteményét tartalmazza a kimenet megjelenítéséhez
Name | Típus | Description |
---|---|---|
attributes |
Microsoft. |
Lekéri az attribútumokat. |
items |
Microsoft. |
Lekéri a gyűjteményelemeket. |
links |
Lekéri vagy beállítja a hivatkozásokat. |
|
totalCount |
integer |
Lekéri a teljes számot. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
A hivatkozás egy URI-t és egy HTTP-metódust jelöl, amely az erőforrás eléréséhez szükséges műveletet jelöli.
Name | Típus | Description |
---|---|---|
headers |
System. |
Lekéri a hivatkozásfejléceket. |
method |
string |
A metódus. |
uri |
string |
Az URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
A gyakori objektumattribútumokra hivatkozik
Name | Típus | Description |
---|---|---|
etag |
string |
Lekéri vagy beállítja az etaget. Az objektum verziója a szolgáltatókban. |
objectType |
string |
Az objektum típusa. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Az erőforrás navigációs hivatkozásai
Name | Típus | Description |
---|---|---|
next |
Az elemek következő oldala. |
|
previous |
Az elemek előző lapja. |
|
self |
Az önkiszolgáló. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
A felhasználó tagadatait ismerteti.
Name | Típus | Description |
---|---|---|
accountId |
string |
Lekéri vagy beállítja azt a fiókazonosítót, ahol a szerepkör-hozzárendelés meg van kötve. |
attributes |
Microsoft. |
Lekéri az attribútumokat. |
displayName |
string |
Lekéri vagy beállítja a felhasználó megjelenítendő nevét. |
id |
string |
A tag azonosítója. |
roleId |
string |
A felhasználó szerepkörének azonosítója. |
userPrincipalName |
string |
Lekéri vagy beállítja a felhasználónév nevét. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name | Típus | Description |
---|---|---|
key |
string |
|
value |
string |