Skip to main content

Group

A group is a collection of subjects. A group can be assigned as a member to a resource with a specific role in order to get access.

Groups are used to manage multiple members in bundles. This makes it easier to manage access rights for multiple subjects at once. If a member gets added or removed from a group that has been a member of a resource, the access rights of the subject are updated automatically.

Examples:

  • The users Lisa and Mark are in the Developers group
  • The users Julia and Bob are in the Administrators group

Manage groups​

The Group API is used to manage groups per tenant.

  • /tenants/<TENANT_ID>/groups

List groups​

curl -i --location "https://<YOUR_API_URL>/management/tenants/<TENANT_ID>/groups" \
  --header "Content-Type: application/json" \
  --header "Authentication: Bearer <YOUR_ACCESS_TOKEN>" \
  --header "apiKey: <YOUR_API_KEY>"

Create a group​

curl -i --location "https://<YOUR_API_URL>/management/tenants/<TENANT_ID>/groups" \
  --request POST \
  --header "Content-Type: application/json" \
  --header "Authentication: Bearer <YOUR_ACCESS_TOKEN>" \
  --header "apiKey: <YOUR_API_KEY>" \
  --data '{
    "id": "<GROUP_ID>",
    "name": "<GROUP_NAME>",
    "subjects": [
      "<SUBJECT_ID>",
      "<SUBJECT_ID>"
    ]
  }'

Update a group​

curl -i --location https://<YOUR_API_URL>/management/tenants/<TENANT_ID>/groups/<GROUP_ID> \
  --request POST \
  --header "Content-Type: application/json" \
  --header "Authentication: Bearer <YOUR_ACCESS_TOKEN>" \
  --header "apiKey: <YOUR_API_KEY>" \
  --data '{
    "name": "<GROUP_NAME>",
    "subjects": [
      "<SUBJECT_ID>",
      "<SUBJECT_ID>"
    ]
  }'