Guides
API Reference
Start typing to search…

Role Permissions

View, update and manage permissions associated with a role.

GET /roles/{id}/permissions

Description

Get a list of all the role’s permissions.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/roles/{id}/permissions

Parameters

role_id={id}

Example Request

GET https://app.klipfolio.com/api/1/roles/fedcba9876543210fedcba9876543210/permissions

Example Response

{
 "data": {
"permissions":["account.api","account.eventlog","account.profile","account.settings","account.tokens","admin.annotation","admin.client","admin.datasource","admin.klip","admin.tab","client.access","client.build","client.delete","client.edit","client.login","client.share","dashboard.annotation.edit","dashboard.annotation.view","dashboard.ds_warning.view","dashboard.fullscreen","dashboard.klip","dashboard.library","dashboard.tab","dashboard.theme","datasource.create","datasource.delete","datasource.download","datasource.edit","datasource.import","datasource.share","klip.build","klip.delete","klip.download","klip.edit","klip.email","klip.embed","klip.import","klip.share","tab.build","tab.delete","tab.download","tab.edit","tab.email","tab.import","tab.push","tab.share","user.manage"]
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

PUT /roles/{id}/permissions

Description

Update the permissions associated with the role.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/roles/{id}/permissions

Parameters

role_id={id}

Example Request

PUT https://app.klipfolio.com/api/1/roles/fedcba9876543210fedcba9876543210/permissions -d {"permissions":["account.api","account.eventlog","account.profile","account.settings","account.tokens","admin.annotation","admin.client","admin.datasource","admin.klip","admin.tab","client.access","client.build","client.delete","client.edit","client.login","client.share","dashboard.annotation.edit","dashboard.annotation.view","dashboard.ds_warning.view","dashboard.fullscreen","dashboard.klip","dashboard.library","dashboard.tab","dashboard.theme","datasource.create","datasource.delete","datasource.download","datasource.edit","datasource.import","datasource.share","klip.build","klip.delete","klip.download","klip.edit","klip.email","klip.embed","klip.import","klip.share","tab.build","tab.delete","tab.download","tab.edit","tab.email","tab.import","tab.push","tab.share","user.manage"]}

Example Response

{
 "meta": {
     "status": 200,
     "success": true
 }
}

DELETE /roles/{id}/permissions

Description

Delete a specific role permission.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/roles/{id}/permissions?<field>=<value>

Parameters

None.

Example Request

DELETE https://readme.io/.com/api/1/roles/0123456789abcdef0123456789abcdef/permissions?name='klip.delete'

Example Response

{
"meta": {
      "status": 200,
      "success": true
  }
}