Manage account profiles - Get user members by role
Hiermee haalt u een segment op van de gebruikersleden van een rol die beperkt is tot een specifieke grootte.
GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembersGET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
De rol-id. |
|
version
|
path | True |
string |
Api-versie. |
|
seek
|
query |
string |
De zoekbewerking die moet worden uitgevoerd op de gebruikersleden van de rol. Dit is handig in pagineringsscenario's waarbij de volgende of vorige pagina's van gebruikersleden nodig zijn. |
|
|
size
|
query |
integer int32 |
Het maximum aantal gebruikersleden dat moet worden geretourneerd, de waarde mag niet groter zijn dan 500 en mag niet lager zijn dan 1 |
|
|
sort
|
query |
string |
Een optionele sorteerparameter voor de richting waarop moet worden gesorteerd, waarden die worden geaccepteerd, zijn oplopend en aflopend. De standaardwaarde is oplopend |
|
|
sort
|
query |
string |
Een optionele sorteerparameter voor het veld waarop moet worden gesorteerd, waarden die worden geaccepteerd, zijn DisplayName en UserPrincipalName. De standaardwaarde is UserPrincipalName. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Bearer-token voor autorisatie |
| Accept | True |
string |
Acceptabel inhoudstype; breed accepeted type application/json |
| ms-correlationid |
string |
Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-correlationid is opgegeven, genereert de server een nieuwe voor elke aanvraag |
|
| ms-requestid |
string |
Wordt gebruikt voor idempotentie van aanvragen. Als er geen ms-requestid is opgegeven, genereert de server een nieuwe voor elke aanvraag |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is geslaagd. De hoofdtekst van het antwoord bevat de lijst met gebruikersleden. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Er is een ontbrekende of ongeldige invoer. De hoofdtekst van het antwoord bevat de foutdetails. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
De aanvraag is niet geverifieerd. De client moet eerst worden geverifieerd met de partner-API-service. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
De aanvraag is geverifieerd, maar is geweigerd omdat de beller niet over de rechten beschikt om deze aan te roepen. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
De resource is niet gevonden of niet beschikbaar met de opgegeven invoerparameters. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
De partner-API-service of een van de bijbehorende afhankelijkheden kan niet voldoen aan de aanvraag. Bellers kunnen dit opnieuw proberen. Media Types: "application/json", "text/json" |
Definities
| Name | Description |
|---|---|
|
Microsoft. |
Bevat een verzameling resources met JSON-eigenschappen die de uitvoer vertegenwoordigen |
|
Microsoft. |
Koppeling vertegenwoordigt een URI en de HTTP-methode die de gewenste actie aangeeft voor toegang tot de resource. |
|
Microsoft. |
Verwijst naar de algemene objectkenmerken |
|
Microsoft. |
Navigatiekoppelingen voor de resource |
|
Microsoft. |
Beschrijft de ledengegevens van een gebruiker. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Bevat een verzameling resources met JSON-eigenschappen die de uitvoer vertegenwoordigen
| Name | Type | Description |
|---|---|---|
| attributes |
Microsoft. |
Haalt de kenmerken op. |
| items |
Microsoft. |
Hiermee haalt u de verzamelingsitems op. |
| links |
Hiermee haalt u de koppelingen op of stelt u deze in. |
|
| totalCount |
integer |
Hiermee haalt u het totale aantal op. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Koppeling vertegenwoordigt een URI en de HTTP-methode die de gewenste actie aangeeft voor toegang tot de resource.
| Name | Type | Description |
|---|---|---|
| headers |
System. |
Haalt de koppelingsheaders op. |
| method |
string |
De methode. |
| uri |
string |
De URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Verwijst naar de algemene objectkenmerken
| Name | Type | Description |
|---|---|---|
| etag |
string |
Hiermee haalt u de etag op of stelt u deze in. De objectversie in providers. |
| objectType |
string |
Het type object. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Navigatiekoppelingen voor de resource
| Name | Type | Description |
|---|---|---|
| next |
De volgende pagina met items. |
|
| previous |
De vorige pagina met items. |
|
| self |
De zelf-URI. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Beschrijft de ledengegevens van een gebruiker.
| Name | Type | Description |
|---|---|---|
| accountId |
string |
Hiermee wordt de account-id opgehaald of ingesteld waarbij roltoewijzing is gekoppeld. |
| attributes |
Microsoft. |
Haalt de kenmerken op. |
| displayName |
string |
Hiermee haalt u de weergavenaam voor de gebruiker op of stelt u deze in. |
| id |
string |
De id van het lid. |
| roleId |
string |
De id van de rol van de gebruiker. |
| userPrincipalName |
string |
Hiermee haalt u de naam van de user principal op of stelt u deze in. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Type | Description |
|---|---|---|
| key |
string |
|
| value |
string |