OPopal
bundles

POST /bundles/{bundle_id}/groups

Adds a group to a bundle.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

bundle_idstring uuid required

The ID of the bundle.

Request body

group_idstring uuid required

The ID of the group to add.

access_level_remote_idstring

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.

access_level_namestring

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

Example request

{
  "group_id": "72e75a6f-7183-48c5-94ff-6013f213314b",
  "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess",
  "access_level_name": "AdministratorAccess"
}

Response

Group was successfully added to the bundle.

bundle_idstring uuid

The ID of the bundle containing the group.

group_idstring uuid

The ID of the group within a bundle.

access_level_namestring

The access level of the group within a bundle.

access_level_remote_idstring

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

Example response

{
  "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"
}

Changes

No recorded changes to this operation across all 43 revisions of this API.