Add Members to a Group

Puts one or more people into a group.

{id} is the group’s name, a slug such as midaz-viewer-group; each entry in users is a user id. Called after a person is created, and whenever someone changes team.

Adding somebody already in the group is not an error: the call is idempotent per member, so a partially applied form can safely be submitted again. 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

Add Members to a Group

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/groups/{id}/users \
  --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 add to the group.

users · string[] · required

User identifiers.

Minimum array length: 1

Response

204

No Content