# Papéis

Um papel é um conjunto de permissões que podem ser atribuídas a grupos. Essas permissões podem mudar de acordo com o ambiente no qual o usuário está: **test** ou **production**.

## A página de Papéis <a href="#id-9d3g2kn3fxhi" id="id-9d3g2kn3fxhi"></a>

A página de **Papéis** exibe uma tabela com papéis ativos em seu *realm*.

Esta tabela mostra o **nome** e **descrição** do papel, assim como botões para visualizá-los, editá-los ou removê-los.

<figure><img src="https://content.gitbook.com/content/cO0A6g1dOsu8BiHYqO67/blobs/bLYq4fdMHTcAMTg2HQor/Captura%20de%20Tela%202023-11-07%20%C3%A0s%2011.05.29.png" alt=""><figcaption><p>Página de Papéis</p></figcaption></figure>

## Ações <a href="#ppjl1sjz4utb" id="ppjl1sjz4utb"></a>

### Como criar um papel <a href="#wnbbosntxrbv" id="wnbbosntxrbv"></a>

Para criar um papel:

1. Clique no botão **Criar**, no canto superior direito.
2. Preencha o nome e a descrição do papel.
3. Clique nos pontos nas colunas **Criar**, **Ler**, **Atualizar**, **Remover** e **Específico** para ativar ou desativar uma permissão para o serviço descrito em cada linha. As permissões ativadas são representadas por caixas de seleção verdes.
4. Clique em **Salvar**.

### Como visualizar ou editar um papel <a href="#id-77hw1b3qlr82" id="id-77hw1b3qlr82"></a>

Para visualizar um papel:

1. Pesquise na tabela o papel que deseja editar ou use a barra de pesquisa.
2. Clique no ícone de lápis ou olho na coluna **Ações**.

Para editar um papel:

1. Faça as alterações desejadas no papel.
2. Clique em **Salvar**.

{% hint style="info" %}
Papéis de sistema não podem ser editados, mas podem ser visualizados no ícone de **olho**.
{% endhint %}

### Como duplicar um papel <a href="#xulzjx3de8" id="xulzjx3de8"></a>

Para duplicar um papel:

1. Pesquise na tabela o papel que deseja duplicar ou use a barra de pesquisa.
2. Clique no ícone de lápis ou olho na coluna **Ações**.
3. Clique em **Duplicar papel**.
4. Faça as alterações desejadas no novo papel.
5. Clique em **Salvar**.

### Como remover um papel <a href="#v6bw27hgycyn" id="v6bw27hgycyn"></a>

Ao remover um papel, as permissões concedidas por esse papel tornam-se inativas.&#x20;

Para remover um papel:

1. Pesquise na tabela o papel que deseja remover ou use a barra de pesquisa.
2. Clique no ícone de caixa na coluna **Ações**.
3. Escreva uma nota descrevendo o motivo pelo qual está removendo desse papel.
4. Clique em **Confirmar**.

{% hint style="info" %}
Papéis de sistema não podem ser removidos, apenas aqueles criados pelos usuários.
{% endhint %}

## Papéis de sistema <a href="#id-7auxts1l679f" id="id-7auxts1l679f"></a>

{% hint style="info" %}
Com os papéis **account-environment-manager**, **api-key-manager**, **deployment-manager**, **global-environment-manager** e **pipeline-manager**, você pode definir o ambiente (teste ou produção) como um parâmetro, garantindo que um grupo de usuários tenha permissões específicas para executar determinadas tarefas somente no ambiente selecionado. Se o ambiente não for definido, o usuário terá acesso a todos os ambientes.

Usuários com papéis de **account-viewer**, **api-key-viewer**, **deployment-viewer**, **global-viewer** e **pipeline-builder** só podem executar determinadas ações em ambientes (teste ou produção) que foram previamente definidos pelo usuário responsável por gerenciar o acesso aos ambientes.
{% endhint %}

Além de criar seus próprios papéis, você também pode usar os papéis de sistema predefinidos criados pela Digibee. Você não pode editar ou excluir os papéis do sistema, mas pode replicá-los e editar suas réplicas.

Abaixo, você pode ver todos os papéis de sistema atualmente existentes e suas respectivas permissões:

<details>

<summary><strong>account-environment-manager</strong></summary>

* ACCOUNT:CREATE: criar nova conta na página Contas.
* ACCOUNT:READ: visualizar contas existentes na página Contas.
* ACCOUNT:UPDATE: atualizar contas existentes na página Contas.
* ACCOUNT:DELETE: excluir contas existentes na página Contas.

</details>

<details>

<summary><strong>account-manager</strong></summary>

* ACCOUNT:CREATE: criar nova conta na página Contas.
* ACCOUNT:READ: visualizar contas existentes na página Contas.
* ACCOUNT:UPDATE: atualizar contas existentes na página Contas.
* ACCOUNT:DELETE: excluir contas existentes na página Contas.
* AUDIT:READ: visualizar registros de auditoria na página Auditoria.
* GLOBAL:CREATE: criar nova variável global na página *Globals*.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* GLOBAL:UPDATE: atualizar variáveis globais existentes na página *Globals*.
* GLOBAL:DELETE: excluir variáveis globais existentes na página *Globals*.
* OAUTH:CREATE: criar novo serviço *OAuth*.
* OAUTH:UPDATE: atualizar serviço *OAuth* existente.
* OAUTH:DELETE: excluir serviço *OAuth* existente.
* POLICY:UPDATE: atualizar políticas na página Políticas.
* POLICY:READ: visualizar políticas na página Políticas.
* RELATION:CREATE: criar um novo relacionamento na página Relacionamento.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* RELATION:UPDATE: atualizar relacionamentos existentes na página Relacionamento.
* RELATION:DELETE: excluir relacionamentos existentes na página Relacionamento.
* USER:READ: visualizar usuários existentes na página Usuários.

</details>

<details>

<summary><strong>account-viewer</strong></summary>

* ACCOUNT:READ: visualizar contas existentes na página Contas.
* AUDIT:READ: visualizar registros de auditoria na página Auditoria.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* USER:READ: visualizar usuários existentes na página Usuários.

</details>

<details>

<summary><strong>ai-assistant-viewer</strong></summary>

* AI-ASSISTANT:READ: acessar a funcionalidade Assistente de IA.

</details>

<details>

<summary><strong>alert-manager</strong></summary>

* ALERT:CREATE: criar novos alertas na página Alertas.
* ALERT:READ: visualizar alertas existentes na página Alertas. Inclui uma variável de ambiente.
* ALERT:UPDATE: atualizar alertas existentes na página Alertas.
* ALERT:DELETE: excluir alertas existentes na página Alertas.

</details>

<details>

<summary><strong>alert-viewer</strong></summary>

* ALERT:READ: visualizar alertas existentes na página Alertas. Inclui uma variável de ambiente.

</details>

<details>

<summary><strong>api-key-manager</strong></summary>

* APIKEY:CREATE: criar novas chaves de API na página *Consumers* (chaves de API).
* APIKEY:READ: visualizar chaves de API existentes na página *Consumers* (chaves de API).
* APIKEY:UPDATE: atualizar chaves de API existentes na página *Consumers* (chaves de API).
* APIKEY:DELETE: excluir chaves de API existentes na página *Consumers* (chaves de API).
* APIKEY:CREATE:ACL: associar *pipelines* a chaves de API existentes.
* APIKEY:CREATE:APIKEY: criar novas chaves para *consumers* existentes na página *Consumers* (chaves de API).
* APIKEY:DELETE:APIKEY: excluir chaves existentes para *consumers* existentes na página *Consumers* (chaves de API).
* AUDIT:READ: visualizar registros de auditoria na página Auditoria.
* USER:READ: visualizar usuários existentes na página Usuários.

</details>

<details>

<summary><strong>api-key-viewer</strong></summary>

* APIKEY:READ: visualizar chaves de API existentes na página *Consumers* (chaves de API).
* AUDIT:READ: visualizar registros de auditoria na página Auditoria.
* USER:READ: visualizar usuários existentes na página Usuários.

</details>

<details>

<summary><strong>audit-viewer</strong></summary>

* AUDIT:READ: visualizar registros de auditoria na página Auditoria.

</details>

<details>

<summary><strong>capsule-builder</strong></summary>

* ACCOUNT:READ: visualizar contas existentes na página Contas.
* CAPSULE:CREATE: criar novas Cápsulas na página Cápsulas.
* CAPSULE:READ: visualizar Cápsulas existentes na página Cápsulas.
* CAPSULE:UPDATE: atualizar Cápsulas existentes na página Cápsulas.
* CAPSULE:DELETE: excluir Cápsulas existentes na página Cápsulas.
* CAPSULE:CREATE:GROUP: criar novos grupos para organizar Cápsulas na página Cápsulas.
* CAPSULE:CREATE:HEADER: criar novos cabeçalhos para Cápsulas.
* CAPSULE:DELETE:HEADER: excluir cabeçalhos existentes para Cápsulas.
* CAPSULE:UPDATE:HEADER: atualizar cabeçalhos existentes para Cápsulas.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* TEST-MODE:EXECUTE:CAPSULE: executar Cápsulas no ambiente de teste.

</details>

<details>

<summary><strong>capsule-manager</strong></summary>

* CAPSULE:CREATE: criar novas Cápsulas na página Cápsulas.
* CAPSULE:READ: visualizar Cápsulas existentes na página Cápsulas.
* CAPSULE:UPDATE: atualizar Cápsulas existentes na página Cápsulas.
* CAPSULE:DELETE: excluir Cápsulas existentes na página Cápsulas.
* CAPSULE:CREATE:COLLECTION: criar novas coleções na página Cápsulas.
* CAPSULE:CREATE:GROUP: criar novos grupos para organizar Cápsulas na página Cápsulas.
* CAPSULE:DELETE:GROUP: excluir grupo existente na página Cápsulas.
* CAPSULE:UPDATE:GROUP: atualizar grupo existente na página Cápsulas.
* CAPSULE:CREATE:HEADER: criar novos cabeçalhos para Cápsulas.
* CAPSULE:DELETE:HEADER: excluir cabeçalhos existentes para Cápsulas.
* CAPSULE:UPDATE:HEADER: atualizar cabeçalhos existentes para Cápsulas.
* REPLICA:READ: visualizar os modelos multi-instância existentes.
* TEST-MODE:EXECUTE:CAPSULE: executar Cápsulas no ambiente de teste.

</details>

<details>

<summary><strong>capsule-publisher</strong></summary>

* CAPSULE:UPDATE:PUBLISH: publicar Cápsulas para serem usadas em *pipelines*.

</details>

<details>

<summary><strong>connectivity-manager</strong></summary>

* ZTNA:GENERATE-KEY: gerar uma chave de registro para *ZTNA Connections*.

</details>

<details>

<summary><strong>connectivity-viewer</strong></summary>

* ZTNA:READ: visualizar *ZTNA Connections* existentes.

</details>

<details>

<summary>data-streaming-manager</summary>

* DATA\_STREAMING:CREATE: Permite criar fluxos de dados sem restrições de ambiente.
* DATA\_STREAMING:UPDATE: Permite atualizar fluxos de dados sem restrições de ambiente.
* DATA\_STREAMING:READ: Permite ler fluxos de dados sem restrições de ambiente.
* DATA\_STREAMING:DELETE: Permite deletar fluxos de dados sem restrições de ambiente.

</details>

<details>

<summary><strong>deployment-manager</strong></summary>

* DEPLOYMENT:CREATE: implantar *pipelines* em todos os ambientes.
* DEPLOYMENT:READ: visualizar implantações em todos os ambientes.
* DEPLOYMENT:DELETE: excluir implantações em todos os ambientes.
* DEPLOYMENT:CREATE:REDEPLOY: reimplementar *pipelines* no ambiente selecionado.
* DEPLOYMENT:EXECUTE: reexecutar manualmente a execução selecionada em todos os ambientes.
* CONFIGURATION:CREATE: configurar o *pipeline*.
* CONFIGURATION:READ: visualizar a configuração do *pipeline*.
* CONFIGURATION:UPDATE: atualizar a configuração do *pipeline*.
* POLICY:UPDATE: atualizar políticas na página Políticas.
* POLICY:READ: visualizar políticas na página Políticas.
* USER:CREATE:GENERATE-JWT: gerar configuração de autenticação no Digibeectl.
* USER:DELETE:REVOKE-JWT: revogar configuração de autenticação no Digibeectl.
* USER:READ:OPEN-AUTH-CONFIG: descriptografar configuração de autenticação no Digibeectl.

</details>

<details>

<summary><strong>deployment-viewer</strong></summary>

* DEPLOYMENT:READ: visualizar implantações em todos os ambientes.
* CONFIGURATION:READ: visualizar a configuração do *pipeline*.

</details>

<details>

<summary><strong>global-manager</strong></summary>

* GLOBAL:CREATE: criar nova variável global na página *Globals*.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* GLOBAL:UPDATE: atualizar variáveis globais existentes na página *Globals*.
* GLOBAL:DELETE: excluir variáveis globais existentes na página *Globals*.

</details>

<details>

<summary><strong>global-viewer</strong></summary>

* GLOBAL:READ: view existing global variables on the Globals page.

</details>

<details>

<summary><strong>groups-manager</strong></summary>

* PERMISSION:READ: visualizar as permissões disponíveis na página de Papéis.
* SAML-GROUP-MAPPING:CREATE: criar novo mapeamento de grupo SAML.
* SAML-GROUP-MAPPING:READ: visualizar mapeamentos de grupo SAML existentes.
* SAML-GROUP-MAPPING:UPDATE: atualizar mapeamentos de grupo SAML existentes.
* SAML-GROUP-MAPPING:DELETE: excluir mapeamentos de grupo SAML existentes.
* USER:READ:INACTIVE-PERMISSION: visualizar as permissões de um usuário inativo na página Usuários.
* USER:READ:PERMISSION: visualizar as permissões de um usuário na página Usuários.
* USER:UPDATE:ASSIGN-GROUP: atribuir um ou mais grupos a um usuário na página Usuários.
* GROUP:CREATE: criar novos grupos na página Grupos.
* GROUP:READ: visualizar grupos existentes na página Grupos.
* GROUP:UPDATE: atualizar grupos existentes na página Grupos.
* GROUP:DELETE: excluir grupos existentes na página Grupos.
* GROUP:READ:PERMISSION: visualizar as permissões de grupos existentes na página Grupos.

</details>

<details>

<summary><strong>idp-access-manager</strong></summary>

* SSO-CONFIGURATION:CREATE: criar configurações SSO.
* SSO-CONFIGURATION:READ: visualizar configurações SSO existentes.
* SSO-CONFIGURATION:UPDATE: atualizar configurações SSO existentes.
* SSO-CONFIGURATION:DELETE: excluir configurações SSO existentes.

</details>

<details>

<summary><strong>logs-export</strong></summary>

* EXPORT:READ: exportar os *logs* do *pipeline* na página Monitor.

</details>

<details>

<summary><strong>logs-viewer</strong></summary>

* LOG:READ: visualizar a lista de *logs* na página *Monitor.* Inclui uma variável de ambiente.
* MESSAGE:READ: visualizar a lista de mensagens de execução em todos os ambientes. Inclui uma variável de ambiente.
* STATS:READ: visualizar informações de monitoramento sobre os *pipelines* através de API. Inclui uma variável de ambiente.

</details>

<details>

<summary><strong>metrics-viewer</strong></summary>

* METRICS:READ: visualizar as métricas dos *pipelines* implantados em todos os ambientes na página *Monitor*. Inclui uma variável de ambiente.

</details>

<details>

<summary><strong>multi-instance-manager</strong></summary>

* REPLICA:CREATE: criar novos modelos multi-instância.
* REPLICA:READ: visualizar os modelos multi-instância existentes.
* REPLICA:UPDATE: atualizar os modelos multi-instância existentes.
* REPLICA:DELETE: excluir os modelos multi-instância existentes.

</details>

<details>

<summary><strong>multi-instance-viewer</strong></summary>

* REPLICA:READ: visualizar os modelos multi-instância existentes.

</details>

<details>

<summary><strong>pipeline-builder</strong></summary>

* APIKEY:READ: visualizar chaves de API existentes na página *Consumers* (chaves de API).
* ACCOUNT:READ: visualizar contas existentes na página Contas.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* REPLICA:READ: visualizar os modelos multi-instância existentes.
* PIPELINE:CREATE: criar um novo *pipeline* na página *Build*.
* PIPELINE:READ: visualizar *pipelines* existentes na página *Build*.
* PIPELINE:UPDATE: atualizar *pipelines* existentes na página *Build*.
* PIPELINE:DELETE: excluir *pipelines* existentes na página *Build*.
* PIPELINE:READ:HISTORY: visualizar o histórico do *pipeline* na página *Build*.
* PIPELINE-DOCUMENTATION:CREATE: criar documentação de *pipeline* ou Cápsula.
* CONFIGURATION:CREATE: configurar o *pipeline*.
* CONFIGURATION:READ: visualizar a configuração do *pipeline*.
* CONFIGURATION:UPDATE: atualizar a configuração do *pipeline*.
* PROJECT:READ: visualizar projetos existentes que você está atribuído como usuário na página *Build*.
* POLICY:READ: visualizar políticas na página Políticas.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* TEST-MODE:EXECUTE: executar *pipelines* no ambiente de teste.
* ZTNA:READ: visualizar *ZTNA Connections* existentes.

</details>

<details>

<summary><strong>pipeline-documentation-manager</strong></summary>

* PIPELINE-DOCUMENTATION:CREATE: criar documentação de *pipeline* ou Cápsula.

</details>

<details>

<summary><strong>pipeline-documentation-viewer</strong></summary>

* PIPELINE-DOCUMENTATION:READ: visualizar documentação de *pipeline* ou Cápsula.

</details>

<details>

<summary><strong>pipeline-executor</strong></summary>

* DEPLOYMENT:EXECUTE: reexecutar manualmente a execução selecionada em todos os ambientes.

</details>

<details>

<summary><strong>pipeline-manager</strong></summary>

* APIKEY:READ: visualizar chaves de API existentes na página *Consumers* (chaves de API).
* ACCOUNT:READ: visualizar contas existentes na página Contas.
* GLOBAL:READ: visualizar variáveis globais existentes na página *Globals*.
* REPLICA:READ: visualizar os modelos multi-instância existentes.
* PIPELINE:CREATE: criar um novo *pipeline* na página *Build*.
* PIPELINE:READ: visualizar *pipelines* existentes na página *Build*.
* PIPELINE:UPDATE: atualizar *pipelines* existentes na página *Build*.
* PIPELINE:DELETE: excluir *pipelines* existentes na página *Build*.
* PIPELINE:READ:HISTORY: visualizar o histórico do *pipeline* na página *Build*.
* CONFIGURATION:CREATE: configurar o *pipeline*.
* CONFIGURATION:READ: visualizar a configuração do *pipeline*.
* CONFIGURATION:UPDATE: atualizar a configuração do *pipeline*.
* POLICY:UPDATE: atualizar políticas na página Políticas.
* POLICY:READ: visualizar políticas na página Políticas.
* PROJECT:CREATE: criar novos projetos na página *Build*.
* PROJECT:READ: visualizar projetos existentes que você está atribuído como usuário na página *Build*.
* PROJECT:UPDATE: atualizar projetos existentes na página *Build*.
* PROJECT:DELETE: excluir projetos existentes na página *Build*.
* PROJECT:READ:ALL: visualizar todos os projetos existentes, mesmo quando você não é um usuário atribuído, na página *Build*.
* PROJECT:UPDATE:LINK-WITH-PIPELINE: associar um *pipeline* a um projeto.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* TEST-MODE:EXECUTE: executar *pipelines* no ambiente de teste.

</details>

<details>

<summary><strong>projects-manager</strong></summary>

* AUDIT:READ: visualizar registros de auditoria na página Auditoria.
* PERMISSION:READ: visualizar as permissões disponíveis na página de Papéis.
* PROJECT:CREATE: criar novos projetos na página *Build*.
* PROJECT:READ: visualizar projetos existentes que você está atribuído como usuário na página *Build*.
* PROJECT:UPDATE: atualizar projetos existentes na página *Build*.
* PROJECT:DELETE: excluir projetos existentes na página *Build*.
* PROJECT:READ:ALL: visualizar todos os projetos existentes, mesmo quando você não é um usuário atribuído, na página *Build*.
* PROJECT:UPDATE:LINK-WITH-PIPELINE: associar um *pipeline* a um projeto.

</details>

<details>

<summary><strong>relationship-manager</strong></summary>

* RELATION:CREATE: criar um novo relacionamento na página Relacionamento.
* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.
* RELATION:UPDATE: atualizar relacionamentos existentes na página Relacionamento.
* RELATION:DELETE: excluir relacionamentos existentes na página Relacionamento.

</details>

<details>

<summary><strong>relationship-viewer</strong></summary>

* RELATION:READ: visualizar relacionamentos existentes na página Relacionamento.

</details>

<details>

<summary><strong>roles-manager</strong></summary>

* PERMISSION:READ: visualizar as permissões disponíveis na página de Papéis.
* ROLE:CREATE: criar novos papéis na página Papéis.
* ROLE:READ: visualizar papéis existentes na página Papéis.
* ROLE:UPDATE: atualizar papéis existentes na página Papéis.
* ROLE:DELETE: excluir papéis existentes na página Papéis.

</details>

<details>

<summary><strong>running-executions-manager</strong></summary>

* INFLIGHT:READ: visualizar uma execução em todos os ambientes.
* INFLIGHT:CANCEL: cancelar uma execução em todos os ambientes.

</details>

<details>

<summary><strong>running-executions-viewer</strong></summary>

INFLIGHT:READ: visualizar uma execução em todos os ambientes.

</details>

<details>

<summary><strong>users-manager</strong></summary>

* PERMISSION:READ: visualizar as permissões disponíveis na página de Papéis.
* USER:CREATE: criar novos usuários na página Usuários.
* USER:READ: visualizar usuários existentes na página Usuários.
* USER:DELETE: excluir usuários existentes na página Usuários.
* USER:UPDATE: atualizar usuários existentes na página Usuários.

</details>

<details>

<summary><strong>licensing-viewer</strong></summary>

* LICENSE:READ: visualizar as licenças do *realm*.

</details>