Eliminar un usuario de compañía
Eliminar un usuario de compañía
DELETE/company_users/:token
Permisos requeridos
Dashboard: necesitas al menos uno de estos permisos.
users.dashboard.manage
API Keys: necesitas al menos uno de estos permisos.
company_users.api.manage
Elimina el usuario de compañía y devuelve el objeto eliminado.
Con una API key de Sandbox, eliminar un usuario que tiene acceso a Production responde 403. Usa una API
key de Production o el dashboard.
Prueba este endpoint
Responses
- 200
- 202
- 401
- 403
- 404
- 409
- 422
Usuario eliminado exitosamente
Response Headers
Estado de la proyección local cuando la mutación ya está visible en sandbox.
La mutación ya fue aplicada por la autoridad de configuración, pero su proyección local en sandbox sigue pendiente. No se debe repetir la mutación: reintentarla crearía o modificaría el recurso una segunda vez.
El cuerpo es el mismo que devuelve la respuesta exitosa de este endpoint, con el recurso ya mutado, así que
puedes usarlo sin esperar la proyección. Consulta el Location firmado solo si necesitas leer el recurso
desde sandbox inmediatamente después.
Cuando la proyección alcanza a la autoridad dentro de la misma request, el endpoint responde con su estado
exitoso habitual y X-Soyio-Projection-State: applied en lugar de este 202.
Response Headers
Estado de la proyección local. En este 202 siempre es pending.
Identificador de la empresa cuya configuración fue modificada.
Versión global que la proyección local debe alcanzar.
Segundos sugeridos antes de consultar nuevamente el estado.
Ruta firmada para consultar el estado de la proyección sin credenciales adicionales.
Error de autenticación
Acceso prohibido por permisos, módulo o entorno no habilitado
Recurso no encontrado
Otra mutación sobre la misma configuración compartida se aplicó al mismo tiempo y esta request no se aplicó. No se guardó ningún cambio, así que puedes reintentar la misma request de forma segura.
A diferencia del 202 de proyección pendiente, este 409 indica que la mutación no tuvo efecto.
Error de validación, o un cambio bloqueado porque dejaría cuentas sin poder entrar al dashboard.
Distingue los casos por el campo reason, presente solo en el segundo.