GuidesRecipesAPI ReferenceChangelogDiscussions
Log In



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

  "identifier": "...",
  "name": "...",
  "description": "...",
  "longDescription": "...",
  "weight": 0,
  "type": "...",
  "entitlements": []
identifierstringThe role’s identifier.
namestringThe role’s name.
descriptionstringThe role’s capabilities summary.
longDescriptionstringThe role’s capability details.
weightnumberThe role’s order in interface listings.
typestringDefines 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.