Atlassian · Schema

ProjectRole

Details about the roles in a project.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
actors	array	The list of users who act in this role.
admin	boolean	Whether this role is the admin role for the project.
currentUserRole	boolean	Whether the calling user is part of this role.
default	boolean	Whether this role is the default role for the project
description	string	The description of the project role.
id	integer	The ID of the project role.
name	string	The name of the project role.
roleConfigurable	boolean	Whether the roles are configurable for this project.
scope	object	The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
self	string	The URL the project role details.
translatedName	string	The translated name of the project role.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProjectRole",
  "title": "ProjectRole",
  "additionalProperties": false,
  "description": "Details about the roles in a project.",
  "properties": {
    "actors": {
      "description": "The list of users who act in this role.",
      "items": {
        "$ref": "#/components/schemas/RoleActor"
      },
      "readOnly": true,
      "type": "array"
    },
    "admin": {
      "description": "Whether this role is the admin role for the project.",
      "readOnly": true,
      "type": "boolean"
    },
    "currentUserRole": {
      "description": "Whether the calling user is part of this role.",
      "type": "boolean"
    },
    "default": {
      "description": "Whether this role is the default role for the project",
      "readOnly": true,
      "type": "boolean"
    },
    "description": {
      "description": "The description of the project role.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the project role.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "name": {
      "description": "The name of the project role.",
      "type": "string"
    },
    "roleConfigurable": {
      "description": "Whether the roles are configurable for this project.",
      "readOnly": true,
      "type": "boolean"
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
      "readOnly": true
    },
    "self": {
      "description": "The URL the project role details.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "translatedName": {
      "description": "The translated name of the project role.",
      "type": "string"
    }
  },
  "type": "object"
}