Manage account profiles - Get user members by role
Ruft ein Segment der Benutzermitglieder einer Rolle ab, die auf eine bestimmte Größe begrenzt sind.
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-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
Der Rollenbezeichner. |
|
version
|
path | True |
string |
API-Version. |
|
seek
|
query |
string |
Der Suchvorgang, der für die Benutzermitglieder der Rolle ausgeführt werden soll. Dies ist nützlich bei Auslagerungsszenarien, in denen die nächsten oder vorherigen Seiten von Benutzermitgliedern erforderlich sind. |
|
|
size
|
query |
integer int32 |
Die maximale Anzahl der zurückzugebenden Benutzermitglieder darf nicht größer als 500 sein und darf nicht kleiner als 1 sein. |
|
|
sort
|
query |
string |
Ein optionaler Sortierparameter für die Sortierrichtung, die akzeptierten Werte sind "Aufsteigend" und "Absteigend". Der Standardwert ist "Aufsteigend" |
|
|
sort
|
query |
string |
Ein optionaler Sortierparameter für das zu sortierende Feld, werte akzeptiert sind DisplayName und UserPrincipalName, Standardwert ist UserPrincipalName. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Authorization | True |
string |
Autorisierungs-Bearertoken |
| Accept | True |
string |
Zulässiger Inhaltstyp; anwendung/json des weit verbreiteten Typs |
| ms-correlationid |
string |
Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue. |
|
| ms-requestid |
string |
Wird für die Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue anforderung. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung war erfolgreich. Der Antworttext enthält die Liste der Benutzermitglieder. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Es fehlte eine oder eine ungültige Eingabe. Der Antworttext enthält die Fehlerdetails. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
Die Anforderung wurde nicht authentifiziert. Der Client muss sich zuerst beim Partner-API-Dienst authentifizieren. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
Die Anforderung wurde authentifiziert, wurde aber abgelehnt, da der Aufrufer nicht über die Rechte zum Aufrufen verfügt. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
Die Ressource wurde mit den angegebenen Eingabeparametern nicht gefunden oder nicht verfügbar. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
Der Partner-API-Dienst oder eine seiner Abhängigkeiten konnte die Anforderung nicht erfüllen. Anrufer versuchen dies möglicherweise erneut. Media Types: "application/json", "text/json" |
Definitionen
| Name | Beschreibung |
|---|---|
|
Microsoft. |
Enthält eine Auflistung von Ressourcen mit JSON-Eigenschaften zur Darstellung der Ausgabe |
|
Microsoft. |
Link stellt einen URI und die HTTP-Methode dar, die die gewünschte Aktion für den Zugriff auf die Ressource angibt. |
|
Microsoft. |
Bezieht sich auf die allgemeinen Objektattribute |
|
Microsoft. |
Navigationslinks für die Ressource |
|
Microsoft. |
Beschreibt die Mitgliedsinformationen eines Benutzers. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Enthält eine Auflistung von Ressourcen mit JSON-Eigenschaften zur Darstellung der Ausgabe
| Name | Typ | Beschreibung |
|---|---|---|
| attributes |
Microsoft. |
Ruft die Attribute ab. |
| items |
Microsoft. |
Ruft die Auflistungselemente ab. |
| links |
Ruft die Verknüpfungen ab oder legt sie fest. |
|
| totalCount |
integer |
Ruft die Gesamtanzahl ab. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Link stellt einen URI und die HTTP-Methode dar, die die gewünschte Aktion für den Zugriff auf die Ressource angibt.
| Name | Typ | Beschreibung |
|---|---|---|
| headers |
System. |
Ruft die Verknüpfungsheader ab. |
| method |
string |
Die Methode. |
| uri |
string |
Der URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Bezieht sich auf die allgemeinen Objektattribute
| Name | Typ | Beschreibung |
|---|---|---|
| etag |
string |
Ruft das etag ab oder legt es fest. Die Objektversion in Anbietern. |
| objectType |
string |
Der Objekttyp. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Navigationslinks für die Ressource
| Name | Typ | Beschreibung |
|---|---|---|
| next |
Die nächste Seite mit Elementen. |
|
| previous |
Die vorherige Seite mit Elementen. |
|
| self |
Der Selbst-URI. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Beschreibt die Mitgliedsinformationen eines Benutzers.
| Name | Typ | Beschreibung |
|---|---|---|
| accountId |
string |
Ruft die Konto-ID ab, bei der die Rollenzuweisung gebunden ist, oder legt diese fest. |
| attributes |
Microsoft. |
Ruft die Attribute ab. |
| displayName |
string |
Dient zum Abrufen oder Festlegen des Anzeigenamens für den Benutzer. |
| id |
string |
Der Bezeichner des Elements. |
| roleId |
string |
Der Bezeichner der Rolle des Benutzers. |
| userPrincipalName |
string |
Dient zum Abrufen oder Festlegen des Namens des Benutzerprinzipals. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Typ | Beschreibung |
|---|---|---|
| key |
string |
|
| value |
string |