How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Project Roles API

The Project Roles API from Atlassian — 5 operation(s) for project roles.

Atlassian Project Roles API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Project Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 9 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

9 operations 5 paths 10 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Project Roles API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Project Roles 9

This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.

GET
/rest/api/3/project/{projectIdOrKey}/role
Atlassian Get Project Roles For Project
atlassianGetprojectroles 1 param → 200401404
GET
/rest/api/3/project/{projectIdOrKey}/role/{id}
Atlassian Get Project Role For Project
atlassianGetprojectrole 3 params → 200400401404
GET
/rest/api/3/project/{projectIdOrKey}/roledetails
Atlassian Get Project Role Details
atlassianGetprojectroledetails 3 params → 200401404
GET
/rest/api/3/role
Atlassian Get All Project Roles
atlassianGetallprojectroles → 200401403
POST
/rest/api/3/role
Atlassian Create Project Role
atlassianCreateprojectrole body → 200400401403409
DELETE
/rest/api/3/role/{id}
Atlassian Delete Project Role
atlassianDeleteprojectrole 2 params → 204400401403404409
GET
/rest/api/3/role/{id}
Atlassian Get Project Role By Id
atlassianGetprojectrolebyid 1 param → 200401403404
POST
/rest/api/3/role/{id}
Atlassian Partial Update Project Role
atlassianPartialupdateprojectrole 1 param body → 200400401403404
PUT
/rest/api/3/role/{id}
Atlassian Fully Update Project Role
atlassianFullyupdateprojectrole 1 param body → 200400401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ProjectRole (11 properties), ProjectRoleDetails (9 properties), ProjectDetails (8 properties), RoleActor (7 properties). Each schema is shown below with its type and property counts.

RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
CreateUpdateRoleRequestBean
object
2 properties
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
ProjectRoleUser
object
Details of the user associated with the role.
1 property
ProjectRole
object
Details about the roles in a project.
11 properties
ProjectRoleDetails
object
Details about a project role.
9 properties
UpdatedProjectCategory
object
A project category.
4 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
ProjectDetails
object
Details about a project.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-project-roles-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Project Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.