Revoke a Role from Groups in Batch

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

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

The groups themselves are untouched and keep their members. Revoking from a group that does not hold the role is not an error. On success the response has no body (204).

Failures:

• 400 — groups is missing or empty.
• 404 — no such role in your organization.
• 422 IDE-1067 — the role is declared by a Lerian product, which alone decides the groups it is granted to, and one of the groups holds it; the message names the role. Change who has the access by adding or removing people on the role itself, or in a group the product grants it to. Nothing is revoked. A role reserved for machine credentials stays open to revoke.
• 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}/groups/remove

Revoke a Role from Groups in Batch

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/roles/{id}/groups/remove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    "<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 groups to revoke the role from.

groups · string[] · required

Group identifiers.

Minimum array length: 1

Response

204

No Content