Roles

Overview

As prebuilt groups of entitlements, roles are elements that get assigned to API keys to authorize access to different kinds of calls. Modzy provides both a set of predefined Roles and the ability to create Custom Roles as needed. Further details are available in our Authorization section.

The roles object

JSON

{
  "identifier": "...",
  "name": "...",
  "description": "...",
  "longDescription": "...",
  "weight": 0,
  "type": "...",
  "entitlements": []
}

Parameter	Type	Description
identifier	string	The role’s identifier.
name	string	The role’s name.
description	string	The role’s capabilities summary.
longDescription	string	The role’s capability details.
weight	number	The role’s order in interface listings.
type	string	Defines if the role can be assigned to a project key or team key. Roles with user type can be assigned to team keys while roles with system type are assigned to project keys upon creation.