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).
Remarque : vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.
Les fonctions de recherche, de tri, de pagination et de filtrage sont prises en charge. Un maximum de 2500 enregistrements est renvoyé pour une requête de recherche.
Pour améliorer les performances, spécifiez la liste des attributs que vous souhaitez voir renvoyés en utilisant le paramètre de requête attributs.
Opérateurs de recherche pris en charge :
| eq | Les valeurs de l'attribut et de l'opérateur doivent être identiques pour qu'il y ait correspondance. |
| ne | Les valeurs de l'attribut et de l'opérateur ne sont pas identiques. |
| co | La valeur entière de l'opérateur doit être une sous-chaîne de la valeur de l'attribut pour qu'il y ait correspondance. Pour des raisons de performance, utilisez les opérateurs sw ou ew au lieu de co. |
| sw | Toute la valeur de l'opérateur doit être une sous-chaîne de la valeur de l'attribut, en commençant par le début de la valeur de l'attribut. |
| ew | Toute la valeur de l'opérateur doit être une sous-chaîne de la valeur de l'attribut, en commençant par la fin de la valeur de l'attribut. |
| pr | Si l'attribut a une valeur, il y a correspondance. |
| npr | Si l'attribut n'a pas de valeur, il y a correspondance. |
| gt | Si 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. |
| ge | Si 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. |
| lt | Si 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. |
| le | Si la valeur de l'attribut est inférieure ou égale à la valeur de l'opérateur, il y a correspondance. La comparaison réelle dépend du type d'attribut. |
Exemples de requêtes de recherche :
| 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")&attributs=nom de l'utilisateur,emails |
| filter=emails ew "@ example.com " and ( phoneNumbers eq "15551212" or phoneNumbers eq "1(555)1212")&attributs=nom de l'utilisateur,numéros de téléphone,emails |
| Note : Il y a une syntaxe spéciale pour "phoneNumbers" pour permettre le filtrage en utilisant le type, comme GET /v2.0/Users?filter=phoneNumbers.work eq " {value}"&attributes=phoneNumbers.work |
Pour les locataires qui prennent en charge de grands groupes, des fonctionnalités supplémentaires sont disponibles. Il s'agit de :
| - Rechercher des utilisateurs dans un groupe spécifique en utilisant l'attribut SCIM "memberOf". Par exemple. GET /v2.0/Users?filter=userName sw "patel" and memberOf eq " {group ID} " |
| - Restreindre HelpDesk les administrateurs à gérer des groupes spécifiques d'utilisateurs en utilisant les rôles d'administrateur. |
Pour vérifier si le locataire prend en charge les grands groupes, exécutez l'API GET /v2.0/SCIM/capabilities.