Contratos de coleta — Jira
01Como ler esta página #sec_fa4b2044
Cada recurso que o REVIEWIT pode coletar para o Jira tem um contrato publicado. Ele é lido como uma referência de API: o que o REVIEWIT chama no serviço coletado e por qual meio, o que o contrato exige para que a coleta seja executada e os dados que o REVIEWIT mantém. O REVIEWIT apenas realiza leituras.
- Chamadas: as requisições que o REVIEWIT faz ao serviço coletado, todas em leitura.
- Exigências: cada uma deve ser satisfeita. Sua natureza indica o que ela solicita: um direito a conceder ao identificador, uma condição de administração (uma configuração ou atribuição no fornecedor que o token não possui, verificada por uma chamada real em leitura) ou a pertença do identificador ao site Atlassian da conexão. A regra indica quantas opções são necessárias: « obrigatória » para a única opção, « uma à escolha » quando uma única basta (elas são ordenadas da mais estreita à mais ampla: prefira a primeira), « todas » ou « N à escolha entre M ».
- Condições de funcionamento: o que o REVIEWIT verifica antes de cada coleta, além das exigências.
- Frescura: a idade máxima das verificações nas quais o veredicto se baseia, definida por cada contrato (aqui: verificações de menos de 24 h; os direitos devem ser verificados por uma chamada real). O REVIEWIT refaz automaticamente dentro desse prazo as verificações que ele consegue fazer (token obtido, serviço que responde); « Verificar os direitos », no menu da conexão, os refaz a pedido. Enquanto a chamada real não for feita, os direitos permanecem não verificados.
- Um direito cujo nome sugere gravação ( manage:jira-configuration, manage:jira-project, manage:servicedesk-customer ) aparece quando o fornecedor também inclui a leitura desses dados; o REVIEWIT chama apenas as leituras listadas.
- Dados mantidos: os campos que o REVIEWIT mantém de cada objeto; o papel indica o que a revisão faz com eles.
O veredicto de cada recurso, para sua conexão, é lido em sua ficha. Um recurso que a conexão não coleta pode sempre ser alimentado pela importação de um relatório (« Importar um relatório »).
02Como o REVIEWIT verifica as exigências #sec_48ff108d
O token Jira não carrega seus direitos: o contrato exige que eles sejam verificados por uma chamada real, em leitura. O REVIEWIT ainda não faz essa chamada para o Jira: ele verifica que o token foi obtido e que o serviço responde, mas não os direitos listados aqui. Os recursos são exibidos como « Não verificado »; eles podem sempre ser alimentados pela importação de um relatório (« Importar um relatório »).
03As vias de chamada #sec_f71bc7d9
Uma via indica qual token o REVIEWIT obtém para o identificador: quem o emite e para qual audiência. Os endereços chamados aparecem nas chamadas de cada recurso; um caminho que começa com « / » é chamado na audiência do token de sua via.
| Via | Token emitido por | Audiência do token | Autenticação do identificador |
|---|---|---|---|
| jira.cloud.reviewit.scoped-token | https://auth.atlassian.com | https://api.atlassian.com | token ou segredo de API |
04Assets · Esquemas de objeto #sec_7fede0d1
jira.assets.object-schemas:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Esquemas Assets e os papéis que os administram
Chamadas
- GET https://api.atlassian.com/jsm/assets/workspace/{id}/v1/objectschema/list
Exigências
| Natureza | Regra | Opções |
|---|---|---|
| Direito | obrigatória | read:cmdb-schema:jira |
| Pertença | obrigatória | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser verificados por uma chamada real.
Dados mantidos
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| SchemaId | chave do objeto | inteiro | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| ObjectSchemaKey | contexto, sem efeito sobre a revisão | texto | não |
| Status | contexto, sem efeito sobre a revisão | texto | não |
| ObjectCount | contexto, sem efeito sobre a revisão | inteiro | não |
| RoleActors | contexto, sem efeito sobre a revisão | texto | não |
05Automação · Regras de automação #sec_97f6845c
jira.automation.rules:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Regras de automação, seu ator de execução e sua escopo
Chamadas
- GET https://api.atlassian.com/automation/public/jira/{cloudId}/rest/v1/rule/summary
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | manage:jira-configuration |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| RuleId | chave do objeto | inteiro | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| State | contexto, sem efeito sobre a revisão | texto | não |
| Scope | contexto, sem efeito sobre a revisão | texto | não |
| ActorAccountId | contexto, sem efeito sobre a revisão | texto | não |
| ActorDisplayName | acesso sujeito à revisão | lista de identidades | não |
| UpdatedOn | contexto, sem efeito sobre a revisão | data e hora | não |
06Diretório · Utilizadores #sec_d155e56b
jira.directory.users:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Contas Atlassian do site, seu estatuto e seu acesso aos produtos
Chamadas
- 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
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-user |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| AccountId | chave do objeto | texto | sim |
| DisplayName | exibido para reconhecer o objeto | texto | sim |
| exibido para reconhecer o objeto | texto | não | |
| AccountType | contexto, sem efeito sobre a revisão | texto | não |
| Active | contexto, sem efeito sobre a revisão | booleano | não |
| ProductAccess | contexto, sem efeito sobre a revisão | texto | não |
| LastActive | contexto, sem efeito sobre a revisão | data e hora | não |
07Grupos #sec_0d3add62
jira.groups.groups:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Grupos do site e seu uso nos esquemas de permissão
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/group/bulk
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-user |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| GroupId | chave do objeto | texto | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| MemberCount | contexto, sem efeito sobre a revisão | inteiro | não |
08Grupos · Membros do grupo #sec_06602fe7
jira.groups.memberships:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Afiliações de grupo. Chave de linha: GroupId | AccountId.
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/group/member
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-user |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| MembershipKey | chave do objeto | texto | sim |
| GroupId | contexto, sem efeito sobre a revisão | texto | sim |
| GroupName | contexto, sem efeito sobre a revisão | texto | não |
| AccountId | contexto, sem efeito sobre a revisão | texto | sim |
| DisplayName | exibido para reconhecer o objeto | texto | sim |
| exibido para reconhecer o objeto | texto | não | |
| AccountType | contexto, sem efeito sobre a revisão | texto | não |
09Papéis privilegiados · Administradores #sec_bf67dc6b
jira.privileged-roles.admins:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Administradores de organização, site e produto
Chamadas
- 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
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-user |
| Direito | requerido | manage:jira-configuration |
| Membresia | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| AccountId | chave do objeto | texto | sim |
| DisplayName | exibido para reconhecer o objeto | texto | sim |
| exibido para reconhecer o objeto | texto | não | |
| AdminScope | contexto, sem efeito sobre a revisão | texto | não |
| Products | contexto, sem efeito sobre a revisão | texto | não |
| Active | contexto, sem efeito sobre a revisão | booleano | não |
10Projetos · Níveis de segurança de problemas #sec_cc7a4005
jira.projects.issue-security:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Níveis de segurança de tickets e seus membros
Chamadas
- 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
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | manage:jira-configuration |
| Direito | requerido | read:jira-work |
| Membresia | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| SchemeId | chave do objeto | inteiro | sim |
| SchemeName | exibido para reconhecer o objeto | texto | sim |
| LevelId | contexto, sem efeito sobre a revisão | texto | não |
| LevelName | contexto, sem efeito sobre a revisão | texto | não |
| ProjectKeys | contexto, sem efeito sobre a revisão | texto | não |
| HolderType | contexto, sem efeito sobre a revisão | texto | não |
| HolderValue | contexto, sem efeito sobre a revisão | texto | não |
11Projetos · Esquemas de permissão #sec_686bfaef
jira.projects.permission-schemes:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Esquemas de permissão e os usuários, grupos e papéis que eles habilitam
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/permissionscheme?expand=all
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | manage:jira-configuration |
| Membresia | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| SchemeId | chave do objeto | inteiro | sim |
| SchemeName | exibido para reconhecer o objeto | texto | sim |
| ProjectKeys | contexto, sem efeito sobre a revisão | texto | não |
| Permission | contexto, sem efeito sobre a revisão | texto | não |
| HolderType | contexto, sem efeito sobre a revisão | texto | não |
| HolderValue | contexto, sem efeito sobre a revisão | texto | não |
12Projetos #sec_35765212
jira.projects.projects:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Projetos, seu responsável, tipo e visibilidade
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/project/search
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-work |
| Membresia | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| ProjectId | chave do objeto | inteiro | sim |
| Key | exibido para reconhecer o objeto | texto | sim |
| Name | exibido para reconhecer o objeto | texto | não |
| ProjectTypeKey | contexto, sem efeito sobre a revisão | texto | não |
| Lead | acesso sujeito à revisão | lista de identidades | não |
| IsPrivate | avaliado pelas políticas REVIEWIT (visibilidade) | booleano | não |
| Archived | contexto, sem efeito sobre a revisão | booleano | não |
| Category | contexto, sem efeito sobre a revisão | texto | não |
| Simplified | contexto, sem efeito sobre a revisão | booleano | não |
13Projetos · Atores do papel do projeto #sec_ab89471e
jira.projects.role-actors:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Utilizadores e grupos colocados num papel de projeto. Chave de linha: ProjectKey | RoleId | ActorId.
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/project/{projectId}/role/{roleId}
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-work |
| Direito | uma ao escolha | manage:jira-project ou manage:jira-configuration |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| RoleActorKey | chave do objeto | texto | sim |
| ProjectKey | exibido para reconhecer o objeto | texto | sim |
| ProjectName | contexto, sem efeito sobre a revisão | texto | não |
| RoleId | contexto, sem efeito sobre a revisão | inteiro | sim |
| RoleName | exibido para reconhecer o objeto | texto | não |
| ActorId | contexto, sem efeito sobre a revisão | texto | sim |
| ActorType | contexto, sem efeito sobre a revisão | texto | não |
| ActorName | contexto, sem efeito sobre a revisão | texto | não |
14Gestão de serviços · Clientes #sec_81de5f9e
jira.jsm.customers:collect · revisão 3 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Clientes e participantes externos admitidos num portal
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | uma ao escolha | read:servicedesk-request ou manage:servicedesk-customer |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| AccountId | chave do objeto | texto | sim |
| DisplayName | exibido para reconhecer o objeto | texto | sim |
| exibido para reconhecer o objeto | texto | não | |
| ServiceDeskIds | contexto, sem efeito sobre a revisão | texto | não |
| OrganizationIds | contexto, sem efeito sobre a revisão | texto | não |
| Active | contexto, sem efeito sobre a revisão | booleano | não |
15Gestão de serviços · Organizações de clientes #sec_a22c8bb3
jira.jsm.organizations:collect · revisão 3 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Organizações clientes ligadas a um projeto de serviço
Chamadas
- 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
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | uma ao escolha | read:servicedesk-request ou manage:servicedesk-customer |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| OrganizationId | chave do objeto | inteiro | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| ServiceDeskIds | contexto, sem efeito sobre a revisão | texto | não |
| CustomerCount | contexto, sem efeito sobre a revisão | inteiro | não |
| CreatedOn | contexto, sem efeito sobre a revisão | data e hora | não |
16Gestão de serviços · Projetos de serviço #sec_7eade67d
jira.jsm.service-projects:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Projetos de serviço, seus agentes e seu portal
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/servicedeskapi/servicedesk
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:servicedesk-request |
| Afiliação | requerido | o identificador pertence ao site Atlassian da conexão |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura: verificações de menos de 24 h; os direitos devem ser constatados por uma chamada real.
Dados conservados
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| ServiceDeskId | chave do objeto | inteiro | sim |
| ProjectKey | exibido para reconhecer o objeto | texto | sim |
| ProjectName | contexto, sem efeito sobre a revisão | texto | não |
| AgentCount | contexto, sem efeito sobre a revisão | inteiro | não |
| PortalUrl | exibido para reconhecer o objeto | texto | não |
| CustomerPermission | contexto, sem efeito sobre a revisão | texto | não |
17Objetos partilhados · Painéis #sec_22d9391c
jira.shared-objects.dashboards:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Painéis partilhados, o seu proprietário e o seu público
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/dashboard/search?expand=owner,favouritedCount,sharePermissions,editPermissions
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-work |
| Afiliação | requerido | o identificador pertence ao site Atlassian da ligação |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.
Dados mantidos
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| DashboardId | chave do objeto | inteiro | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| Owner | acesso submetido à revisão | lista de identidades | não |
| SharePermissions | contexto, sem efeito sobre a revisão | texto | não |
| EditPermissions | contexto, sem efeito sobre a revisão | texto | não |
| Popularity | contexto, sem efeito sobre a revisão | inteiro | não |
18Objetos partilhados · Filtros JQL #sec_e790a36e
jira.shared-objects.filters:collect · revisão 2 do contrato, publicada em 18 de outubro de 2026 · via jira.cloud.reviewit.scoped-token
Filtros JQL partilhados, o seu proprietário e o seu público
Chamadas
- GET https://api.atlassian.com/ex/jira/{cloudId}/rest/api/3/filter/search?expand=owner,jql,favourite,favouritedCount,sharePermissions,editPermissions
Requisitos
| Natureza | Regra | Opções |
|---|---|---|
| Direito | requerido | read:jira-work |
| Afiliação | requerido | o identificador pertence ao site Atlassian da ligação |
Condições de funcionamento
- um token é obtido para o identificador
- o serviço https://api.atlassian.com responde
Frescura : verificações de menos de 24 h ; os direitos devem ser constatados por uma chamada real.
Dados mantidos
| Campo | Papel | Tipo | Obrigatório |
|---|---|---|---|
| FilterId | chave do objeto | inteiro | sim |
| Name | exibido para reconhecer o objeto | texto | sim |
| Owner | acesso submetido à revisão | lista de identidades | não |
| Jql | contexto, sem efeito sobre a revisão | texto | não |
| SharePermissions | contexto, sem efeito sobre a revisão | texto | não |
| EditPermissions | contexto, sem efeito sobre a revisão | texto | não |
| Favourite | contexto, sem efeito sobre a revisão | booleano | não |
19Para ir mais longe #sec_4df27861
- Compreender uma ligação de recolha
- Referência dos direitos por recurso
- Ler um veredicto