Remove user phone number

Clears the user’s phone number and country code together. Idempotent: removing an already-absent phone succeeds.

Refused while a legacy SMS MFA enrollment is still recorded for the user, because its codes were delivered to that number. This is NOT achievable through PATCH /v1/users/{id}, which ignores an empty phone by design.

TWO kinds of caller reach this route and they are authorized differently: a member clearing their OWN number needs no administrative role, while anyone clearing SOMEONE ELSE’S needs the same grant that PATCH /v1/users/{id} requires.

On success the response has no body (204).

Failures:

• 400 — {id} is not a UUID.
• 401 — no bearer token.
• 403 — you may not act on this user.
• 404 — no such user.
• 409 IDE-0056 — a legacy SMS MFA enrollment is still recorded for this user.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

DELETE /v1/users/{id}/phone

Remove user phone number

cURL

curl --request DELETE \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/phone \
  --header 'Authorization: Bearer <token>'

400

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id · string · obrigatório

Target User ID.

Exemplo:

"00000000-0000-0000-0000-000000000000"

Resposta

204

No Content