Skip to main content
POST
/
api
/
v1
/
roles
/
groups
/
{group_name}
/
roles
Assign Role To Group
curl --request POST \
  --url https://services.pref.rio/heimdall-admin/api/v1/roles/groups/{group_name}/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_name": "data_analyst:read"
}
'
{
  "group": "engineering_team:backend",
  "role": "data_analyst:read",
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
group_name
string
required

Body

application/json

Request model for assigning a role to a group.

​
role_name
string
required

Name of the role to assign to the group (lowercase letters, numbers, underscores, and colons only)

Pattern: ^[a-z0-9_:]+$
Example:

"data_analyst:read"

Response

Successful Response

Response model for role assignment operations.

​
status
string
required

Status of the role assignment operation

Example:

"success"

​
group
string
required

Name of the group the role was assigned to

Example:

"engineering_team:backend"

​
role
string
required

Name of the role that was assigned

Example:

"data_analyst:read"