Roles

Represents a list of roles.

Related Help article: Managing Roles and Permissions

Properties

count

The current number of role objects in this list.

role

The list of role objects owned by this collection.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<roles count="5">
  <role>[[[role...|role.html]]]</role>
</roles>

{
  "role" : [ {
    "permissions" : "[[[Permissions...|permissions.html]]]",
    "name" : "Project Developer",
    "id" : "PROJECT_DEVELOPER",
    "href" : "/app/rest/roles/PROJECT_DEVELOPER/project",
    "included" : "[[[roles...|]]]"
  } ],
  "count" : 5
}

Last modified: 18 August 2026