Supprimer un compte utilisateur de tableau de bord

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 SCIM POST.

Cette opération est similaire à la suppression d’un utilisateur dans la section Utilisateurs de l’entreprise du tableau de bord de Braze.

Important

Cet endpoint nécessite l’intégration SCIM personnalisée. Si vous avez configuré une intégration de fournisseur d’identité (IdP) (Okta ou Entra ID), vous ne pouvez pas utiliser cet endpoint ; une seule passerelle SCIM peut être configurée par entreprise.

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 X-Request-Origin. Pour plus d’informations, consultez la section Provisionnement automatisé des utilisateurs.

Limite de débit

Cet endpoint a une limite de débit de 20 000 requêtes par jour et par société. Cette limite de 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

Corps de la requête

1
2
3
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-HERE

Exemple de requête

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 réussie

Lorsque l’utilisateur est définitivement supprimé, l’endpoint renvoie :

1
HTTP/1.1 204 No Content

Exemples de réponses d’erreur

Si aucun développeur avec cet ID n’existe dans Braze, l’endpoint répond 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
}

Si vous tentez de supprimer le dernier utilisateur restant de l’entreprise, l’endpoint renvoie une réponse 500 Internal Server Error et ne supprime pas l’utilisateur :

1
2
3
4
5
6
7
8
HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
    "detail": "Failed to delete user",
    "status": 500
}