Skip to content

Dashboard-Nutzerkonto entfernen

delete

/scim/v2/Users/{id}

Verwenden Sie diesen Endpunkt, um eine:n bestehende:n Dashboard-Nutzer:in dauerhaft zu löschen, indem Sie die Ressourcen-id angeben, die von der SCIM-Methode POST zurückgegeben wird.

Dies ist vergleichbar mit dem Löschen von Nutzer:innen im Bereich Unternehmensnutzer:innen des Braze-Dashboards.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie ein SCIM-Token. Verwenden Sie die Herkunft Ihres Dienstes als X-Request-Origin-Header. Weitere Informationen finden Sie unter Automatisierte Nutzerbereitstellung.

Rate-Limit

Dieser Endpunkt hat ein Rate-Limit von 5.000 Anfragen pro Tag und Unternehmen. Dieses Rate-Limit wird mit den /scim/v2/Users/ PUT-, GET- und POST-Endpunkten geteilt, wie in API-Rate-Limits dokumentiert.

Pfadparameter

Parameter Erforderlich Datentyp Beschreibung
id Erforderlich String Die Ressourcen-ID der/des Nutzer:in. Dieser Parameter wird von den Methoden POST /scim/v2/Users/ oder GET /scim/v2/Users?filter=userName eq "[email protected]" zurückgegeben.

Anfragekörper

1
2
3
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY

Beispielanfrage

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' \

Antwort

Beispiel einer Fehlerantwort

1
2
HTTP/1.1 204 Not Found
Content-Type: text/html; charset=UTF-8

Wenn eine Entwickler:in mit dieser ID nicht in Braze existiert, antwortet der Endpunkt mit:

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
}
New Stuff!