Récupère les détails d'un groupe pour un locataire spécifié.

Habilitation requise : readUserGroups (Lire les utilisateurs et les groupes), ou manageUserGroups (Gérer les utilisateurs et les groupes), ou manageAllUserGroups (Synchroniser les utilisateurs et les groupes), ou manageUserStandardGroups (Gérer les utilisateurs et les groupes standard), ou readGroups (Lire tous les groupes mais pas leurs membres), ou readStandardGroups (Lire les groupes standard mais pas leurs membres), ou readGroupMembers (Lire tous les groupes et leurs membres), ou readStandardGroupMembers (Lire les groupes standard et leurs membres), ou manageGroups (Gérer tous les groupes mais pas leurs membres), ou manageStandardGroups (Gérer les groupes standard mais pas leurs membres), ou manageGroupMembers (Gérer tous les groupes et leurs membres), ou manageStandardGroupMembers (Gérer les groupes standard et leurs membres).
Remarque : vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.

Pour améliorer les performances, spécifiez la liste des attributs que vous souhaitez voir renvoyés en utilisant les paramètres de requête attributs et memberAttributes.

En cas de succès, la réponse renvoyée contient les membres et les détails du groupe.

Limitations pour les locataires qui ne prennent pas en charge les grands groupes :
Lorsque vous spécifiez allNestedUsers membershipType,, si le nombre d'utilisateurs imbriqués dépasse 10 000, LargeGroupResponse ( HTTP Status Code 207) est renvoyé. Si le nombre total d'utilisateurs imbriqués ne peut être déterminé, la valeur totalMembers est fixée à -1. En spécifiant un membershipType autre que allNestedUsers,, si le groupe compte plus de 10 000 membres, le LargeGroupResponse ( HTTP Status Code 207) est renvoyé. Lorsque l'adresse LargeGroupResponse est renvoyée, les paramètres memberAttributes, memberCount, et memberStartIndex sont ignorés.

Les locataires qui prennent en charge des groupes importants peuvent parcourir tous les membres d'un groupe pour toutes les requêtes membershipType. Chaque appel au point d'extrémité renvoie au maximum 2 500 membres du groupe. S'il existe d'autres membres du groupe qui n'ont pas été renvoyés, un élément supplémentaire appelé "bookmark" est renvoyé dans le contenu de la réponse. Pour obtenir l'ensemble suivant de membres, l'appelant effectue un appel supplémentaire au même point d'accès et transmet la valeur du signet en tant que paramètre de requête nommé "nextPage". Par exemple ?nextPage=XASDGAJDGKAWHGI=. L'appelant continue d'appeler le point final jusqu'à ce qu'aucun élément de signet ne soit renvoyé dans la charge utile de la réponse, ce qui indique que tous les membres du groupe ont été renvoyés. Les adresses memberStartIndex et memberCount sont prises en charge par les 2 500 membres renvoyés.

Pour vérifier si le locataire prend en charge les grands groupes, exécutez l'API GET /v2.0/SCIM/capabilities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

L'identifiant unique du groupe dont les détails doivent être récupérés. Cet identifiant est transmis dans le chemin d'accès au site URL.

Query Params
string

La liste des attributs qui sont transmis sous forme de valeurs séparées par des virgules et qui sont utilisées lors de la transmission du résultat à l'appelant. Pour améliorer les performances, ne spécifiez dans la liste que les attributs que vous souhaitez voir renvoyés. Si aucune liste n'est fournie, l'action par défaut est de renvoyer tous les attributs.

string
enum
Defaults to firstLevelUsersAndGroups

Type de membres du groupe à récupérer : "firstLevelUsersAndGroups" (par défaut) renvoie les utilisateurs et les groupes directement contenus dans group."allNestedUsers" renvoie tous les utilisateurs (y compris les utilisateurs imbriqués) contenus dans group."firstLevelUsers" renvoie les utilisateurs directement contenus dans group."firstLevelGroups" renvoie les groupes directement contenus dans le groupe.

Allowed:
string

La liste des attributs qui sont transmis en tant que valeurs séparées par des virgules pour renvoyer les membres des groupes lors de la transmission du résultat à l'appelant. Pour améliorer les performances, ne spécifiez dans la liste que les attributs que vous souhaitez voir renvoyés. Si aucune liste n'est fournie, l'action par défaut est de renvoyer tous les attributs.

string

Le nombre qui indique le nombre de membres de ce groupe qui seront renvoyés. Une valeur négative est interprétée comme 0. La valeur 0 indique qu'aucun résultat de membre ne doit être renvoyé, à l'exception de totalMembers.

string

Un index basé sur 1 qui indique l'index de départ utilisé lorsque les membres du groupe sont renvoyés. Une valeur inférieure à 1 est interprétée comme 1.

string

Le signet qui indique la page suivante des membres à renvoyer.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/scim+json