Roles

The API exposes both a root level and a project level end-point to manage the roles in the system.

The differences of the end-points are following:

Root level

  • Gives direct access to all the roles in the system irregardless of project
  • Can be used to create company wide roles, such as COMPANY_ADMIN

Project level

  • Gives access to the roles for a particular project
  • Can be used to create project specific roles, such as PROJECT_LIVE_VIEW

Fetching all the roles in the system

To fetch all the roles of all projects use the root level end-point:

/roles

NOTE

This will only return the roles that are related to the company of the API users. Hence you won't be able to query the roles of other companies through the API.


Disable a user

Disabling a user can be consider as equivalent to removing all the roles from the user. Remember that you can only remove roles that are related to the projects you own.

Removing roles

To remove a role use the following command and end-point

DELETE /roles/{roleId}

Where {roleId} is the unique id of the role retrieved through a role get.

results matching ""

    No results matching ""