Role

Represents a role.

Related Help article: Managing Roles and Permissions

Properties

Field	Data type
`id`	`string`
`name`	`string`
`included`	`Roles`
`permissions`	`Permissions`
`href`	`string`

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.

<role href="string" id="string" name="string">
  <included count="123">
    <role>[[[role...|]]]</role>
  </included>
  <permissions count="123">
    <permission>[[[permission...|permission.html]]]</permission>
  </permissions>
</role>

{
  "permissions" : {
    "count" : 5,
    "permission" : [ {
      "name" : "Configure server data cleanup",
      "global" : true,
      "id" : "run_build, view_project, manage_build_problems"
    } ]
  },
  "name" : "name",
  "id" : "id",
  "href" : "href",
  "included" : {
    "role" : [ {
      "permissions" : "[[[Permissions...|permissions.html]]]",
      "name" : "name",
      "id" : "id",
      "href" : "href",
      "included" : "[[[roles...|roles.html]]]"
    } ],
    "count" : 7
  }
}

Last modified: 02 December 2025