BamBam! API Documentation

Roles

Table of contents:

List roles

Returns account roles.

Resource URL
GET
/roles
Example
Request
GET
https://pickles.dobambam.com/api/roles
Sample Response
{
 "success": true,
 "data": [
 {
 "id": 2,
 "name": "member"
 },
 {
 "id": 7,
 "name": "deploy"
 },
 {
 "id": 8,
 "name": "hidden"
 },
 {
 "id": 9,
 "name": "manage"
 },
 {
 "id": 336,
 "name": "source read-only"
 },
 {
 "id": 11,
 "name": "tickets"
 },
 {
 "id": 12,
 "name": "timetrack"
 },
 {
 "id": 14,
 "name": "viewadd"
 },
 {
 "id": 15,
 "name": "viewonly"
 }
 ]
}

Get

Returns a single role.

Resource URL
GET
/role/:roleId
Example
Request
GET
https://pickles.dobambam.com/api/role/336
URL Parameters
Name Description
roleId integer The numerical ID of the desired role.
Sample Response
{
 "success": true,
 "data": {
 "id": 336,
 "name": "source read-only",
 "domains": [
 {
 "access": "MANAGE",
 "resource": "TICKETS"
 },
 {
 "access": "MANAGE",
 "resource": "SOURCE"
 },
 {
 "access": "MANAGE",
 "resource": "WIKI"
 },
 {
 "access": "DEPLOY_PROD",
 "resource": "DEPLOY"
 },
 {
 "access": "MANAGE",
 "resource": "TIME_TRACK"
 }
 ],
 "source": "READ_ONLY"
 }
}
Create a free account
Leave a message

Have a question about BamBam! or one of our apps? Leave a message here and we'll get back to you as soon as we can.