Revoke a Role from Users in Batch

Takes a role away from several people at once, naming them in the body.

It is a POST rather than a DELETE because the people travel in a request body; DELETE /v1/roles/{id}/users/{userId} does the same for exactly one.

Only the DIRECT grant is revoked. Somebody who also holds this role through a group keeps it, and the call still answers 204 — if the intent is to remove their access entirely, take them out of the group too. Revoking from somebody who does not hold the role is not an error. On success the response has no body (204).

Failures:

• 400 — users is missing or empty.
• 404 — no such role in your organization.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

POST /v1/roles/{id}/users/remove

Revoke a Role from Users in Batch

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/roles/{id}/users/remove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    "<string>"
  ]
}
'

400

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

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Role ID.

Example:

"midaz-editor"

Body

application/json

The users to revoke the role from.

users · string[] · required

User identifiers.

Minimum array length: 1

Response

204

No Content