Supprimer un compte utilisateur de tableau de bord
/scim/v2/Users/{id}
Utilisez cet endpoint pour supprimer définitivement un utilisateur de tableau de bord existant en spécifiant la ressource
id
renvoyée par la méthode SCIMPOST
.
Cette opération est similaire à la suppression d’un utilisateur dans la section Utilisateurs de l’entreprise du tableau de bord Braze.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’un jeton SCIM. Vous utiliserez l’origine de votre service comme en-tête de X-Request-Origin
. Pour plus d’informations, consultez la section Provisionnement automatisé des utilisateurs.
Limite de débit
Cet endpoint a une limitation du débit de 5 000 demandes par jour, par entreprise. Cette limitation du débit est partagée avec les endpoints PUT, GET et POST /scim/v2/Users/
, comme documenté dans Limites de débit de l’API.
Paramètres de chemin
Paramètre | Requis | Type de données | Description |
---|---|---|---|
id |
Requis | Chaîne de caractères | L’ID de ressource de l’utilisateur. Ce paramètre est renvoyé par les méthodes POST /scim/v2/Users/ ou GET /scim/v2/Users?filter=userName eq "[email protected]" . |
Corps de la demande
1
2
3
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY
Exemple de demande
1
2
3
4
curl --location --request DELETE 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \
Réponse
Exemple de réponse échouée
1
2
HTTP/1.1 204 Not Found
Content-Type: text/html; charset=UTF-8
Si cet ID ne correspond à aucun développeur dans Braze, l’endpoint répondra avec :
1
2
3
4
5
6
7
8
HTTP/1.1 404 Not Found
Content-Type: text/html; charset=UTF-8
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "User not found",
"status": 404
}