Get permission bundle by ID

GET

/api/security/bundles/{id}

const url = 'https://example.com/api/security/bundles/example';
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/example \
  --header 'Authorization: Bearer <token>'

Retrieves a specific permission bundle

Authorizations

bearerAuth

Parameters

Path Parameters

required

Bundle ID

string

Responses

200

Bundle retrieved 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"
}

404

Bundle not found

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