v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create a Base Role

post/base-roles/

Request body

namestring required

name of the base role to be created

descriptionstring

description for the base role being created

keystring required

key of the base role to be created

permission_idsstring[]

Array of permission_ids to add to the base role

permission_keysstring[]

Array of permission_keys to add to the base role

role_template_idstring

id of the role template to add permissions from

role_template_keystring

key of the role template to add permissions from

Response

201

idstring

urlstring

client_idstring

namestring

descriptionstring

keystring

created_atstring

is_activeboolean

Example response

{
  "id": "5678b4cf-7ec5-46fb-b54b-449c689325d0",
  "url": "https://cf-blast-dig.livelikecdn.com/api/v1/base-roles/5678b4cf-7ec5-46fb-b54b-449c689325d0/",
  "client_id": "ROA1TtZi9rGdYeGVRdHCs5oBc3J3o4fOgNlh1FPN",
  "name": "Test Base Role",
  "description": "Example Description",
  "key": "test-base-role",
  "permissions": [
    {
      "id": "8ef670c4-a740-4758-ac1d-70121c5550d5",
      "url": "https://cf-blast-dig.livelikecdn.com/api/v1/permissions/8ef670c4-a740-4758-ac1d-70121c5550d5/",
      "name": "Publish Alert",
      "key": "publish-alert",
      "created_at": "2023-12-29T00:15:49.123000Z"
    }
  ],
  "created_at": "2025-05-21T11:03:06.841084Z",
  "is_active": true
}