List permission bundles

GET

/api/security/bundles

const url = 'https://example.com/api/security/bundles';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/api/security/bundles \
  --header 'Authorization: Bearer <token>'

Retrieves all permission bundles in the system

Authorizations

bearerAuth

Responses

200

Bundles retrieved successfully

application/json

Array of permission bundles

Array<object>

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