Atlassian: Project roles schemas
6 Atlassian schemas with complete fields and constraints.
← Project roles operations · All schemas
Create project role — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
description | string | Optional | A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role. |
name | string | Optional | The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role. |
Create project role — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the roles in a project. |
actors | JSON | Optional | |
actors (anyOf 1) | array | Alternative | The list of users who act in this role. Read only: true |
actors (anyOf 1)[] | Model | Each item | Expand Create project role — response body — actors The list of users who act in this role item |
actors (anyOf 2) | null | Alternative | |
admin | JSON | Optional | |
admin (anyOf 1) | boolean | Alternative | Whether this role is the admin role for the project. Read only: true |
admin (anyOf 2) | null | Alternative | |
currentUserRole | JSON | Optional | |
currentUserRole (anyOf 1) | boolean | Alternative | Whether the calling user is part of this role. |
currentUserRole (anyOf 2) | null | Alternative | |
default | JSON | Optional | |
default (anyOf 1) | boolean | Alternative | Whether this role is the default role for the project Read only: true |
default (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the project role. Read only: true |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project role. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the project role. |
name (anyOf 2) | null | Alternative | |
roleConfigurable | JSON | Optional | |
roleConfigurable (anyOf 1) | boolean | Alternative | Whether the roles are configurable for this project. Read only: true |
roleConfigurable (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Get status — response body — scope project, type The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Read only: true |
scope (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL the project role details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
translatedName | JSON | Optional | |
translatedName (anyOf 1) | string | Alternative | The translated name of the project role. |
translatedName (anyOf 2) | null | Alternative |
Referenced models: Create project role — response body — actors The list of users who act in this role item, Get status — response body — scope project, type
Create project role — response body — actors The list of users who act in this role item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a user assigned to a project role. |
actorGroup | JSON | Optional | |
actorGroup (anyOf 1) | Model | Alternative | Expand Create project role — response body — actors The list of users who act in this role item actor Group Details of the group associated with the role Read only: true |
actorGroup (anyOf 2) | null | Alternative | |
actorUser | JSON | Optional | |
actorUser (anyOf 1) | Model | Alternative | Expand Create project role — response body — actors The list of users who act in this role item actor User Details of the user associated with the role Read only: true |
actorUser (anyOf 2) | null | Alternative | |
avatarUrl | JSON | Optional | |
avatarUrl (anyOf 1) | string | Alternative | The avatar of the role actor. Format: uri Read only: true |
avatarUrl (anyOf 2) | null | Alternative | |
displayName | JSON | Optional | |
displayName (anyOf 1) | string | Alternative | The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name. Read only: true |
displayName (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the role actor. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true |
name (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of role actor. Known values: atlassian-group-role-actor, atlassian-user-role-actor Read only: true |
type (anyOf 2) | null | Alternative |
Referenced models: Create project role — response body — actors The list of users who act in this role item actor Group Details of the group associated with the role, Create project role — response body — actors The list of users who act in this role item actor User Details of the user associated with the role
Create project role — response body — actors The list of users who act in this role item actor Group Details of the group associated with the role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the group associated with the role. |
displayName | JSON | Optional | |
displayName (anyOf 1) | string | Alternative | The display name of the group. |
displayName (anyOf 2) | null | Alternative | |
groupId | JSON | Optional | |
groupId (anyOf 1) | string | Alternative | The ID of the group. |
groupId (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the group. As a group's name can change, use of `groupId` is recommended to identify the group. |
name (anyOf 2) | null | Alternative |
Create project role — response body — actors The list of users who act in this role item actor User Details of the user associated with the role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the user associated with the role. |
accountId | JSON | Optional | |
accountId (anyOf 1) | string | Alternative | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import. Maximum length: 128 Read only: true |
accountId (anyOf 2) | null | Alternative |
Get project role details — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a project role. |
admin | JSON | Optional | |
admin (anyOf 1) | boolean | Alternative | Whether this role is the admin role for the project. Read only: true |
admin (anyOf 2) | null | Alternative | |
default | JSON | Optional | |
default (anyOf 1) | boolean | Alternative | Whether this role is the default role for the project. Read only: true |
default (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the project role. Read only: true |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the project role. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the project role. |
name (anyOf 2) | null | Alternative | |
roleConfigurable | JSON | Optional | |
roleConfigurable (anyOf 1) | boolean | Alternative | Whether the roles are configurable for this project. Read only: true |
roleConfigurable (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Get status — response body — scope project, type The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Read only: true |
scope (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL the project role details. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
translatedName | JSON | Optional | |
translatedName (anyOf 1) | string | Alternative | The translated name of the project role. |
translatedName (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of the project role. This is "DEFAULT" or "GUEST\_ROLE". Known values: DEFAULT, GUEST_ROLE, AI_AGENT_ROLE Read only: true |
type (anyOf 2) | null | Alternative |
Referenced models: Get status — response body — scope project, type