Récupère une liste d'utilisateurs appartenant à un locataire spécifié et correspondant aux critères du filtre de recherche.

Intitulé requis : 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 readUsers (Lire tous les utilisateurs mais pas les membres des groupes), ou readUsersGroupMembership (Lire tous les utilisateurs et les membres des groupes), ou readUsersStandardGroupMembership (Lire tous les utilisateurs et les membres des groupes standard), ou manageUsers (Gérer tous les utilisateurs), ou manageUsersInStandardGroups (Gérer les utilisateurs dans les groupes standard).
Note : vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.

La recherche, le tri, la pagination et le filtrage sont pris en charge. Une requête de recherche renvoie au maximum 2 500 enregistrements. Pour récupérer plus de 2 500 enregistrements, il est recommandé d'exécuter des états. Voir Rapports utilisateur

Pour améliorer les performances, précisez la liste des attributs que vous souhaitez obtenir à l'aide du paramètre de requête attributes.

Opérateurs de recherche pris en charge :

eqLes valeurs de l'attribut et de l'opérateur doivent être identiques pour qu'il y ait correspondance.
neLes valeurs de l'attribut et de l'opérateur ne sont pas identiques.
coPour qu'il y ait correspondance, la valeur complète de l'opérateur doit être une sous-chaîne de la valeur de l'attribut. Pour des raisons de performance, utilisez les opérateurs sw ou ew au lieu de co.
swLa valeur entière de l'opérateur doit être une sous-chaîne de la valeur de l'attribut, commençant au début de la valeur de l'attribut.
ewLa valeur entière de l'opérateur doit être une sous-chaîne de la valeur de l'attribut, correspondant à la fin de la valeur de l'attribut.
prSi l'attribut a une valeur, il y a correspondance.
nprSi l'attribut n'a pas de valeur, il y a correspondance.
gtSi la valeur de l'attribut est supérieure à la valeur de l'opérateur, il y a correspondance. La comparaison réelle dépend du type d'attribut.
geSi la valeur de l'attribut est supérieure ou égale à la valeur de l'opérateur, il y a correspondance. La comparaison réelle dépend du type d'attribut.
ltSi la valeur de l'attribut est inférieure à la valeur de l'opérateur, il y a correspondance. La comparaison réelle dépend du type d'attribut.
leSi la valeur de l'attribut est inférieure ou égale à la valeur de l'opérateur, il y a correspondance. La comparaison effective dépend du type d'attribut.


Exemple de recherche queries:
filter=userName eq "bob"&attributes=userName
filter=name.familyName eq "Marley"&attributes=name
filter= meta.created ge "2011-09-20T00:00:00Z" and meta.created le "2021-09-21T00:00:00Z"&attributes=userName,meta.created,emails&sortBy=userName&count=2500
filter=urn:ietf:params:scim:schemas:extension:ibm:2.0:User:customAttributes.favoriteColor eq "blue"&attributes=userName,urn:ietf:params:scim:schemas:extension:ibm:2.0:User:customAttributes.favoriteColor&count=2500
filter=urn:ietf:params:scim:schemas:extension:enterprise:2 .0:User:department eq "2A"&attributes=userName,emails,urn:ietf:params:scim:schemas:extension:enterprise:2 .0:User:manager
filter=not (emails ew "@example.com")&attributes=userName,emails
filter=emails ew "@ example.com " and ( phoneNumbers eq "15551212" or phoneNumbers eq "1( 555)1212")&attributes=userName,phoneNumbers,emails
Note: Il existe une syntaxe spéciale pour "phoneNumbers" permettant de filtrer en fonction du type, par exemple GET /v2.0/Users?filter=phoneNumbers.work eq "{value}" &attributes=phoneNumbers.work


Pour les locataires prenant en charge les grands groupes, des fonctionnalités supplémentaires sont disponibles. Il s'agit des éléments suivants :
- Rechercher des utilisateurs appartenant à un groupe spécifique à l'aide de l'attribut SCIM "memberOf". Par exemple. GET /v2.0/Users?filter=userName sw patel et memberOf eq "{group ID}"
- Limiter les administrateurs HelpDesk à la gestion de groupes spécifiques d'utilisateurs à l'aide des rôles d'administrateur.

Pour vérifier si le tenant 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…
Query Params
string

Le filtre de recherche conforme au SCIM. Par exemple : userName eq john. Le filtre ne doit pas dépasser 4096 caractères.

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

Limiter le nombre d'enregistrements correspondant au filtre de recherche. La plage va de 1 à 2 500. Si aucune valeur n'est indiquée, la limite par défaut est de 2 500.

string

Spécifie le nombre maximum de résultats de la requête par page. Une valeur négative est interprétée comme 0. La valeur 0 indique qu'aucun résultat n'est renvoyé, à l'exception de totalResults.

string

Un index basé sur 1 qui indique l'index de départ utilisé lorsque le nombre d'utilisateurs est retourné. Une valeur inférieure à 1 est interprétée comme 1.

string
enum

Trier les résultats en fonction des critères spécifiés lorsque les utilisateurs sont renvoyés.

Allowed:
string

L'ordre de tri lorsque le nombre d'utilisateurs est renvoyé.

string

Liste d'attributs séparés par des virgules dont les valeurs doivent être hachées.

string

Chaîne de caractères recherchée dans les enregistrements des utilisateurs.

Responses

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