Collection Contracts — Jira
01How to read this page #sec_fa4b2044
Each resource that REVIEWIT can collect for Jira has a published contract. It is read like an API reference: what REVIEWIT calls on the collected service and by what means, what the contract requires for the collection to execute, and the data that REVIEWIT retains. REVIEWIT only performs reads.
- Calls: the requests that REVIEWIT sends to the collected service, all in read mode.
- Requirements: each must be satisfied. Its nature indicates what it demands: a right to grant to the identifier, an administration condition (a setting or assignment at the provider that the token does not carry, observed by a real read call), or the identifier's membership in the Atlassian site of the connection. The rule states how many options are needed: « required » for the single option, « one of choice » when one is sufficient (they are ranked from narrowest to broadest: prefer the first), « all », or « N of choice from M ».
- Operating conditions: what REVIEWIT checks before each collection, beyond the requirements.
- Freshness: the maximum age of the verifications on which the verdict is based, set by each contract (here: verifications less than 24 h old; rights must be verified by a real call). REVIEWIT automatically redoes verifications it can perform within this period (token obtained, service responding); « Verify rights », in the connection menu, redo them on demand. Until the real call is made, rights remain unverified.
- A right whose name suggests writing ( manage:jira-configuration , manage:jira-project , manage:servicedesk-customer ) appears when the provider also groups the reading of this data there; REVIEWIT only calls the listed reads.
- Retained data: the fields that REVIEWIT keeps from each object; the role indicates what the review does with it.
The verdict of each resource, for your connection, is read on its card. A resource that the connection does not collect can still be fed by importing a report (« Import a report »).
02How REVIEWIT verifies requirements #sec_48ff108d
The Jira token does not carry its rights: the contract requires that they be verified by a real read call. REVIEWIT does not yet make this call for Jira: it verifies that the token is obtained and that the service responds, but not the rights listed here. Resources are displayed as « Not verified »; they can still be fed by importing a report (« Import a report »).
03Call paths #sec_f71bc7d9
A path indicates which REVIEWIT token is obtained for the identifier: who issues it and for which audience. The called addresses appear in the calls of each resource; a path that starts with « / » is called on the audience of its path's token.
| Path | Token issued by | Token audience | Identifier authentication |
|---|---|---|---|
| jira.cloud.reviewit.scoped-token | https://auth.atlassian.com | https://api.atlassian.com | token or API secret |
04Assets · Object schemas #sec_7fede0d1
jira.assets.object-schemas:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Asset schemas and the roles that manage them
Calls
- GET https://api.atlassian.com/jsm/assets/workspace/{id}/v1/objectschema/list
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:cmdb-schema:jira |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| SchemaId | key of the object | integer | yes |
| Name | displayed to recognize the object | text | yes |
| ObjectSchemaKey | context, no effect on the review | text | no |
| Status | context, no effect on the review | text | no |
| ObjectCount | context, no effect on the review | integer | no |
| RoleActors | context, no effect on the review | text | no |
05Automation · Automation rules #sec_97f6845c
jira.automation.rules:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Automation rules, their execution actor, and their scope
Calls
- GET https://api.atlassian.com/automation/public/jira/{cloudId}/rest/v1/rule/summary
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | manage:jira-configuration |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| RuleId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| State | context, no effect on review | text | no |
| Scope | context, no effect on review | text | no |
| ActorAccountId | context, no effect on review | text | no |
| ActorDisplayName | access subject to review | list of identities | no |
| UpdatedOn | context, no effect on review | date and time | no |
06Directory · Users #sec_d155e56b
jira.directory.users:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Atlassian site accounts, their status, and their access to products
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/users/search
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/user?accountId={accountId}&expand=applicationRoles
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-user |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| AccountId | object key | text | yes |
| DisplayName | displayed to recognize the object | text | yes |
| displayed to recognize the object | text | no | |
| AccountType | context, no effect on review | text | no |
| Active | context, no effect on review | boolean | no |
| ProductAccess | context, no effect on review | text | no |
| LastActive | context, no effect on review | date and time | no |
07Groups #sec_0d3add62
jira.groups.groups:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Site groups and their use in permission schemes
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/group/bulk
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-user |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| GroupId | object key | text | yes |
| Name | displayed to recognize the object | text | yes |
| MemberCount | context, no effect on review | integer | no |
08Groups · Group members #sec_06602fe7
jira.groups.memberships:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Group memberships. Line key: GroupId | AccountId.
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/group/member
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-user |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| MembershipKey | object key | text | yes |
| GroupId | context, no effect on review | text | yes |
| GroupName | context, no effect on review | text | no |
| AccountId | context, no effect on review | text | yes |
| DisplayName | displayed to recognize the object | text | yes |
| displayed to recognize the object | text | no | |
| AccountType | context, no effect on review | text | no |
09Privileged roles · Administrators #sec_bf67dc6b
jira.privileged-roles.admins:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Organization, site, and product administrators
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/user/permission/search?permissions=ADMINISTER
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/permissionscheme
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/group/member
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-user |
| Right | required | manage:jira-configuration |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| AccountId | key of the object | text | yes |
| DisplayName | displayed to recognize the object | text | yes |
| displayed to recognize the object | text | no | |
| AdminScope | context, no effect on review | text | no |
| Products | context, no effect on review | text | no |
| Active | context, no effect on review | boolean | no |
10Projects · Issue security levels #sec_cc7a4005
jira.projects.issue-security:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Issue security levels and their members
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/issuesecurityschemes
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/issuesecurityschemes/{id}/members
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | manage:jira-configuration |
| Right | required | read:jira-work |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| SchemeId | key of the object | integer | yes |
| SchemeName | displayed to recognize the object | text | yes |
| LevelId | context, no effect on review | text | no |
| LevelName | context, no effect on review | text | no |
| ProjectKeys | context, no effect on review | text | no |
| HolderType | context, no effect on review | text | no |
| HolderValue | context, no effect on review | text | no |
11Projects · Permission schemes #sec_686bfaef
jira.projects.permission-schemes:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Permission schemes and the users, groups, and roles they enable
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/permissionscheme?expand=all
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | manage:jira-configuration |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| SchemeId | key of the object | integer | yes |
| SchemeName | displayed to recognize the object | text | yes |
| ProjectKeys | context, no effect on review | text | no |
| Permission | context, no effect on review | text | no |
| HolderType | context, no effect on review | text | no |
| HolderValue | context, no effect on review | text | no |
12Projects #sec_35765212
jira.projects.projects:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Projects, their leader, their type, and their visibility
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/project/search
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-work |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| ProjectId | key of the object | integer | yes |
| Key | displayed to recognize the object | text | yes |
| Name | displayed to recognize the object | text | no |
| ProjectTypeKey | context, no effect on review | text | no |
| Lead | access subject to review | list of identities | no |
| IsPrivate | evaluated by REVIEWIT policies (visibility) | boolean | no |
| Archived | context, no effect on review | boolean | no |
| Category | context, no effect on review | text | no |
| Simplified | context, no effect on review | boolean | no |
13Projects · Project role actors #sec_ab89471e
jira.projects.role-actors:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Users and groups placed in a project role. Line key: ProjectKey | RoleId | ActorId.
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/project/{projectId}/role/{roleId}
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-work |
| Right | one of | manage:jira-project or manage:jira-configuration |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| RoleActorKey | object key | text | yes |
| ProjectKey | displayed to recognize the object | text | yes |
| ProjectName | context, no effect on the review | text | no |
| RoleId | context, no effect on the review | integer | yes |
| RoleName | displayed to recognize the object | text | no |
| ActorId | context, no effect on the review | text | yes |
| ActorType | context, no effect on the review | text | no |
| ActorName | context, no effect on the review | text | no |
14Service management · Customers #sec_81de5f9e
jira.jsm.customers:collect · contract revision 3, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Clients and external participants admitted to a portal
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | one of | read:servicedesk-request ou manage:servicedesk-customer |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| AccountId | object key | text | yes |
| DisplayName | displayed to recognize the object | text | yes |
| displayed to recognize the object | text | no | |
| ServiceDeskIds | context, no effect on the review | text | no |
| OrganizationIds | context, no effect on the review | text | no |
| Active | context, no effect on the review | boolean | no |
15Service management · Customer organisations #sec_a22c8bb3
jira.jsm.organizations:collect · contract revision 3, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Customer organisations attached to a service project
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/organization
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/organization/{organizationId}/user
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | one of | read:servicedesk-request ou manage:servicedesk-customer |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| OrganizationId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| ServiceDeskIds | context, no effect on the review | text | no |
| CustomerCount | context, no effect on the review | integer | no |
| CreatedOn | context, no effect on the review | date and time | no |
16Service management · Service projects #sec_7eade67d
jira.jsm.service-projects:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Service projects, their agents and their portal
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/servicedesk
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:servicedesk-request |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| ServiceDeskId | object key | integer | yes |
| ProjectKey | displayed to recognize the object | text | yes |
| ProjectName | context, no effect on the review | text | no |
| AgentCount | context, no effect on the review | integer | no |
| PortalUrl | displayed to recognize the object | text | no |
| CustomerPermission | context, no effect on the review | text | no |
17Shared objects · Dashboards #sec_22d9391c
jira.shared-objects.dashboards:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Shared dashboards, their owner, and their audience
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/dashboard/search?expand=owner,favouritedCount,sharePermissions,editPermissions
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-work |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| DashboardId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| Owner | access subject to review | list of identities | no |
| SharePermissions | context, no effect on review | text | no |
| EditPermissions | context, no effect on review | text | no |
| Popularity | context, no effect on review | integer | no |
18Shared objects · JQL filters #sec_e790a36e
jira.shared-objects.filters:collect · contract revision 2, published on October 18, 2026 · path jira.cloud.reviewit.scoped-token
Shared JQL filters, their owner, and their audience
Calls
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/filter/search?expand=owner,jql,favourite,favouritedCount,sharePermissions,editPermissions
Requirements
| Nature | Rule | Options |
|---|---|---|
| Right | required | read:jira-work |
| Membership | required | the identifier belongs to the Atlassian site of the connection |
Operating conditions
- a token is obtained for the identifier
- the service https://api.atlassian.com responds
Freshness: checks less than 24 h old; rights must be verified by a real call.
Data retained
| Field | Role | Type | Required |
|---|---|---|---|
| FilterId | object key | integer | yes |
| Name | displayed to recognize the object | text | yes |
| Owner | access subject to review | list of identities | no |
| Jql | context, no effect on review | text | no |
| SharePermissions | context, no effect on review | text | no |
| EditPermissions | context, no effect on review | text | no |
| Favourite | context, no effect on review | boolean | no |
19To go further #sec_4df27861
- Understand a collection connection
- Rights reference by resource
- Read a verdict