Grant a Role to Groups

Gives one or more groups a role. Everybody in those groups can do what the role allows, and so can anybody added to them later.

This is the normal way access is granted here: grant to the group once, then manage people by membership. {id} is the role’s slug; each entry in groups is a group’s name, such as midaz-viewer-group.

Granting a role a group already holds 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-1061 — the role is reserved for machine credentials; no group may hold it. Revoking it stays open.
• 422 IDE-1067 — the role is declared by a Lerian product, which alone decides the groups it is granted to; the message names it. Grant the access by adding people to the role itself, or to a group the product already grants it to. Nothing is granted when any of the groups is new.
• 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

Grant a Role to Groups

cURL

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

groups · string[] · required

Group identifiers.

Minimum array length: 1

Response

204

No Content