> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciar parceiros no Console

> Crie um parceiro passo a passo, crie as aplicações dele, altere o que ele alcança, suspenda-o e exclua-o em Configurações no Lerian Console.

Este guia mostra como gerenciar [parceiros](https://docs.lerian.studio/pt/platform/access-manager/features/partners/overview) pelo Console. Você cria o parceiro, cria as aplicações dele e depois altera ou encerra o acesso dele.

## Antes de começar

***

Para gerenciar parceiros, um usuário precisa das permissões `partners` de `plugin-identity`: `get` para ver Parceiros em Configurações, `post` para criar um parceiro, `patch` para alterar um e `delete` para excluir um. Gerenciar as aplicações dele precisa das permissões `applications` `get`, `post` e `delete`. O papel `plugin-identity-editor-role` tem todas elas.

Criar um parceiro, alterar as permissões ou o escopo dele e criar as aplicações dele precisam do Access Manager 3.11.0 ou posterior. Com uma versão anterior, o Console mostra "Requer Access Manager 3.11.0 ou posterior" no lugar desses controles.

Reúna estas informações antes de começar:

* Os produtos de que o parceiro precisa e o que ele pode fazer em cada um.
* Os identificadores dos itens que o parceiro pode alcançar, para cada dimensão que você restringe. Cada produto que oferece restrições precisa de pelo menos um. Copie-os da própria API ou do Console do produto. O Console não confere se eles existem.
* O que as restrições de cada produto alcançam: veja [Parceiros no Midaz](https://docs.lerian.studio/pt/platform/access-manager/features/partners/midaz.md) e [Parceiros no Pix JD](https://docs.lerian.studio/pt/platform/access-manager/features/partners/pix-jd.md).
* Os endereços de rede de onde o parceiro chama, se você quiser restringi-los.
* As datas de início e de fim do acesso dele, se ele tiver limite de tempo.

## Abrir a página Parceiros

***

**1. Abra Configurações**

Clique no ícone de engrenagem () na barra de navegação superior.

**2. Selecione Parceiros**

Selecione **Parceiros**. O subtítulo diz "Dê a cada cliente credenciais próprias e limite o que ele pode acessar."

O card **Dê acesso a parceiros** na página inicial do Console abre a mesma página.

A lista mostra **Nome**, **Status**, **Janela de validade**, **Aplicações** e **Data de criação** de cada parceiro. O status é **Ativo**, **Suspenso**, **Expirado** ou **Ainda não vigente**. O Console mostra **Expirado** e **Ainda não vigente** a partir da janela de validade. Sem parceiros ainda, a página diz "Você ainda não cadastrou nenhum parceiro".

## Criar um parceiro

***

Clique em **Novo parceiro**. A página **Novo parceiro** abre, com cinco etapas: **Detalhes**, **Produtos**, **Escopo**, **Permissões** e **Revisão**. O botão **Próximo** abre apenas quando a etapa atual está completa. O botão **Voltar** mantém o que você informou. Se você clicar em **Cancelar** depois de informar algo, o Console pergunta "Descartar este novo parceiro?". Nada é criado até você salvar.

**1. Detalhes**

Digite o **Nome** do parceiro. Ele deve ser único no seu tenant.

Em **Janela de validade**, preencha **Válido a partir de** e **Válido até** se o acesso tiver limite de tempo. Deixe **Válido a partir de** vazio para começar agora. Deixe **Válido até** vazio para que ele nunca expire. Depois da data **Válido até** do parceiro, o Access Manager recusa as requisições dele, também com um token que ele já tem, e recusa tokens novos.

Em **De onde ele chama**, escolha uma opção:

* **Usar a lista de IPs da sua organização**: o parceiro usa a lista de IPs permitidos do seu tenant.
* **Dar a ele uma lista própria**: digite cada **Endereço IP ou faixa CIDR** e uma **Descrição** opcional. Clique em **Adicionar IP** para cada nova linha.

Quando um parceiro tem uma lista de IPs própria, essa lista substitui a lista de IPs do tenant nas requisições do parceiro.

**2. Produtos**

Escolha os produtos que o parceiro pode usar. A lista mostra apenas o que o seu tenant pode dar.

Um produto que não aceita parceiros fica indisponível, com uma destas mensagens:

* "Este produto ainda não está preparado para parceiros." O produto não publicou o catálogo de escopo dele.
* "Este produto ainda não habilitou o acesso de parceiros." O catálogo de escopo do produto não aceita parceiros.

**3. Escopo**

Diga onde o parceiro pode atuar em cada produto. Uma restrição que o produto exige já aparece aberta, com **(Obrigatório)** depois do nome dela.

Para adicionar uma restrição, marque **Restringir por** seguido do nome da restrição. Digite um identificador, ou vários identificadores separados por vírgula.

Dê ao parceiro pelo menos uma restrição com um ID em cada produto que oferece restrições. Até lá, o botão **Próximo** fica fechado.

**4. Permissões**

Marque os recursos e as ações que o parceiro pode usar em cada produto. Para dar outro conjunto de ações em outros recursos, clique em **Adicionar outra linha em** seguido do nome do produto.

O Console oferece apenas o que o seu tenant pode dar. Ele mostra um motivo ao lado de cada entrada que não pode salvar:

* **Não permitido**: o papel de editor do produto no seu tenant não tem esta permissão.
* **Fora do escopo**: a escrita atua em um nível mais amplo que o escopo do parceiro.
* **Concedido duas vezes**: outra linha já concede a mesma ação no mesmo recurso.

Um produto pode conceder alguns recursos apenas por ID. Quando você marcar um deles, liste os IDs dele na etapa **Escopo**, ou o botão **Próximo** fica fechado.

**5. Revisão**

Leia o resumo em "Confira o que este parceiro pode e não pode fazer". A parte **Somente dentro de** lista as restrições. A parte **Ele pode** lista as ações em cada recurso. A parte **Ele não pode** lista o que fica de fora.

Clique em **Salvar**. O Console cria o parceiro sem aplicações e abre a aba **Visão Geral** dele.

Se o Access Manager recusar o parceiro, o Console mostra "O Access Manager recusou esta alteração". Ele também mostra o motivo e o código de erro, e abre a etapa que tem o campo a corrigir.

## Criar as aplicações do parceiro

***

Um parceiro chama um produto com uma aplicação que pertence a ele. Crie uma aplicação por produto.

**1. Abra a aba Aplicações**

Na lista de parceiros, clique no parceiro. Selecione a aba **Aplicações**.

**2. Crie a aplicação**

Clique em **Nova Application**. No painel lateral **Nova aplicação**, escolha o **Produto**. A lista mostra apenas os produtos em que o parceiro tem permissões. Preencha **Descrição** e clique em **Criar aplicação**.

**3. Guarde as credenciais**

A caixa de diálogo "Guarde as credenciais" mostra o **Client ID** e o **Client secret**. O Console mostra o client secret somente quando você cria a aplicação. Guarde-o nesse momento. Clique em **Já guardei** para fechar a caixa de diálogo.

As aplicações de parceiro não aparecem em **Configurações → Aplicações**. Elas aparecem apenas na aba **Aplicações** do parceiro.

## Alterar um parceiro

***

Abra o parceiro na lista. A página de detalhes tem cinco abas:

| Aba | O que você faz nela |
| - | - |
| **Visão Geral** | Renomear o parceiro, alterar a **Janela de validade** dele, suspendê-lo ou reativá-lo e excluí-lo. |
| **Permissões** | Adicionar ou remover produtos, recursos e ações. |
| **Escopo** | Adicionar, alterar ou remover restrições. Clique em **Adicionar restrição** e escolha o item em **Restringir por**. |
| **IPs** | Dar ao parceiro uma lista própria, alterá-la ou voltar para **Usar a lista da organização**. |
| **Aplicações** | Criar e excluir as aplicações do parceiro. |

Salvar em **Permissões** ou em **Escopo** substitui as permissões e o escopo juntos. O botão **Salvar** fica fechado enquanto um produto que oferece restrições não tem nenhuma restrição com um ID. Ele também fica fechado enquanto um recurso que um produto concede apenas por ID não tem IDs na aba **Escopo**.

## Suspender ou reativar um parceiro

***

Na aba **Visão Geral**, clique em **Suspender** e confirme. Isso não exclui nada.

Para encerrar a suspensão, clique em **Reativar** e confirme.

Suspender um parceiro no Access Manager interrompe o acesso dele, inclusive os tokens que ele já tem. Reativar o parceiro dentro da janela de validade dele restaura o acesso com as mesmas credenciais.

## Excluir um parceiro

***

Você pode excluir apenas um parceiro sem aplicações.

**1. Exclua as aplicações dele**

Na aba **Aplicações**, exclua cada aplicação do parceiro. Excluir uma aplicação faz os tokens dela pararem de funcionar.

**2. Exclua o parceiro**

Na aba **Visão Geral**, em **Excluir parceiro**, clique em **Excluir** e confirme com **Sim, excluir**. O Access Manager também exclui as permissões, o escopo e a lista de IPs dele. Você não pode desfazer isso.

Se o parceiro ainda tiver aplicações, o Console as lista e oferece **Ir para Aplicações**.

## Parceiros que usam a lista de IPs do seu tenant

***

Quando alguns parceiros não têm uma lista de IPs própria, **Configurações → Segurança** mostra um aviso na aba **Lista de IPs permitidos**. O aviso diz quantos parceiros usam a lista do seu tenant, e o botão dele os lista.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.