Remove Members from a Group in Batch

Takes several people out of a group in one call, naming them in the body.

It is a POST rather than a DELETE because the members travel in a request body; DELETE /v1/groups/{id}/users/{userId} does the same thing for exactly one person. Both exist and both are supported — use whichever fits the screen you are building.

Nobody is deleted: they keep their account and lose only what this group granted them, which for someone whose access came solely through it means losing all of it. Removing somebody who is not a member is not an error. On success the response has no body (204).

Failures:

• 400 — users is missing or empty.
• 404 — no such group 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/groups/{id}/users/remove

Remove Members from a Group in Batch

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/groups/{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

Group ID.

Example:

"midaz-viewer-group"

Body

application/json

The users to remove from the group.

users · string[] · required

User identifiers.

Minimum array length: 1

Response

204

No Content