Obtenir tous les groupes dynamiques d'un locataire

get

https://{tenanturl}/v1.0/dynamicgroups/

L'API récupère tous les groupes dynamiques pour un locataire donné, ce qui permet de les filtrer en fonction des critères de recherche spécifiés.
La liste des groupes dynamiques peut être triée par ordre croissant ou décroissant à l'aide du paramètre sort, qui permet de trier par nom de groupe ou par description.
Si le paramètre details est défini sur true, l'API récupérera des informations supplémentaires, telles que l'utilisateur de création et les détails de la dernière modification de l'utilisateur (y compris le nom d'utilisateur et l'adresse électronique).
L'API prend également en charge la pagination, le paramètre page spécifiant le numéro de page pour la récupération des groupes dynamiques, la valeur par défaut étant la première page.
Le paramètre limite détermine le nombre maximum de groupes dynamiques listés par page, avec une valeur par défaut de 25 et une limite maximale de 500.

Droit d'accès requis : tenantAdmin, manageDynamicGroups, readDynamicGroups
Note : Vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Filtre de recherche. Attributs pris en charge : id, name, description, status.
La longueur maximale est de 4096 caractères.
Valeurs autorisées pour l'attribut status : waiting, inprogress, reviewpublish, failed, active, active_waiting, active_inprogress, active_reviewpublish, active_failed, waiting_for_deletion, deleting.

Syntaxe : - Les opérateurs utilisés avec les chaînes de caractères sont = et!=.

Les opérateurs pour les booléens sont =,!=.
Les opérateurs pour les nombres sont >, <, >=, <=, =,!=.
Les opérateurs logiques sont &, |.
Des parenthèses pour préciser explicitement l'ordre de priorité souhaité des instructions.
Utilisez des guillemets doubles pour les valeurs de type chaîne.

Par exemple :
search=name="roleName"&status="active"
search=description="roleDescription"|(name!="roleName"&status="waiting")

sort

string

Trier le résultat par valeurs d'attributs. Attributs pris en charge : nom, description.
(+ croissant, - décroissant)
La valeur par défaut est l'ordre croissant.

Par exemple : sort=-name (trier les résultats par ordre décroissant de nom)

details

string

enum

Defaults to false

Si la valeur "details" est fixée à "true", elle fournit des informations supplémentaires sur l'utilisateur qui a créé ou modifié en dernier lieu le groupe dynamique.

Allowed:

attributes

string

Filtrer le résultat en fonction des attributs. Attributs pris en charge : id, name, description, status.

Par exemple : search=id,name,status (La réponse est filtrée pour n'inclure que l'id, le nom et le statut)

countDynamicGroups

string

enum

Defaults to true

Si countDynamicGroups a la valeur true, le nombre total de groupes dynamiques pour le locataire donné est calculé.

Allowed:

limit

string

Defaults to 25

Nombre maximal de ressources pour une page. Par défaut, jusqu'à 25 ressources sont renvoyées par page si le paramètre de requête limit n'est pas spécifié. La valeur maximale autorisée pour le paramètre limite est de 500.

Par exemple, si le paramètre de limite est fixé à 5, 5 ressources sont recherchées pour une page.

page

string

Defaults to 1

Numéro de page utilisé pour obtenir des ressources pour une page spécifique. Les ressources sont renvoyées pour la première page si aucun paramètre de requête de page n'est transmis ou si moins de 1 est transmis.

Par exemple, si le paramètre page est défini sur 2, les ressources sont récupérées pour la deuxième page.

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200Recherche de tous les groupes dynamiques d'un locataire.

400Demande incorrecte

401Unauthorized

500Erreur de serveur interne