{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Project Roles API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Project Roles", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Project Roles For Project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/role", "params": [ { "name": "projectIdOrKey", "value": "", "type": "path", "description": "The project ID or project key (case sensitive)." } ] }, "docs": "Returns a list of [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) for the project returning the name and self URL for each role.

Note that all project roles are shared with all projects in Jira Cloud. See [Get all project roles](#api-rest-api-3-role-get) for more information.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.at" }, { "info": { "name": "Atlassian Get Project Role For Project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/role/:id", "params": [ { "name": "projectIdOrKey", "value": "", "type": "path", "description": "The project ID or project key (case sensitive)." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." }, { "name": "excludeInactiveUsers", "value": "", "type": "query", "description": "Exclude inactive users." } ] }, "docs": "Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.

To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Administer Projects" }, { "info": { "name": "Atlassian Get Project Role Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/project/:projectIdOrKey/roledetails", "params": [ { "name": "projectIdOrKey", "value": "", "type": "path", "description": "The project ID or project key (case sensitive)." }, { "name": "currentMember", "value": "", "type": "query", "description": "Whether the roles should be filtered to include only those the user is assigned to." }, { "name": "excludeConnectAddons", "value": "", "type": "query" } ] }, "docs": "Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) and the details for each role. Note that the list of project roles is common to all projects.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project." }, { "info": { "name": "Atlassian Get Project Role By Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/role/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." } ] }, "docs": "Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Partial Update Project Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/role/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates either the project role's name or its description.

You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Fully Update Project Role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/role/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the project role's name and description. You must include both a name and a description in the request.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Delete Project Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/role/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." }, { "name": "swap", "value": "", "type": "query", "description": "The ID of the project role that will replace the one being deleted." } ] }, "docs": "Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Get All Project Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/role" }, "docs": "Gets a list of all project roles, complete with project role details and default actors.

### About project roles ###

[Project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) 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 throu" }, { "info": { "name": "Atlassian Create Project Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/role", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to project role](#api-rest-api-3-role-id-actors-post) operation to add default actors to the project role after creating it.

*Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.*" } ] } ], "bundled": true }