Obtenir des utilisateurs

1. Introduction

Pour apporter des modifications ou utiliser des profils d'utilisateur dans d'autres points d'accès, votre application doit connaître l'identifiant de l'utilisateur pour y faire référence. À cette fin, MyQ inclut un point de terminaison appelé GET /users/. Vous pouvez ainsi rechercher, filtrer et obtenir les identifiants de plusieurs utilisateurs ou d'un seul.

2. Les conditions préalables

L'application REST API dans MyQ → Settings → External Systems doit avoir accès à champ d'application appelée Utilisateurs et l'utilisateur connecté sur la page Jeton d'accès doit avoir des droits sur Gérer les utilisateurs ou Administrateur droite.

3. Appeler l'API

Le point final que nous utiliserons dans ce guide est défini comme suit :

CODE

Endpoint:
GET /users

Authentication:
Grant_type: client_credentials
Scopes: []

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Body: {}

Il convient de noter que le %access_token% doit être remplacé par le jeton que vous avez reçu en réponse à la commande point de terminaison d'authentification. L'appel à ce point d'accès sans paramètres GET entraîne une réponse JSON vide.

3.1. Filtrer la recherche

Nom	Type	Description
courriel	chaîne de caractères	Un `Courriel` de l'utilisateur.
nom	chaîne de caractères	Un `Nom d'utilisateur` de l'utilisateur.
carte	chaîne de caractères	L'un des `Carte` de l'utilisateur.
code	chaîne de caractères	Les `code` (numéro personnel) de l'utilisateur.

CODE

GET /users?username=myquser1

Dans cet exemple, nous essayons de filtrer la recherche sur un seul utilisateur avec un nom d'utilisateur myquser1. Si cet utilisateur existe, ses informations sont renvoyées. S'il n'est pas présent, la réponse JSON est vide et contient un champ compter égal à 0.

4. Réponse

CODE

Code:
2xx

Response:
{
   "users":[
      {
         "id":0,
         "username":"string",
         "fullname":"string",
         "email":"string",
         "scanStorage":"string",
         "code":"string",
         "syncSource":"string",
         "lang":"string",
         "phone":"string",
         "ldapDomain":"string",
         "notes":"string"
      }
   ],
   "count":0
}

La réponse JSON comprend tous les utilisateurs qui correspondent à la recherche. Toutes les informations relatives à l'utilisateur sont affichées, y compris le id que nous recherchions. Cela peut être utilisé ultérieurement dans de nombreux points de terminaison. Par exemple, lorsque générer un nouveau pin pour l'utilisateur. Les compter correspond au nombre d'utilisateurs trouvés par la recherche.