Supprimer des utilisateurs

Supprime plusieurs utilisateurs d'une organisation, en fonction des ID des utilisateurs.

Point de terminaison de l’API

DELETE https://{yourDomain}/identity/api/User

Étendues

Nécessite les étendues suivantes :

• PM.User
• PM.User.Write

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.

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"
  ]
}

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.

• Your {baseURL} is: https://{yourDomain}/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 :

  • Dolores Ombrage : dol-2908
  • Quirinus Quirrell : qui-2609

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request DELETE 'https://{yourDomain}/identity/api/User' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userIds": [
        "dol-2908", "qui-2609"
    ]
}'