Lire et examiner la documentation Automation Anywhere

Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

Recherche d'utilisateurs API

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

Recherche d'utilisateurs API

Utiliser le Recherche d'utilisateurs pour rechercher tous les utilisateurs dans le répertoire Control Room.

Prérequis

Assurez-vous d'avoir un rôle d'administrateur ou un rôle personnalisé avec l'option Voir les utilisateurs l'autorisation d'afficher les utilisateurs.

Procédure

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

    Corps de la demande :

    {
      "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 demande.

    La requête suivante trouve tous les utilisateurs avec un nom d'utilisateur qui contient admin et qui ont été 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 réponse:
    Nom du paramètre Description
    id Numéro d'identification généré par le système qui a créé un utilisateur.
    nom d'utilisateur Nom d'utilisateur pour un nouvel utilisateur.
    domaine Nom de domaine du répertoire actif.
    version Numéro de version généré par le système pour un nouvel utilisateur.
    e-mail Adresse électronique du nouvel utilisateur.
    passwordSet String : 8-15 caractères ; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, et . (période). Définissez un mot de passe pour un nouvel utilisateur uniquement.
    PrincipalId Numéro d'identification généré par le système d'un utilisateur principal d'Active Directory qui a créé un nouvel utilisateur.
    Autorisation Un ID d'autorisation spécifique.
    licenceFeature Automation Anywhere licence associée à ce rôle.
    Rôles : id Numéro d'identification de rôle généré par le système et associé à cet utilisateur. Chaque utilisateur n'a pas un rôle associé.
    createdBy Numéro d'identification généré par le système d'un utilisateur admin qui a créé un nouvel utilisateur.
    updatedBy Numéro d'identification généré par le système d'un utilisateur admin qui a mis à jour l'utilisateur.
    L'API REST répond à chaque demande par un code de réponse HTTP. Pour plus de détails sur les codes de réponse, voir Codes de réponse de l'API.
Envoyer le commentaire