automation-suite
2023.10
false
- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
- Update User
- Supprimer un utilisateur spécifique
- Supprimer des utilisateurs
Important :
La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.
Guide d'Automation Suite
Supprime plusieurs utilisateurs d'une organisation, en fonction des ID des utilisateurs.
Point de terminaison de l’API
DELETE https://{yourDomain}/{organizationName}/identity_/api/User
Étendues
Nécessite les étendues suivantes :
PM.UserPM.User.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'
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 | Chaîne de caractères (string) | Requis. 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.
{
"partitionGlobalId": "string",
"userIds": [
"string"
]
}
{
"partitionGlobalId": "string",
"userIds": [
"string"
]
}
Réponses
204 Réussite
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}/{tenantName}/ - Votre
{access_token}est :1234(pour des considérations de longueur). - Le
{partitionGlobalId}est :magic-7 - Les utilisateurs que vous souhaitez supprimer ont les ID suivants :
- Dolores Ombrage :
dol-2908 - Quirinus Quirrell :
qui-2609
- Dolores Ombrage :
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId": "magic-7",
"userIds": [
"dol-2908", "qui-2609"
]
}'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"partitionGlobalId": "magic-7",
"userIds": [
"dol-2908", "qui-2609"
]
}'