action atlassian_get_all_project_roles { label: "Get all project roles" description: "Gets a list of all project roles, complete with project role details and default actors.\n\n### About project roles ###\n\n[Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).\n\nProject roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification schemes](#api-rest-api-3-notificationscheme-get), [issue security levels](#api-rest-api-3-issuesecurityschemes-get), [comment visibility](#api-rest-api-3-comment-list-post), and workflow conditions.\n\n#### Members and actors ####\n\nIn the Jira REST API, a member of a project role is called an *actor*. An *actor* is a group or user associated with a project role.\n\nActors may be set as [default members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) of the project role or set at the project level:\n\n * Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.\n * Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." provider: atlassian method: GET path: "/rest/api/3/role" encoding: json output: { type: "array" items: { type: "object" description: "Details about the roles in a project." properties: { actors: { type: "array" description: "The list of users who act in this role." items: { type: "object" description: "Details about a user assigned to a project role." properties: { actorGroup: { type: "object" } actorUser: { type: "object" } avatarUrl: { type: "string" format: "uri" description: "The avatar of the role actor." } displayName: { type: "string" description: "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." } id: { type: "integer" format: "int64" description: "The ID of the role actor." } name: { type: "string" description: "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." } type: { type: "string" description: "The type of role actor." enum: ["atlassian-group-role-actor", "atlassian-user-role-actor"] } } additionalProperties: false } } admin: { type: "boolean" description: "Whether this role is the admin role for the project." } currentUserRole: { type: "boolean" description: "Whether the calling user is part of this role." } default: { type: "boolean" description: "Whether this role is the default role for the project" } description: { type: "string" description: "The description of the project role." } id: { type: "integer" format: "int64" description: "The ID of the project role." } name: { type: "string" description: "The name of the project role." } roleConfigurable: { type: "boolean" description: "Whether the roles are configurable for this project." } scope: { description: "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO)." type: "object" } self: { type: "string" format: "uri" description: "The URL the project role details." } translatedName: { type: "string" description: "The translated name of the project role." } } additionalProperties: false } } }