Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

API Rechercher des utilisateurs

  • Mis à jour le : 1/28/2021
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA
    • Docs API

API Rechercher des utilisateurs

Utilisez l’API Rechercher des utilisateurs pour effectuer une recherche portant sur tous les utilisateurs dans la Salle de contrôle.

Prérequis

Assurez-vous d’avoir un rôle d’administrateur ou un rôle personnalisé avec l’autorisation Afficher les utilisateurs.

Procédure

  1. Ajoutez le jeton d’authentification à l’en-tête de la requête.
  2. Appliquez des filtres pour exécuter des requêtes conditionnelles de base et une commande de pagination pour le traitement des pages Web. Il existe trois fonctions de base liées au filtrage : conditions de filtrage, colonnes de tri et paramètres de pagination. Reportez-vous à la rubrique Filtres dans un corps de demande API.
  3. Utilisez la méthode POST et l’URL du point de terminaison :<your_control_room_url>/v1/usermanagement/users/list

    Corps de la requête :

    {
      "fields": [],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "username",
            "value": "mdadmin"
          },
          {
            "operator": "gt",
            "field": "createdOn",
            "value": "2020-09-01T00:00:00.989Z"
          },
          {
            "operator": "lt",
            "field": "createdOn",
            "value": "2020-09-06T23:00:00.123Z"
          }
        ]
      }
    }
  4. Envoyez la requête.

    La requête suivante trouve tous les utilisateurs dont le nom d’utilisateur contient admin et créés entre le 1er septembre et le 6 septembre 2020.

    Corps de réponse :
    {
      "page": {
        "offset": 0,
        "total": 310,
        "totalFilter": 2
      },
      "list": [
        {
          "id": 1513,
          "username": "mdadmin",
          "domain": "",
          "firstName": "MD_tester",
          "lastName": "MD_user",
          "version": 17,
          "principalId": 1513,
          "email": "md@aa.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "To be used for API testing",
          "createdBy": 1,
          "createdOn": "2020-09-01T11:01:17.760Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-01T11:01:17.760Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            },
            {
              "id": 2,
              "name": "AAE_Basic"
            }
          ],
          "deleted": false
        },
        {
          "id": 1520,
          "username": "mt_admin",
          "domain": "",
          "firstName": "",
          "lastName": "",
          "version": 6,
          "principalId": 1520,
          "email": "a@a.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "",
          "createdBy": 1,
          "createdOn": "2020-09-02T08:47:19.723Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-02T08:47:19.723Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            }
          ],
          "deleted": false
        }
      ]
    }

    La réponse a renvoyé des données pour deux noms d’utilisateur contenant le mot admin, mdadmin et mt_admin.

    Paramètres de la réponse :
    Nom du paramètre Description
    id Numéro d’identifiant généré par le système ayant créé un utilisateur.
    username Nom d’utilisateur pour un nouvel utilisateur.
    domain Nom de domaine Active Directory.
    version Numéro de version généré par le système pour un nouvel utilisateur.
    email Nouvelle adresse e-mail utilisateur.
    passwordSet Chaîne : 8 à 15 caractères ; a-z, A-Z, 0-9, @, -, _, !, #, $, %, & et . (point). Définissez un mot de passe uniquement pour un nouvel utilisateur.
    PrincipalId Numéro d’identifiant généré par le système d’un utilisateur principal Active Directory ayant créé un nouvel utilisateur.
    Autorisation Identifiant d’autorisation spécifique.
    licenseFeature Licence Automation Anywhere associée à ce rôle.
    Roles: id Numéro d’identifiant de rôle généré par le système associé à cet utilisateur. Tous les utilisateurs ne possèdent pas de rôle associé.
    createdBy Numéro d’identifiant généré par le système pour un utilisateur administrateur ayant créé un nouvel utilisateur.
    updatedBy Numéro d’identifiant généré par le système pour un utilisateur administrateur ayant modifié l’utilisateur.
    L’API REST répond à chaque requête par un code de réponse HTTP. Pour plus d’informations sur les codes de réponse, consultez Codes de réponse de l'API.
Envoyer le commentaire