> ## 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.

# Parceiros

> Dê a cada um dos seus próprios clientes aplicações próprias e escolha o que ele pode fazer, onde, de quais endereços e por quanto tempo.

Um parceiro é um dos seus próprios clientes que chama a sua plataforma Lerian pelos sistemas dele. O Access Manager dá a cada parceiro aplicações próprias. Você decide o que o parceiro pode fazer e em qual parte dos dados de um produto. Você também decide os endereços de rede e a janela de validade dele.

## Os blocos de construção

***

Um parceiro é um registro do seu tenant. As linhas depois dele descrevem o que você define para um parceiro.

| Conceito | O que é |
| - | - |
| **Parceiro** | Um registro no seu tenant que representa um dos seus próprios clientes. Um parceiro não é um tenant. |
| **Aplicação do parceiro** | Uma aplicação que pertence a um parceiro. Um parceiro pode ter várias aplicações. |
| **Permissões** | O que o parceiro pode fazer: um produto, os recursos dele e as ações sobre eles. |
| **Escopo** | Onde o parceiro pode fazer isso: uma restrição por dimensão do catálogo de escopo do produto, com os valores que você escolhe. |
| **Catálogo de escopo** | A lista de dimensões que um produto publica para parceiros, como um identificador de participante. |
| **Teto** | O máximo que você pode dar a um parceiro em um produto: as permissões do papel de editor desse produto no seu tenant, e as permissões que o produto reserva para parceiros. |
| **Lista de IPs permitidos do parceiro** | Uma lista de endereços de rede que pertence a um parceiro. |
| **Janela de validade e estado** | O início e o fim do acesso do parceiro (`validFrom` e `validUntil`) e o estado dele: `active` ou `suspended`. |

## Produtos que aceitam parceiros

***

Você pode dar permissões a um parceiro apenas em um produto que aceita parceiros. Um produto aceita parceiros quando publica um catálogo de escopo com a adesão a parceiros.

Para ver quais produtos aceitam parceiros no seu deploy, leia os catálogos de escopo com [Listar catálogos de escopo](https://docs.lerian.studio/pt/reference/platform/access-manager/list-scope-catalogs.md). Um produto aceita parceiros quando a entrada dele tem `partners: true`. Um produto sem entrada não publicou um catálogo de escopo.

No Console, a etapa **Produtos** da página de novo parceiro mostra como indisponíveis os produtos que não aceitam parceiros.

Cada produto tem uma página própria com as restrições dele, os campos em que o parceiro nomeia os itens dele e as recusas que ele recebe:

* [Parceiros no Midaz](https://docs.lerian.studio/pt/platform/access-manager/features/partners/midaz.md)
* [Parceiros no Pix JD](https://docs.lerian.studio/pt/platform/access-manager/features/partners/pix-jd.md)

## O que você precisa saber

***

* Cada produto define as próprias dimensões no catálogo de escopo dele. O catálogo diz se uma dimensão é obrigatória e se ela aceita mais de um valor.
* **Um parceiro com permissões em um produto que declara dimensões precisa de escopo nele.** Dê a ele pelo menos uma entrada de escopo para esse produto. Sem ela, o Access Manager recusa criar ou alterar o parceiro, com `400` e `IDE-1060`. Um parceiro salvo antes desta regra, sem entrada de escopo, é recusado com `403` em toda requisição a esse produto até você adicionar uma.
* A exceção é uma entrada de permissões que tem apenas permissões que o produto reserva para parceiros. Uma entrada assim não precisa de escopo, e vale para o tenant inteiro. No Pix JD, essas são as [permissões de canal da JD](https://docs.lerian.studio/pt/platform/access-manager/features/partners/pix-jd.md#jd-as-a-partner).
* Quando um produto marca uma dimensão como obrigatória, um parceiro com permissões nesse produto precisa de uma entrada de escopo para ela. Sem ela, o Access Manager recusa o parceiro com `IDE-0001`.
* Fora de uma entrada de permissões reservadas, um parceiro alcança só o que as permissões **e** o escopo dele permitem, juntos.
* O Access Manager não confere se os valores de escopo existem no produto. Ele guarda os valores que você informa. Copie-os da própria API ou do Console do produto.
* Você não pode excluir um parceiro que tem aplicações. Exclua as aplicações dele antes.
* O Access Manager recusa uma permissão acima do teto com `IDE-1043`. O Console a marca como **Não permitido**.

## Como uma requisição é decidida

***

Toda requisição que uma aplicação do parceiro envia a um produto é conferida contra o cadastro do parceiro, nesta ordem. A primeira conferência que falha decide a resposta:

1. **Endereço de rede.** O endereço de quem chama é conferido com a lista de IPs própria do parceiro, ou com a lista do seu tenant quando o parceiro não tem uma.
2. **Estado.** O parceiro tem que estar `active`.
3. **Janela de validade.** A requisição tem que estar dentro da janela de validade do parceiro.
4. **Permissões.** O produto, o recurso e a ação têm que estar nas permissões do parceiro.
5. **Escopo.** Os itens que a requisição nomeia têm que estar dentro do escopo do parceiro. Uma permissão que o produto reserva para parceiros pula essa verificação.

As duas últimas conferências dão a mesma resposta, então um parceiro não consegue usar uma recusa para descobrir quais itens existem fora do escopo dele. As três primeiras conferências também valem quando o parceiro pede um token. A página de cada produto lista os códigos que o parceiro recebe.

## Quando uma alteração vale

***

Toda alteração que você faz num parceiro vale sem um token novo: as permissões, o escopo, o estado, a janela de validade e a lista de IPs.

## Próximos passos

***

> [card] [Gerenciar parceiros no Console](https://docs.lerian.studio/pt/platform/access-manager/features/partners/console.md)
>
> Crie um parceiro passo a passo, crie as aplicações dele, suspenda-o ou exclua-o.

> [card] [Gerenciar parceiros pela API](https://docs.lerian.studio/pt/platform/access-manager/features/partners/api.md)
>
> As operações de parceiro, os campos delas, exemplos e códigos de erro.

> [card] [Parceiros no Midaz](https://docs.lerian.studio/pt/platform/access-manager/features/partners/midaz.md)
>
> Restrinja um parceiro a uma organização e aos ledgers, contas ou rotas dela.

> [card] [Parceiros no Pix JD](https://docs.lerian.studio/pt/platform/access-manager/features/partners/pix-jd.md)
>
> Restrinja um parceiro a um participante direto ou a um participante indireto.

> [card] [Lista de IPs permitidos](https://docs.lerian.studio/pt/platform/access-manager/features/ip-allowlist/overview)
>
> A lista de endereços de rede confiáveis do seu tenant.

> [card] [Lista de erros](https://docs.lerian.studio/pt/reference/platform/access-manager/access-manager-error-list.md)


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