Eliminar cuenta de usuario del panel

Utiliza este endpoint para eliminar de forma permanente un usuario existente del panel especificando el recurso id devuelto por el método SCIM POST.

Esto es similar a eliminar un usuario en la sección Usuarios de la empresa del panel de Braze.

Importante

Este endpoint requiere la integración SCIM personalizada. Si configuraste una integración de proveedor de identidad (IdP) (Okta o Entra ID), no puedes usar este endpoint; solo se puede configurar un puente SCIM por empresa.

Requisitos previos

Para utilizar este endpoint, necesitarás un token SCIM. Utilizarás el origen de tu servicio como encabezado X-Request-Origin. Para más información, consulta Aprovisionamiento automatizado de usuarios.

Límite de velocidad

Este endpoint tiene un límite de velocidad de 20 000 solicitudes por día y empresa. Este límite de velocidad se comparte con los endpoints PUT, GET y POST de /scim/v2/Users/, como se documenta en Límites de velocidad de la API.

Parámetros de la ruta

Cuerpo de la solicitud

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

Ejemplo de solicitud

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

Respuesta

Ejemplo de respuesta exitosa

Cuando el usuario se elimina de forma permanente, el endpoint devuelve:

1
HTTP/1.1 204 No Content

Ejemplos de respuestas de error

Si un desarrollador con este ID no existe en Braze, el endpoint responde con:

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 intentas eliminar al último usuario restante de la empresa, el endpoint devuelve una respuesta 500 Internal Server Error y no elimina al usuario:

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
}