Create a permission bundle

POST

/api/security/bundles

const url = 'https://example.com/api/security/bundles';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"bundle.site_builder","name":"Site Builder","description":"example","permissions":["sites.edit","content.update:Article"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/security/bundles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "bundle.site_builder", "name": "Site Builder", "description": "example", "permissions": [ "sites.edit", "content.update:Article" ] }'

Creates a new permission bundle

Authorizations

bearerAuth

Request Body

application/json

object

required

Bundle ID

string

Example

bundle.site_builder

name

Display name

string

Example

Site Builder

description

Bundle description

string

permissions

Permission keys included in this bundle

Array<string>

Example

[
  "sites.edit",
  "content.update:Article"
]

Responses

200

Bundle created successfully

application/json

object

required

Bundle ID

string

searchId

required

Searchable ID

string

name

required

Display name

string

description

Bundle description

string

permissions

Permission keys included in this bundle. Type-qualified keys may use the form ‘:’.

Array<string>

default:

type

Entity type

string

default: bundle

Example

{
  "id": "bundle.site_builder",
  "searchId": "bundle_site_builder",
  "name": "Site Builder",
  "description": "",
  "permissions": [],
  "type": "bundle"
}

400

Missing bundle id

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}