Skip to main content
POST
/
api
/
v1
/
groups
/
{group_name}
/
members
Add member to group
curl --request POST \
  --url https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "12345678901"
}
'
{
  "status": "member_added",
  "group": "engineering_team:backend",
  "subject": "12345678901"
}

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 adding a member to a group.

​
subject
string
required

User's CPF (Brazilian tax ID) to add to the group

Example:

"12345678901"

Response

Member added to group successfully

Response model for membership operations.

​
status
string
required

Status of the membership operation

Example:

"member_added"

​
group
string
required

Name of the group

Example:

"engineering_team:backend"

​
subject
string
required

CPF of the user involved in the operation

Example:

"12345678901"