Skip to main content
POST
/
bundles
/
{bundle_id}
/
groups
cURL
curl --request POST \
  --url https://api.opal.dev/v1/bundles/{bundle_id}/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "group_id": "72e75a6f-7183-48c5-94ff-6013f213314b",
  "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess",
  "access_level_name": "AdministratorAccess"
}'
{
  "bundle_id": "a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
  "group_id": "a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
  "access_level_name": "Read",
  "access_level_remote_id": "arn:aws:iam::490306337630:role/SupportUser"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
bundle_id
string<uuid>
required

The ID of the bundle.

Body

application/json
​
group_id
string<uuid>
required

The ID of the group to add.

Example:

"72e75a6f-7183-48c5-94ff-6013f213314b"

​
access_level_remote_id
string

The remote ID of the access level to grant to this user. Required if the group being added requires an access level. If omitted, the default access level remote ID value (empty string) is used.

Example:

"arn:aws:iam::590304332660:role/AdministratorAccess"

​
access_level_name
string

The name of the access level to grant to this user. If omitted, the default access level name value (empty string) is used.

Example:

"AdministratorAccess"

Response

201 - application/json

Group was successfully added to the bundle.

​
bundle_id
string<uuid>

The ID of the bundle containing the group.

Example:

"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1"

​
group_id
string<uuid>

The ID of the group within a bundle.

Example:

"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1"

​
access_level_name
string

The access level of the group within a bundle.

Example:

"Read"

​
access_level_remote_id
string

The remote ID of the access level of the group within a bundle.

Example:

"arn:aws:iam::490306337630:role/SupportUser"