role

Body Params
string
required

Name of the Role (e.g. "Administrator"). <100 chars

boolean
Defaults to false

Whether the Role is global, across Accounts. Only Super Users can create or edit a global Role .

int32
required

This Role inherits permissions from another Role. New non-Global roles should inherit permissions from existing Global Roles. Only Global Roles should set this field to zero.

permissions
array
required

Array of permissions in the format "object_type":int. Object_types must be supported and valid. Integer values must be between zero (no rights) and 15 (all rights).

permissions*
string

Notes about the Role

boolean

Whether Role is active. if a Role is set to inactive, Buzz will not alter permissions for existing Users associated with that Role, but will prevent new Users from having that Role assigned.

Response

Language
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json