Obtenir tous les comptes de robots

Renvoie la liste de tous les comptes Robot d'une organisation, en fonction de l'ID de l'organisation.

Point de terminaison de l’API

GET https://{yourDomain}/{organizationName}/identity/api/Setting

Étendues

Nécessite les étendues suivantes :

• PM.RobotAccount
• PM.RobotAccount.Read

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Remarque : pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
partitionGlobalId (requis)	Chaîne de caractères (string)	L'ID de l'organisation pour laquelle vous souhaitez récupérer les comptes Robot.

Paramètres de requête

Paramètre de requête	Type de données	Description
searchTerm (facultatif)	Chaîne de caractères (string)	La clé à partir de laquelle vous souhaitez rechercher les comptes de robot.
top (facultatif)	Int32	Affichez les N principaux comptes de robots.
skip (facultatif)	Int32	Ignorez les N principaux comptes de robots.
sortBy (facultatif)	Int32	Indiquez la propriété DTO utilisée pour trier les entrées d'audit. Par exemple, name, creationTime, id etc.
sortOrder (facultatif)	Int32	Indiquez l'ordre de tri. Par exemple, croissant (asc) ou décroissant (desc).

Réponses

200 OK

Renvoie les comptes de robot interrogés.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://{yourDomain}/{organizationName}/{tenantName}/
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {partitionGlobalId} est : magic-7

• Vous définissez les paramètres de requête suivants :

  • searchTerm = bot
  • top = 2, pour afficher les deux premières entrées
  • skip = 2, pour ignorer les deux premières entrées
  • sortBy = name pour trier les entrées en fonction de leur nom
  • sortOrder = asc pour trier les entrées de la plus ancienne à la plus récente

L’appel devrait ressembler à l'exemple ci-dessous (cURL) :

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Voici le corps de la réponse pour une récupération réussie des entrées d’audit :

{
    "totalCount": 3,
    "results": [
        {
            "id": "55-ab",
            "name": "Bot5",
            "displayName": "Bot5",
            "creationTime": "2021-10-19T18:05:17.3465735",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group2",
                "group3"
            ]
        },
        {
            "id": "66-cd",
            "name": "Bot6",
            "displayName": "Bot6",
            "creationTime": "2021-10-19T18:06:00.3088553",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group3"
            ]
        },
        {
            "id": "77-ef",
            "name": "Bot7",
            "displayName": "Bot7",
            "creationTime": "2021-10-19T18:05:31.4736281",
            "lastLoginTime": null,
            "groupIds": [
                "group2"
            ]
        }
    ]
}