Manage account profiles - Get user members by role
Obtient un segment des membres utilisateur d’un rôle limité à une taille spécifique.
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}Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
Identificateur de rôle. |
|
version
|
path | True |
string |
Version de l’API. |
|
seek
|
query |
string |
Opération de recherche à effectuer sur les membres de l’utilisateur du rôle. Cela est utile dans les scénarios de pagination où les pages suivantes ou précédentes des membres de l’utilisateur sont nécessaires. |
|
|
size
|
query |
integer int32 |
Le nombre maximal de membres d’utilisateur à retourner, la valeur ne doit pas être supérieure à 500 et ne doit pas être inférieure à 1 |
|
|
sort
|
query |
string |
Paramètre de tri facultatif pour le sens par lequel trier, les valeurs acceptées sont croissants et décroissants, la valeur par défaut est Croissant |
|
|
sort
|
query |
string |
Un paramètre de tri facultatif pour le champ à trier, les valeurs acceptées sont DisplayName et UserPrincipalName, la valeur par défaut est UserPrincipalName. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Jeton du porteur d’autorisation |
| Accept | True |
string |
Type de contenu acceptable ; application de type largement accepeted/json |
| ms-correlationid |
string |
Utilisé pour le suivi des demandes en interne. Si un ms-correlationid n’est pas fourni, le serveur en génère un nouveau pour chaque requête |
|
| ms-requestid |
string |
Utilisé pour l’idempotency des requêtes. Si un ms-requestid n’est pas fourni, le serveur en génère un nouveau pour chaque requête |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
La demande a réussi. Le corps de la réponse contient la liste des membres de l’utilisateur. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Une entrée est manquante ou non valide. Le corps de la réponse fournit les détails de l’erreur. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
La demande n’a pas été authentifiée. Le client doit d’abord s’authentifier auprès du service d’API partenaire. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
La demande a été authentifiée, mais a été refusée, car l’appelant n’a pas les droits de l’appeler. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
La ressource est introuvable ou non disponible avec les paramètres d’entrée donnés. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
Le service d’API partenaire ou l’une de ses dépendances n’a pas pu répondre à la demande. Les appelants peuvent réessayer. Media Types: "application/json", "text/json" |
Définitions
| Nom | Description |
|---|---|
|
Microsoft. |
Contient une collection de ressources avec des propriétés JSON pour représenter la sortie |
|
Microsoft. |
Link représente un URI et la méthode HTTP qui indique l’action souhaitée pour accéder à la ressource. |
|
Microsoft. |
Fait référence aux attributs d’objet courants |
|
Microsoft. |
Liens de navigation pour la ressource |
|
Microsoft. |
Décrit les informations de membre d’un utilisateur. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
Contient une collection de ressources avec des propriétés JSON pour représenter la sortie
| Nom | Type | Description |
|---|---|---|
| attributes |
Microsoft. |
Obtient les attributs. |
| items |
Microsoft. |
Obtient les éléments de collection. |
| links |
Obtient ou définit les liens. |
|
| totalCount |
integer |
Obtient le nombre total. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
Link représente un URI et la méthode HTTP qui indique l’action souhaitée pour accéder à la ressource.
| Nom | Type | Description |
|---|---|---|
| headers |
System. |
Obtient les en-têtes de lien. |
| method |
string |
Méthode. |
| uri |
string |
The URI. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Fait référence aux attributs d’objet courants
| Nom | Type | Description |
|---|---|---|
| etag |
string |
Obtient ou définit l’etag. Version de l’objet dans les fournisseurs. |
| objectType |
string |
Type d’objet. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
Liens de navigation pour la ressource
| Nom | Type | Description |
|---|---|---|
| next |
Page suivante des éléments. |
|
| previous |
Page précédente des éléments. |
|
| self |
Uri d’auto. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Décrit les informations de membre d’un utilisateur.
| Nom | Type | Description |
|---|---|---|
| accountId |
string |
Obtient ou définit l’ID de compte où l’attribution de rôle est liée. |
| attributes |
Microsoft. |
Obtient les attributs. |
| displayName |
string |
Obtient ou définit le nom complet de l’utilisateur. |
| id |
string |
Identificateur du membre. |
| roleId |
string |
Identificateur du rôle de l’utilisateur. |
| userPrincipalName |
string |
Obtient ou définit le nom du principal de l’utilisateur. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Nom | Type | Description |
|---|---|---|
| key |
string |
|
| value |
string |