- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
Référence d'API pour supprimer des comptes Robot dans Test Cloud privé, y compris les points de terminaison, les champs de demande et les réponses.
Supprime plusieurs comptes Robot d'une organisation, en fonction de l'ID de l'organisation.
Point de terminaison de l’API
DELETE https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/{partitionGlobalId}
Étendues
Nécessite les étendues suivantes :
- PM.RobotAccount
- PM.RobotAccount.Write
En-têtes de requête.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites dans Méthodes d'authentification.
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. |
Corps de la requête
Le corps de la requête contient la liste des ID de comptes Robot que vous souhaitez supprimer en bloc de l'organisation.
{
"robotAccountIDs": [
"string",
"string"
]
}
{
"robotAccountIDs": [
"string",
"string"
]
}
Réponses
200 OK
Les comptes de robot indiqués sont supprimés de l'organisation.
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}/identity_ - Votre
{access_token}est :1234(pour des considérations de longueur). - Le
{partitionGlobalId}est :3fa85f64-5717-4562-b3fc-2c963f66afa6 - Les utilisateurs que vous souhaitez supprimer ont les ID suivants :
- Bot1:
11-xy - Bot2 :
22-tz
- Bot1:
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"robotAccountIDs": [
"11-xy",
"22-tz"
]
}'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/identity_/api/RobotAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"robotAccountIDs": [
"11-xy",
"22-tz"
]
}'