Remover conta de usuário do dashboard

Use esse endpoint para excluir permanentemente um usuário do dashboard existente, especificando o recurso id retornado pelo método SCIM POST.

Isso é semelhante à exclusão de um usuário na seção Usuários da empresa do dashboard da Braze.

Importante

Esse endpoint exige a integração SCIM personalizada. Se você configurou uma integração de provedor de identidade (IdP) (Okta ou Entra ID), não é possível usar esse endpoint; apenas uma ponte SCIM pode ser configurada por empresa.

Pré-requisitos

Para usar esse endpoint, você precisará de um token SCIM. Você usará a Origin do seu serviço como o cabeçalho X-Request-Origin. Para saber mais, consulte Provisionamento automatizado de usuários.

Limite de frequência

Esse endpoint tem um limite de frequência de 5.000 solicitações por dia, por empresa. Esse limite de frequência é compartilhado com os endpoints /scim/v2/Users/ PUT, GET e POST, conforme documentado em Limites de frequência da API.

Parâmetros de caminho

Corpo da solicitação

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

Exemplo de solicitação

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

Resposta

Exemplo de resposta de erro

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

Se um desenvolvedor com essa ID não existir na Braze, o endpoint responderá com:

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
}