> For the complete documentation index, see [llms.txt](https://library.zoom.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://library.zoom.com/technical-library/pt/canto-do-administrador/account-and-endpoint-management/scim-guide.md).

# Guia de campo SCIM para Entra ID e Okta

Um guia para criar mapeamentos SCIM personalizados entre o Entra ID ou Okta e o Zoom

## Visão geral

A API SCIM2 do Zoom expõe um grande catálogo de atributos de usuário que नियंत्रam licenciamento, direitos de produto, funções, regiões e configuração por serviço. As integrações de provisionamento prontas para uso tanto para Microsoft Entra ID quanto para Okta mapeiam apenas um pequeno subconjunto deles — o suficiente para criar, atualizar e desativar usuários, mas não o suficiente para provisionar sites do Zoom Phone, pacotes da central de contato, funções do Revenue Accelerator ou qualquer um dos dezenas de outros atributos que o Zoom oferece.

Este guia ensina o método repetível para adicionar *qualquer* atributo SCIM do Zoom à sua configuração de provisionamento. Em vez de documentar um atributo de forma isolada, ele explica o modelo subjacente para que os administradores possam consultar um atributo na referência da API SCIM2 do Zoom e configurá-lo de forma independente, sem esperar que um artigo específico do produto seja publicado.

### Como usar este guia

Leia primeiro a Introdução começando com [**Compreender os atributos SCIM**](#understanding-scim-attributes) , juntamente com as seções que a seguem — pré-requisitos, dados do diretório, cenários de referência e Verificação do lado do Zoom. Isso se aplica independentemente do provedor de identidade (IdP) que você usar. Em seguida, percorra a seção do Microsoft Entra ID ou do Okta, dependendo de qual você usa. Cada uma dessas partes é completa desde a primeira etapa de configuração até a Verificação e os exemplos práticos; você não precisará alternar entre elas.

Para os conceitos fundamentais de SSO e SCIM que sustentam este guia, consulte o [Guia de Campo de SSO](https://library.zoom.com/admin-corner/account-and-endpoint-management/sso-field-guide), o [artigo de SSO e provisionamento do Zoom para o Entra ID](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064121), e o [artigo de SSO do Zoom para Okta](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063256).

{% hint style="danger" %}
**Aviso**

O provisionamento configurado incorretamente afeta usuários existentes, incluindo a remoção de licenças já em uso. Valide cada alteração em relação a um único usuário de teste antes de aplicá-la a usuários em produção.
{% endhint %}

### **Pré-requisitos para usar o SCIM**

Tudo nesta parte se aplica independentemente do provedor de identidade. Leia isto antes de prosseguir para as instruções específicas do seu provedor de identidade.

#### Requisitos comuns a ambos os provedores de identidade

* conta Zoom Corporativo, Educação ou empresarial com um aprovado [URL intuitivo](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0061540)
* privilégios de proprietário da conta Zoom ou de administrador
* [logon único](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060673) ativado na conta Zoom
* A [domínio associado verificado](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0066259) na conta Zoom, correspondendo ao domínio de e-mail dos usuários a serem provisionados
* O provisionamento SCIM já foi estabelecido entre o provedor de identidade e o Zoom
* A licença do Zoom, o plano, o add-on ou o objeto de configuração que está sendo atribuído deve já existir e estar Disponível na conta Zoom

Os requisitos específicos do provedor de identidade estão listados no início de cada respetiva secção.

#### Limitações comuns a ambos os provedores de identidade

* O SCIM atribui apenas autorizações existentes; não pode criar os objetos a que faz referência. Consulte a secção [**Antes de tentar o mapeamento avançado, os objetos do lado do Zoom devem existir antes que o SCIM possa referenciá-los**](#before-attempting-advanced-mapping-zoom-side-objects-must-exist-before-scim-can-reference-them) abaixo.
* Alguns atributos aceitam apenas um valor por usuário. Um exemplo é um Plano de tarifação de chamadas do Zoom Phone — pacotes add-on como o Customer Engagement Pack não podem ser provisionados por meio do SCIM.
* O `tipoDeUtilizador` o atributo está documentado pela Zoom como previsto para descontinuação.

## **Introdução**

### **Compreender os atributos SCIM**

Os administradores que entendem como um atributo SCIM do Zoom é construído podem Configurar qualquer atributo que o Zoom suporte. Os administradores que seguem uma receita podem Configurar apenas o atributo que essa receita descreve. Esta seção aborda a construção. O mapeamento de um atributo para uma fonte de dados vem mais tarde, nas seções do provedor de identidade.

#### <mark style="color:azul;">Todo atributo tem um espaço de nomes, um nome, um tipo de dados e um valor permitido</mark>

Vamos começar com um exemplo completo e funcional. Aqui está o identificador para atribuir um usuário a uma unidade do Zoom Phone:

```
urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomPhoneSite
```

Quatro propriedades deste atributo estão em jogo. Duas delas são visíveis na linha acima. As outras duas vêm da referência da API e são inseridas em outro lugar no seu provedor de identidade mais tarde. Para os nossos propósitos imediatos, estamos focados em duas: a **Espaço de nomes** e o **Nome**.

<table><thead><tr><th width="155.290771484375">Propriedade</th><th>Extraído do exemplo</th><th>O que faz</th></tr></thead><tbody><tr><td><strong>Espaço de nomes</strong></td><td><code>urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário</code></td><td>Diz ao Zoom a que esquema pertence a definição, e funciona como a base partilhada para quase todos os atributos de produto e licenciamento do Zoom. Enviado ao Zoom como a primeira metade do identificador.</td></tr><tr><td><strong>Nome</strong></td><td><code>zoomPhoneSite</code></td><td>Identifica a configuração específica do Zoom que está sendo gravada — aqui, a unidade do Zoom Phone do usuário. Enviado ao Zoom como a segunda metade do identificador. Diferencia maiúsculas de minúsculas.</td></tr><tr><td><strong>Tipo de dados</strong></td><td><code>string</code></td><td>Indica ao seu provedor de identidade que tipo de valor o atributo contém para que seja armazenado e formatado corretamente. Não é passado como parte do identificador; é declarado separadamente como <strong>Tipo</strong> no Entra ID, ou <strong>Tipo de dados</strong> no Okta.</td></tr><tr><td><strong>Valor permitido</strong></td><td><code>LON-01</code>, um nome de unidade do Zoom Phone</td><td>A configuração realmente aplicada ao usuário. Texto livre para alguns atributos, um conjunto fixo para outros — <code>Essenciais</code>, <code>Premium</code>, ou <code>Elite</code> para o Zoom central de contato, por exemplo. Transmitido ao Zoom no momento do provisionamento, fornecido pelo mapeamento em vez do identificador.</td></tr></tbody></table>

{% hint style="danger" %}
**Aviso**

O Zoom publica mais de um namespace de extensão do usuário. Os atributos de configuração do produto e de licenciamento usam `urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário`, que é o espaço de nomes que este guia usa ao longo de todo o texto. Campos empresariais padrão, como `departamento`, `gerente`, e `centro de custo` usam `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário`. Um terceiro, `urn:us:zoom:scim:schemas:extension:1.0:Zoomusuário`, contém informações do tipo de login retornadas nas respostas da API, em vez de configuradas durante o provisionamento. Um atributo criado no espaço de nomes errado é aceito pelo seu provedor de identidade e ignorado silenciosamente pelo Zoom.
{% endhint %}

#### <mark style="color:azul;">Localize o atributo de que você precisa na referência da API SCIM2</mark>

O [Referência da API SCIM2](https://developers.zoom.us/docs/api/scim2/#tag/user/post/scim2/Users) é a lista definitiva de tudo o que o Zoom aceita durante o provisionamento. Duas operações importam: **Criar um usuário** e **Atualizar um usuário**.

Baseie-se principalmente em **Atualizar um usuário**. A criação acontece uma vez por pessoa, mas as alterações de atributos acontecem continuamente — uma mudança de escritório, Alterar o plano, Alterar a Função, uma saída — portanto, a maior parte do que o provisionamento realmente faz ao longo do tempo são atualizações. **Atualizar um usuário** também documenta os valores de remoção que **Criar um usuário** não tem motivo para incluir, como definir `zoomPhoneCallingPlan` para `-1` para remover todos os planos de chamada de um usuário.

Para encontrar um atributo:

* Abra a referência da API SCIM2 e vá para **Atualizar um usuário**.
* No corpo da solicitação, localize o `urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário` objeto. Cada atributo coberto neste guia está listado dentro dele.
* Encontre o seu atributo pelo nome e grave o seu **tipo de dados** e os seus **valores permitidos**.
* Leia a descrição ao lado. As descrições trazem comportamento que você não pode inferir pelo nome do atributo — `zoomPhoneExtNumber` definido como `0` ativa a atribuição automática de ramal, `zoomPhoneCallingPlan` definido como `-1` remove todos os planos de chamadas e `zoomPhoneNumber` deve referenciar um número que já não está atribuído na conta Zoom.

#### <mark style="color:azul;">Montando o identificador: pai, dois-pontos, filho</mark>

Tudo listado dentro daquele `urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário` objeto é um **filho** disso. O próprio objeto é o **pai**. Construir um identificador significa nomear o pai, adicionar dois-pontos e depois adicionar o filho:

```
Pai       urn:ietf:params:scim:schemas:extension:zoom:1.0:User
Dois-pontos        :
Filho        zoomPhoneSite

identificador   urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomPhoneSite
```

Essa é toda a construção. Não há nenhuma tabela de consulta para solicitar do Zoom e nada a gerar — o identificador são duas coisas que você já tem, unidas por dois-pontos.

#### <mark style="color:azul;">O elemento pai permanece o mesmo; apenas o elemento filho muda</mark>

Como o elemento pai é fixo, configurar um segundo, quinto ou décimo quinto atributo é a mesma ação, com um filho diferente acrescentado:

```
Base (pai)              urn:ietf:params:scim:schemas:extension:zoom:1.0:User

Zoom Phone unidade            urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomPhoneSite
Zoom Phone number          urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomPhoneNumber
Extensão do Zoom Phone       urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomPhoneExtNumber
Zoom Phone Plano de tarifação de chamadas    urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomPhoneCallingPlan
```

O mesmo elemento pai carrega todos os outros produtos Zoom. Nada Sobre a construção muda quando o produto muda:

```
central de contato Pacote     urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomContactCenterPackage
Revenue Accelerator Função   urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomRevenueAcceleratorRole
Pacote do local de trabalho           urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomWorkplace
Zoom Docs                  urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário:zoomDocs
```

Você, portanto, aprende o elemento pai uma vez. A partir daí, configurar um novo atributo significa consultar apenas três coisas na referência da API: o nome do filho, o seu tipo de dados e os seus valores permitidos.

Se você consegue montar um pai e um filho, a parte mais difícil desta configuração ficou para trás. O que resta é dizer ao seu provedor de identidade de onde cada valor deve vir — abordado nas seções de Entra ID e Okta a seguir — e decidir quais atributos abordar primeiro, abordado Próximo(a).

#### <mark style="color:azul;">Dois tipos de mapeamento: básico e avançado</mark>

Nem todo atributo apresenta o mesmo risco, e vale a pena classificá-los antes de configurar qualquer coisa.

Este guia adota os termos **básico** e **avançado** do [Guia de Campo de SSO](https://library.zoom.com/admin-corner/account-and-endpoint-management/sso-field-guide), que traça a mesma linha para o mapeamento de respostas SAML. Os termos descrevem **o que o Zoom faz com o valor ao recebê-lo**, não quão difícil é Configurar o atributo. Mecanicamente, os dois são idênticos: ambos são documentados no mesmo **Atualizar um usuário** corpo da requisição, ambos são construídos com a mesma construção pai-dois-pontos-filho, e ambos são declarados e mapeados pelas mesmas etapas no Entra ID e no Okta.

* **mapeamento básico** grava texto no perfil de um usuário. Zoom armazena o valor exatamente como enviado e nunca o verifica contra nada.
* **Mapeamento avançado** faz uma reivindicação contra a conta. Zoom pega o valor e procura um objeto correspondente, ou uma vaga disponível em um plano adquirido — e essa pesquisa pode falhar.

<table><thead><tr><th width="199.435791015625"></th><th>mapeamento básico</th><th>Mapeamento avançado</th></tr></thead><tbody><tr><td><strong>O que o valor é</strong></td><td>Texto armazenado no perfil do usuário</td><td>Um ponteiro para um objeto no Zoom, ou uma reivindicação sobre uma vaga adquirida</td></tr><tr><td><strong>Exemplos</strong></td><td><code>departamento</code>, <code>título</code>, <code>centro de custo</code></td><td><code>zoomPhoneSite</code>, <code>zoomContactCenterRole</code>, <code>zoomWorkplace</code></td></tr><tr><td><strong>Pai</strong></td><td>Nível superior, ou a extensão empresarial</td><td>A extensão Zoom</td></tr><tr><td><strong>Pré-condições no Zoom</strong></td><td>Nenhum</td><td>O objeto deve existir, ou a licença deve estar livre</td></tr><tr><td><strong>Se o valor estiver errado</strong></td><td>Texto incorreto aparece em um perfil</td><td>O atributo é rejeitado ou ignorado silenciosamente</td></tr></tbody></table>

A distinção orienta duas decisões práticas. Ela determina **o que você deve construir primeiro no Zoom** — nada para o mapeamento básico, potencialmente bastante para o avançado — e determina **o que um erro custa**. Um departamento incorreto é um erro cosmético em um perfil. Um nome de unidade incorreto ou uma vaga de licença indisponível deixa um usuário sem um telefone funcionando ou sem o produto que foi contratado para usar e, em uma implantação em produção, pode retirar de alguém uma permissão que essa pessoa já tinha.

Essa diferença de consequência é o motivo pelo qual os dois são tratados separadamente abaixo.

#### <mark style="color:azul;">Mapeamento básico: informações de perfil</mark>

O mapeamento básico preenche os campos descritivos no perfil do usuário no Zoom. O Zoom armazena cada valor exatamente como enviado e nunca o valida contra um objeto existente, então não há nada a construir no Zoom antecipadamente e nada a quebrar se um valor estiver incorreto.

**Os campos principais de identidade geralmente já estão mapeados.** `Nome de usuário`, `name.givenName`, `name.familyName`, `displayName`, e `emails` ficam no nível superior do corpo da solicitação, sem nenhum elemento pai, e tanto as integrações do Entra ID quanto do Okta os mapeiam automaticamente. Verifique-os em vez de recriá-los. `título`, `phoneNumbers`, e `locale` também estão no nível superior, mas talvez precisem ser adicionados.

**Os campos empresariais usam um segundo pai.** A construção não se Alterar — apenas o pai o faz:

```
Base (pai)         urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário

Departamento            urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:department
Centro de custo           urn:ietf:params:scim:schemas:extension:empresarial:2.0:User:costCenter
Número do Funcionário       urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:employeeNumber
Organização          urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:Organização
Gerente               urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:gerente
```

Preencher Departamento e Centro de Custo através do SCIM já não requer mapeamento SAML.

{% hint style="info" %}
**Recomendação**

Mapeie primeiro um atributo básico — `departamento` é um bom candidato e é trabalhado como **Cenário 0** nos cenários de referência — e execute-o do início ao fim para um único usuário de teste antes de configurar qualquer coisa na extensão do Zoom. Um `departamento` valor que aparece corretamente num perfil do Zoom prova a declaração do esquema, o mapeamento, o escopo e a sua capacidade de ler os registos de provisionamento. Cada atributo avançado que se segue difere apenas no que aponta, e não em como é configurado.
{% endhint %}

#### <mark style="color:azul;">Mapeamento avançado: configuração do produto e direitos</mark>

O mapeamento avançado atribui as coisas que um usuário pode fazer: uma unidade do Zoom Phone e um Plano de tarifação de chamadas, uma Função de central de contato e um Pacote, um pacote Workplace, um segmento do Revenue Accelerator. Esses atributos ficam sob o elemento pai da extensão do Zoom usado ao longo deste guia.

A diferença que importa é que esses valores não são armazenados — eles são **resolvidos**. O Zoom recebe o valor que envia e procura um objeto correspondente ou uma vaga Disponível. Onde o mapeamento básico escreve texto num perfil, o mapeamento avançado faz uma reivindicação sobre a configuração e o inventário da conta, e essa reivindicação pode falhar.

É por isso que este guia dedica uma seção inteira aos pré-requisitos. Cada atributo avançado depende de algo ter sido criado ou comprado primeiro no Portal web do Zoom, e os modos de falha são consideravelmente menos tolerantes do que um cargo escrito incorretamente.

#### <mark style="color:azul;">As três camadas comuns a todas as configurações</mark>

Independentemente do atributo ou do provedor de identidade, o trabalho envolve as mesmas três camadas. Apenas a localização de cada controle difere.

<table><thead><tr><th width="114.4166259765625">Camada</th><th>Finalidade</th><th>Microsoft Entra ID</th><th>Okta</th></tr></thead><tbody><tr><td><strong>1. Declarar</strong></td><td>Informe ao provedor de identidade que o atributo existe no aplicativo Zoom, para que ele fique disponível como destino de mapeamento.</td><td>Etapa 1</td><td>Etapa 1</td></tr><tr><td><strong>2. Mapear</strong></td><td>Defina de onde o valor vem.</td><td>Etapa 2</td><td>Etapas 2–3</td></tr><tr><td><strong>3. Definir o escopo</strong></td><td>Determine a quais usuários a configuração se aplica e quando ela é executada.</td><td>Etapas 3–5</td><td>Etapas 4–5</td></tr></tbody></table>

Depois que esse padrão é compreendido, adicionar um quinto ou décimo quinto atributo é uma repetição das mesmas três camadas, e não um novo projeto.

#### <mark style="color:azul;">O Entra e o Okta diferem quanto à origem de um valor</mark>

Esta é a diferença arquitetônica mais importante entre os dois caminhos, e explica por que o mesmo requisito empresarial produz configurações diferentes entre o Entra e o Okta.

* **O Entra ID obtém valores somente de atributos do objeto de usuário.** Um valor deve vir de um campo do usuário — um campo de diretório existente ou um atributo de extensão feito sob medida. Quando o valor do diretório e o valor do Zoom não são a mesma cadeia de caracteres, é necessária uma expressão para fazer a conversão entre eles.
* **O Okta pode obter valores do perfil do usuário ou de uma atribuição de grupo.** Declarar um atributo com **Tipo de atributo: grupo** permite que o valor seja definido uma vez em um grupo e herdado por cada Membros. Quando a configuração segue a estrutura organizacional, isso elimina totalmente a necessidade de lógica de conversão.

Nenhuma das abordagens é universalmente melhor, mas elas levam a configurações diferentes.

### **Requisitos de pré-configuração no Zoom**

#### <mark style="color:azul;">Antes de tentar o mapeamento avançado, os objetos do lado do Zoom devem existir antes que o SCIM possa referenciá-los</mark>

O SCIM é um mecanismo de atribuição, não um mecanismo de criação — ele conecta um usuário à configuração que já existe na conta Zoom, e ele **não pode** criar essa configuração em nome do usuário.

Uma grande parte dos atributos de mapeamento avançado são **referências**: espera-se que o valor enviado seja resolvido como um objeto que já existe no Zoom — uma unidade, uma Função, um modelo, um plano comprado, um número específico ou ramal. Uma regra rege todos eles:

> Se um atributo nomeia algo, esse algo deve já existir, deve ser escrito exatamente como foi enviado e — quando depender de um conjunto finito — deve ter capacidade não utilizada.

Quando um objeto referenciado não existe, o SCIM não o cria nem coloca a solicitação em fila. O atributo falha completamente, com o erro retornado no log de provisionamento, ou é descartado silenciosamente — o Zoom aceita a carga útil, não aplica nada e informa sucesso.

As seções abaixo detalham os pré-requisitos por produto, com o caminho de navegação e o artigo de suporte para criar cada um deles. Leia as observações no nível da conta e, em seguida, a seção de cada produto que pretende provisionar.

#### <mark style="color:azul;">Os pré-requisitos no nível da conta se aplicam antes que qualquer produto seja provisionado</mark>

Os requisitos de conta listados no início deste guia — URL intuitivo, SSO, autorização SCIM e um domínio associado verificado — são pré-requisitos para todos os atributos a seguir. Todos os quatro são configurados em **Avançado** → **Segurança** / **logon único** / **Domínios associados**; consulte [Configuração de SSO/SCIM do Zoom + Microsoft Entra ID](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064121).

Vale a pena declarar explicitamente mais dois pontos:

* **Comprar uma licença não é o mesmo que atribuí-la.** O SCIM realiza a atribuição, mas a licença deve existir primeiro. Consulte [Atribuir ou remover licenças Zoom de usuários](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064911).
* **As licenças devem pertencer ao plano exato solicitado.** Enviar um atributo de licença quando esse plano específico não tem licenças disponíveis falha, mesmo que um plano diferente na conta mostre capacidade disponível.

#### <mark style="color:azul;">Zoom Phone</mark>

O Zoom Phone tem o maior conjunto de atributos de referência porque um usuário de telefone é composto por várias partes de infraestrutura pré-comprada ou pré-criada.

| Atributo                                                                   | O que já deve existir                                                                                                                                                                 | Como criá-lo                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| A própria licença do Zoom Phone                                            | Uma licença Zoom Phone disponível — o direito pré-requisito antes que qualquer item abaixo possa ser associado.                                                                       | Compre antecipadamente. Consulte [Comprar e atribuir licenças Zoom Phone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0077929).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `zoomPhoneSite`                                                            | A unidade, nomeada exatamente como o valor enviado. Omitir o atributo atribui a unidade principal da conta, que existe por padrão quando Múltiplas unidades estão habilitadas.        | Centro de administração → Configuração do produto → sistema de telefonia → Informações da empresa → **Adicionar unidade**, ou **Importar** para criação em massa. Consulte [Gerenciar Múltiplas unidades](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0069716).                                                                                                                                                                                                                                                                                                                                                            |
| `zoomPhoneNumber`                                                          | O número, comprado ou portado para a conta e atualmente não atribuído. Um número já mantido por outro usuário, fila de chamadas ou recepcionista automático não pode ser reutilizado. | Centro de administração → Configuração do produto → Números → Números de telefone. Compre ou porte aqui e deixe o número de destino não atribuído para que o SCIM possa reivindicá-lo. Consulte [Usar o Gerenciamento de números para gerenciar Números de telefone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0074457) e [Gerenciar Números de telefone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060212).                                                                                                                                                                                   |
| `zoomPhoneExtNumber` (somente valores específicos)                         | Um ramal de 3 a 6 dígitos, que ainda não esteja em uso. Não é necessário ao enviar `0`, que delega a atribuição ao Zoom.                                                              | Centro de administração → Configuração do produto → sistema de telefonia → Usuários e salas → Selecionar o objeto que contém o ramal → **Perfil** → **Número do ramal** → **Editar**. Consulte [Alterar Configurações do usuário de telefone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0069338).                                                                                                                                                                                                                                                                                                                        |
| `zoomPhoneCallingPlan`                                                     | O Plano de tarifação de chamadas, comprado e com capacidade disponível, referenciado pelo código exato do plano.                                                                      | Compre antecipadamente. Consulte [Comprar e atribuir licenças Zoom Phone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0077929) e [Gerenciar usuários de telefone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0069309). Os códigos de plano estão listados na [Referência do Plano de tarifação de chamadas Zoom Phone](https://developers.zoom.us/docs/api/references/phone-calling-plans/), ou retornados como `tipo` pela [Listar planos de tarifação de chamadas](https://developers.zoom.us/docs/api/references/phone-calling-plans/) API juntamente com as contagens de licenças disponíveis. |
| `zoomPhoneCallingPlanSubscription` (somente contas com várias assinaturas) | A assinatura específica da qual o plano deve ser obtido, quando a conta possui mais de uma assinatura para o mesmo plano.                                                             | Planos e Faturamento → gerenciamento de assinaturas.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

**O conjunto de ramais é compartilhado entre tipos de objeto, não apenas entre usuários.** Filas de chamadas, recepcionistas automáticos, grupos de linha compartilhada e telefones de área comum consomem ramais da mesma faixa. Esta é a causa mais frequente de falhas de "ramal já em uso", pois o ramal parece disponível quando um administrador verifica apenas a lista de usuários.

**Um número portado não pode ser atribuído até que a portabilidade seja concluída.** O número deve estar presente na conta e não atribuído; iniciar uma portabilidade não satisfaz nenhuma das condições.

**As unidades são o bloqueio mais comum** porque criá-las envolve requisitos próprios. Os endereços das unidades são validados em relação a um banco de dados de endereços reais porque servem de base para serviços de chamada de emergência — combinações inventadas de endereço e código postal são rejeitadas com um erro de validação. Ao importar unidades em massa, a coluna Recepcionista automático espera o valor `Sim` em vez do texto do rótulo mostrado na interface, e nome da ID do chamador aplica-se principalmente aos EUA e Canadá e pode ser deixado em branco se causar uma falha de validação.

#### <mark style="color:azul;">Zoom central de contato</mark>

O provisionamento da central de contato é orientado por Função e por modelo. Os atributos individuais devem corresponder a objetos existentes da central de contato, e o modelo carrega as Configurações que não têm um atributo SCIM dedicado próprio.

| Atributo                               | O que já deve existir                                                                                                                                        | Como criá-lo                                                                                                                                                                                                                                                                                                                                   |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `zoomContactCenterPackage`             | O Pacote — `Essenciais`, `Premium`, ou `Elite` — comprado com lugares não utilizados.                                                                        | Comprar com antecedência; o Premium pode exigir entrar em contato com o Suporte do Zoom para comprar pacotes adicionais primeiro. Ver [Alterando as Configurações do usuário do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060874).                                                          |
| `zoomContactCenterAddonsPlan`          | O plano add-on, adquirido e com capacidade.                                                                                                                  | Comprar com antecedência; plano da conta e Informações de faturamento.                                                                                                                                                                                                                                                                         |
| `zoomContactCenterRole`                | A Função, padrão ou personalizada, nomeada exatamente. Se omitida, atribui a Função Agente padrão, que existe por padrão.                                    | Gerenciamento da central de contato → Funções → **Adicionar** → Configurar permissões → **Salvar**. Consulte [Gerenciando as Funções do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0061941).                                                                                                  |
| `região do Zoom da central de contato` | A região. Se omitida, atribui a região principal da conta, que deve ser configurada.                                                                         | Gerenciamento da central de contato → Preferências → Regiões → **Adicionar Região** → Inserir um nome e Selecionar uma zona SIP → **Adicionar**. Consulte [Gerenciando regiões do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0057668).                                                        |
| `zoomContactCenterUserTemplate`        | O modelo de usuário, nomeado exatamente. Os modelos do tipo Adicionar aplicam-se na criação do usuário; os modelos do tipo Update aplicam-se na atualização. | Gerenciamento da central de contato → Usuários → Modelos → **Adicionar Modelo** → Escolher **Adicionar** → Configurar funções, pacotes, filas e habilidades → **Adicionar**. Consulte [Gerenciando modelo de Configurações do usuário do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0077757). |

{% hint style="danger" %}
**Aviso**

Os Recursos de regiões da central de contato devem ser ativados pelo Suporte do Zoom antes que as regiões possam ser criadas, e cada usuário pertence exatamente a uma região. Como se trata de um pedido de Suporte, e não de uma Alternar de autoatendimento, sinalize isso cedo se uma implantação multirregião estiver planejada.
{% endhint %}

**Caixas de entrada, filas e habilidades não têm atributo SCIM.** Para provisioná-los, crie-os previamente em Gestão da central de contato, anexe-os a um modelo de usuário e Atribuir esse modelo por meio de `zoomContactCenterUserTemplate`. Portanto, tornam-se pré-requisitos do *modelo* em vez do usuário individual — o que também faz do modelo o único objeto a manter à medida que esses requisitos Alterar.

<table><thead><tr><th width="123.2821044921875">Objeto</th><th>Como criá-lo</th></tr></thead><tbody><tr><td>Fila</td><td>Gestão da central de contato → Filas → <strong>Adicionar fila</strong> → nome, canal, agentes → <strong>Salvar</strong>. Consulte <a href="https://support.zoom.com/hc/en/article?id=zm_kb&#x26;sysparm_article=KB0061959">Gerenciando filas do Zoom central de contato</a>.</td></tr><tr><td>Habilidade</td><td>Gerenciamento da central de contato → Habilidades → Selecionar uma categoria → <strong>Adicionar Habilidade</strong> → nome → <strong>Adicionar</strong>. Consulte <a href="https://support.zoom.com/hc/en/article?id=zm_kb&#x26;sysparm_article=KB0059519">Gerenciando habilidades e categorias de habilidades</a>.</td></tr><tr><td>Caixa de entrada</td><td>Gerenciamento da central de contato → Caixa de entrada → <strong>Adicionar Caixa de entrada</strong>. Consulte <a href="https://support.zoom.com/hc/en/article?id=zm_kb&#x26;sysparm_article=KB0059471">Gerenciando as caixas de entrada do Zoom central de contato</a>.</td></tr></tbody></table>

**Quando um modelo e atributos individuais são fornecidos, os valores individuais prevalecem.** Enviar um modelo juntamente com `zoomContactCenterRole` significa que o atributo Função substitui a configuração de Função do modelo, portanto, tanto a Função referenciada quanto o modelo devem existir.

#### <mark style="color:azul;">Zoom Revenue Accelerator</mark>

| Atributo                                                            | O que já deve existir                                                                     | Como criá-lo                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `zoomRevenueAcceleratorPlan` e `zoomRevenueAcceleratorSubscription` | O plano ou assinatura ZRA adquiridos com um assento disponível.                           | Comprar com antecedência; plano da conta e Informações de faturamento.                                                                                                                                                                                                                                                               |
| `zoomRevenueAcceleratorRole`                                        | A Função, padrão ou personalizado — por exemplo `Gerente de Vendas` — nomeado exatamente. | Gerenciamento de usuário → Funções → **Acelerador de Receita** aba → **+ Adicionar Função** → nome e descrição → **Adicionar** → Configurar permissões → **Salvar alterações**. Consulte [Usando o Gerenciamento de função do Zoom Revenue Accelerator](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0059285). |
| `zoomRevenueAcceleratorSegment`                                     | O segmento ao qual o usuário pertence.                                                    | Configurações de administrador do Revenue Accelerator.                                                                                                                                                                                                                                                                               |
| `zoomRevenueAcceleratorRegion`                                      | A região — por exemplo, `US`.                                                             | Configurações de administrador do Revenue Accelerator.                                                                                                                                                                                                                                                                               |

#### <mark style="color:azul;">licenças do Zoom Workplace e funções da conta</mark>

Além dos três produtos acima, o registro de usuário padrão contém referências de Função e licença que seguem a mesma regra.

| Atributo                                                                                                                                                                                                                                                                                | O que já deve existir                                                                                 | Como criá-lo                                                                                                                                                                                                             |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Funções[]` (`valor` / `Exibir`)                                                                                                                                                                                                                                                        | A Função da conta, nomeada exatamente. As Funções são referenciadas pelo SCIM, nunca criadas por ele. | Gerenciamento de usuário → Funções → **Adicionar Função** → nome e descrição → Configurar permissões. Veja [Usando Gerenciamento de função](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064983). |
| `zoomWorkplace` e outros atributos de licença ou add-on — quadro de compartilhamento, Scheduler, Clips Plus, legendas traduzidas, Workforce Management (WFM), Gestão de qualidade, Gestão de conformidade, Insights de CX, Assistente de Vendas de IA, e suas `...Assinatura` homólogos | O pacote correspondente ou add-on, comprado com lugares não utilizados.                               | Planos e Faturamento → Gerenciamento de Planos → edite o plano → aumente o número de licenças. Veja [Atualizando sua conta e complementos](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063375).  |
| `tipoDeLogin` (`SSO` / `email de trabalho`), sob `urn:us:zoom:scim:schemas:extension:1.0:Zoomusuário`                                                                                                                                                                                   | SSO configurado na conta, para o tipo de login SSO.                                                   | Avançado → [logon único](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064121).                                                                                                                    |

Para um atributo de licença ou add-on, não há um objeto para nomear, mas a condição prévia é idêntica em efeito: sem um assento Disponível nesse pool específico, a atribuição falha.

#### <mark style="color:azul;">Atributos sem pré-condição</mark>

Cada atributo básico de mapeamento se qualifica, conforme abordado em **Mapeamento básico: informações de perfil** — O Zoom armazena esses valores literalmente e nunca os valida em relação a um objeto existente. Dois atributos sob a extensão Zoom se comportam da mesma maneira:

* **Valores autodelegados** — `zoomPhoneExtNumber` enviado como `0`, em que o Zoom atribui a extensão por si mesmo.
* **Atributos personalizados da conta** — o `{customAttribute}` campo, que contém qualquer string que você enviar.

**Referências predefinidas** são um caso intermédio: omitir `zoomPhoneSite`, `zoomContactCenterRole`, ou `região do Zoom da central de contato` retorna para a unidade principal, a Função de Agente padrão e a região principal, respectivamente. Esses valores padrão devem existir por si mesmos, e eles existem por padrão.

**Os grupos são uma exceção parcial.** Quando o provisionamento de grupo está habilitado, o SCIM criará um grupo do Zoom que ainda não existe, usando o nome do grupo de origem exatamente como foi digitado. Ele não aplica nenhuma configuração de produto a esse grupo — o grupo chega com membros e nada mais. As políticas do Zoom Phone, as permissões de chamadas e outras Configurações no nível do grupo ainda devem ser configuradas em Gerenciamento de usuário → Gerenciamento de grupo depois que o grupo aparecer.

{% hint style="info" %}
**Recomendação**

Trate a implementação do lado do Zoom como uma fase pré-requisito com sua própria aprovação, concluída e verificada antes que o trabalho de mapeamento de atributos comece. Unidades, números, planos, Funções e modelos são frequentemente de responsabilidade de uma equipe diferente da configuração do provedor de identidade, e descobrir um objeto ausente durante os testes de provisionamento custa consideravelmente mais do que confirmar sua existência antes.
{% endhint %}

### **Preparando os dados do seu diretório**

O SCIM transmite tudo o que a origem contém. Ele não valida, normaliza nem corrige. Antes de mapear qualquer atributo, confirme três coisas sobre a origem pretendida:

* **Ele está preenchido para cada usuário no escopo.** Um campo não preenchido não envia nada, ou envia o padrão configurado.
* **Seus valores são consistentes em formato e capitalização.** A lógica de comparação em ambos os provedores de identidade é exata.
* **Seus valores correspondem exatamente aos valores esperados do Zoom.** O Zoom não faz correspondência aproximada de nomes de unidade, nomes de Função ou valores de plano.

Quando um campo existente não consegue satisfazer todas as três condições, um atributo feito sob medida, preenchido deliberadamente para esta Integrações, é mais sustentável do que reaproveitar um campo que outros sistemas também gravam.

{% hint style="info" %}
**Recomendação**

Decida a fonte de verdade antes de tocar na configuração do provedor de identidade. A maioria das implantações SCIM com falha são problemas de dados de diretório apresentados como problemas de provisionamento.
{% endhint %}

### **Cenários de referência**

Quatro cenários são usados ao longo deste guia. Seus requisitos de negócio e os pré-requisitos do lado do Zoom são idênticos independentemente do provedor de identidade, portanto são definidos uma vez aqui. Cada seção específica do provedor de identidade termina mostrando como implementar os quatro nessa plataforma.

#### <mark style="color:azul;">Cenário 0: Departamento, como um primeiro mapeamento básico</mark>

O departamento de um usuário deve aparecer no perfil do Zoom, tendo como origem o diretório. Este é o mapeamento básico recomendado anteriormente como um primeiro teste ponta a ponta, e ele é incluído aqui para que o procedimento seja percorrido nas duas seções do provedor de identidade.

**Pré-requisito do lado do Zoom.** Nenhum. O Zoom armazena o valor exatamente como enviado e nunca o valida em relação a um objeto existente.

**Atributo.** Observe que o pai difere dos três cenários abaixo — `departamento` fica na extensão empresarial, não na extensão Zoom.

| Atributo                                                                      | Tipo   | Notas                                                                                                                                                        |
| ----------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:departamento` | string | Texto livre. Ambos os provedores de identidade já contêm um `departamento` campo no perfil do usuário, portanto nenhum novo atributo de origem é necessário. |

**Por que começar aqui.** Um valor de departamento aparecendo corretamente em um perfil do Zoom comprova a declaração de esquema, o mapeamento, o escopo e sua capacidade de ler os logs de provisionamento — sem colocar uma licença ou uma configuração de telefone em risco. Cada cenário avançado abaixo difere apenas no que o atributo aponta.

**Verifique primeiro se já está mapeado.** Os mapeamentos padrão diferem entre o Entra ID e o Okta, e eles sofrem Alterar à medida que ambos os fornecedores atualizam as suas integrações com o Zoom. Reveja a lista existente em **Provisionamento** → **Mapeamentos** no Entra, ou **Mapeamentos de Atributos do Zoom** com **Mostrar Atributos Não Mapeados** ativado no Okta. Se `departamento` já estiver mapeado, verifique-o em vez de declarar uma duplicata — e, se você quiser Configurar um atributo do zero em vez disso, `centro de custo`, `Organização`, e `employeeNumber` estão sob o mesmo pai e comportam-se de forma idêntica.

#### <mark style="color:azul;">Cenário 1: unidade do Zoom Phone e atribuição automática de número do ramal</mark>

Os utilizadores devem ser colocados na unidade correta do Zoom Phone com base no seu escritório e receber um número do ramal sem intervenção administrativa.

**Pré-requisito do lado do Zoom** As unidades já devem existir. Crie-as em **Centro do administrador** → **Configuração do produto** → **sistema de telefonia** → **Informações da empresa** → **Adicionar unidade**, ou em massa por meio de **Importar**. Os endereços da unidade são validados em relação a um banco de dados de endereços do mundo real porque dão suporte a serviços de chamada de emergência, então combinações fictícias de endereço e código postal falharão na validação.

**Atributos.** Ambos usam o namespace `urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:` seguido pelo nome.

| Atributo             | Tipo   | Notas                                                             |
| -------------------- | ------ | ----------------------------------------------------------------- |
| `zoomPhoneSite`      | string | Deve corresponder ao nome da unidade Zoom caractere por caractere |
| `zoomPhoneExtNumber` | string | `0` aciona a atribuição automática                                |

**Por que o valor `0` é importante.** O Zoom é o único sistema que sabe quais ramais já estão em uso — incluindo ramais atribuídos a filas de ligar e recepcionistas automáticos em vez de a usuários. Delegar a atribuição ao Zoom remove uma categoria inteira de falha de provisionamento. Obter ramais do diretório em vez disso é apropriado durante uma migração, em que preservar os números de ramal existentes é importante, mas o mapeamento deve mudar para `0` assim que a migração for concluída, para que os futuros participantes não dependam de os dados do diretório serem mantidos indefinidamente.

{% hint style="info" %}
**Nota**

A unidade padrão em uma conta do Zoom Phone normalmente tem exatamente o nome `Unidade Principal`, visível em **Centro do administrador** → **Configuração do produto** → **sistema de telefonia** → **Informações da empresa**. Confirme o nome na conta específica antes de confiar nele, pois ele pode ser renomeado.
{% endhint %}

#### <mark style="color:azul;">Cenário 2: Plano de tarifação de chamadas do Zoom Phone variando por país</mark>

Uma Organização multinacional adquiriu Planos de tarifação de chamadas independentes do Zoom Phone e precisa que cada usuário receba o plano correspondente ao seu país.

**Pré-requisito do lado do Zoom.** Os Planos de tarifação de chamadas já devem ter sido adquiridos e estar Disponível na conta. Os valores dos planos estão documentados em [Referência do Plano de tarifação de chamadas Zoom Phone](https://developers.zoom.us/docs/api/references/phone-calling-plans/).

**Atributo.** `zoomPhoneCallingPlan` (string).

**Como obter o código de plano correto.** `zoomPhoneCallingPlan` usa o código numérico do plano, não o nome de um plano. A forma mais fiável de o obter é a [Listar planos de tarifação de chamadas](https://developers.zoom.us/docs/api/references/phone-calling-plans/) API, que devolve o `nome`, o seu `tipo` — o código que você mapeia — e o seu `subscritas e` e `Disponível` contagens de lugares. Uma chamada (ligar), portanto, confirma que o plano existe, fornece o valor a enviar e verifica se há capacidade para Atribuir-lo.

O Portal web do Zoom mostra apenas nomes de Exibir, nunca códigos, por isso um administrador a trabalhar apenas no portal tem de traduzir o nome de Exibir usando a [Referência do Plano de tarifação de chamadas Zoom Phone](https://developers.zoom.us/docs/api/references/phone-calling-plans/) — onde, por exemplo, `UNLIMITED_PLAN_US_CA` é `200` e `UNLIMITED_PLAN_GB_IE` é `202`. A lista de referência mostra nomes de constantes em vez da redação do portal, portanto confirme a correspondência com as características do plano — região e medido versus ilimitado — e não com o texto exato.

Separadamente, a referência da API SCIM2 do Zoom mostra um nome de plano de faturamento como `phone_calling_usca_monthly_unlimited` em sua carga útil de exemplo. Esse identificador é usado para *comprar* uma assinatura, não para Atribuir um plano a um usuário. Se você precisar especificar de qual assinatura um plano se origina, isso pertence em `zoomPhoneCallingPlanSubscription`.

**Por quê `-1` é usado como fallback.** Os documentos de referência do SCIM2 `-1` como o valor que remove todos os planos de chamadas. Usá-lo para usuários sem correspondência produz um resultado determinístico e visível — nenhum plano atribuído — em vez da ambiguidade de não enviar nenhum valor. Também oferece uma forma limpa de desprovisionar permissões de chamadas sem excluir o usuário.

#### <mark style="color:azul;">Cenário 3: Pacote, Função e região do Zoom central de contato</mark>

Os agentes da central de contato devem ser provisionados com o Pacote e a Função corretos do ZCC no momento da Integração, em vez de configurados manualmente depois. Este cenário demonstra que o método é independente do produto — nada no procedimento muda, apenas os nomes dos atributos e os valores permitidos.

| Atributo                               | Tipo   | Valores permitidos                                                                           |
| -------------------------------------- | ------ | -------------------------------------------------------------------------------------------- |
| `zoomContactCenterPackage`             | string | `Essenciais`, `Premium`, `Elite`                                                             |
| `zoomContactCenterRole`                | string | Qualquer nome de Função do ZCC. O padrão é `Agente` se omitido.                              |
| `região do Zoom da central de contato` | string | Qualquer região ZCC configurada. Se for omitida, assume a região principal por predefinição. |

**Ao omitir atributos deliberadamente.** Sair/sair `região do Zoom da central de contato` não mapeado em implantações de região única, onde o padrão documentado do Zoom já está correto. Omitir um atributo cujo padrão está certo é preferível a mapeá-lo — cada mapeamento é uma obrigação de manutenção.

**Nota operacional.** A referência SCIM2 também documenta `zoomContactCenterUserTemplate`, que aplica um modelo ZCC pré-construído. Os modelos do tipo Adicionar aplicam-se na criação do usuário e os modelos do tipo atualização na atualização; quando tanto um modelo quanto valores individuais de atributos são fornecidos na mesma solicitação, os valores individuais têm prioridade. Vale a pena considerar modelos quando a configuração ZCC é complexa o suficiente para que mantê-la em muitos mapeamentos individuais de atributos se torne difícil de gerir.

### **Verificação do lado do Zoom e erros comuns**

Cada provedor de identidade tem o seu próprio registo, abordado no Passo 6 de cada provedor de identidade. O registo do lado do Zoom abaixo é idêntico para ambos e é o gravar definitivo do que o Zoom realmente recebeu.

#### <mark style="color:azul;">Zoom App Marketplace registros de ligar Mostrar a troca completa de solicitação e resposta</mark>

1. Iniciar sessão no Portal web do Zoom como o proprietário da conta.
2. Navegue até o [**Zoom App Marketplace**](https://marketplace.zoom.us/) → **Gerir** → **Apps na conta**.
3. Selecionar o aplicativo que representa a conexão do provedor de identidade. Para Entra, isso normalmente é chamado de **Identidade do Azure** ou semelhante.
4. Abra o **Registos de ligar** aba.
5. Use **Pesquisar por pontos de extremidade**, ou os filtros de intervalo de datas, método e status, para localizar o ligar relevante.
6. Selecionar a linha para expandi-la.
7. Revisar `requestBody` para ver exatamente o que foi enviado, e `resposta` para ver exatamente o que o Zoom retornou, incluindo o ID de usuário do Zoom gerado, `httpStatus`, e o conjunto de atributos resultante.

O Zoom mantém os 100 registos de pedidos de API mais recentes, por isso investigue uma falha prontamente, em vez de depois de mais atividade de provisionamento a ter substituído.

#### <mark style="color:azul;">Erros comuns de provisionamento e as suas causas</mark>

<table><thead><tr><th width="99.69622802734375">Código</th><th>Mensagem</th><th>Causa e resolução</th></tr></thead><tbody><tr><td>400</td><td>A conta não conseguiu Habilitar o logon único.</td><td>O SSO é um pré-requisito para SCIM. Primeiro, Habilitar e Configurar o SSO na conta Zoom.</td></tr><tr><td>400</td><td>O usuário está inativo ou bloqueado.</td><td>O usuário Zoom de destino não pode ser atualizado no seu estado atual. Resolva o estado da conta no Portal web do Zoom.</td></tr><tr><td>403</td><td>A solicitação foi negada devido a permissões insuficientes: "Usuário:Editar".</td><td>As credenciais por trás da conexão SCIM não têm o escopo necessário. Reautorize a conexão com uma conta de Proprietário ou de administrador.</td></tr><tr><td>404</td><td>O usuário não existe.</td><td>O provedor de identidade não correlacionou o usuário a um usuário Zoom existente. Verifique o atributo de correspondência e o formato do Nome de usuário.</td></tr><tr><td>409</td><td>O domínio de e-mail não corresponde ao domínio associado da conta.</td><td>O domínio de e-mail do usuário não está associado à conta Zoom. Associe e verifique o domínio antes do provisionamento.</td></tr><tr><td>409</td><td>Não é possível adicionar usuários pagos.</td><td>Não há licença do tipo solicitado disponível. Libere capacidade na conta ou provisione o usuário como básico.</td></tr><tr><td>409</td><td>Não é possível criar mais usuários com [nome do pacote].</td><td>O pacote específico não tem assentos restantes. Aplica-se a Workplace Corporativo Plus, empresarial Premier, Pro Plus e aos equivalentes de Educação.</td></tr><tr><td>429</td><td>Muitas solicitações.</td><td>O provisionamento excedeu os limites de taxa do Zoom. Investigue se isso persistir entre os ciclos.</td></tr></tbody></table>

#### <mark style="color:azul;">Um modo de falha não produz nenhum erro</mark>

Um valor que o Zoom aceita, mas que não corresponde a nada — um nome de unidade com um espaço à direita, ou um nome de Função que foi renomeado no Zoom — pode ser aceito sintaticamente e não ser aplicado a nada. Nenhuma entrada de log sinaliza essa ocorrência. Variantes específicas da plataforma do mesmo problema são tratadas na Etapa 6.

{% hint style="info" %}
**Nota**

Quando o Zoom e o provedor de identidade discordarem sobre a configuração de um usuário, trate o provedor de identidade como autoridade e corrija o valor lá. Editar diretamente no Portal web do Zoom produz um estado que o próximo evento de provisionamento sobrescreve, o que torna o problema subjacente mais difícil de diagnosticar.
{% endhint %}

## **Configurando SCIM com o Entra ID**

#### <mark style="color:azul;">Requisitos adicionais para o Entra ID</mark>

* Privilégios de administrador do Entra ID com acesso a Aplicativos empresariais
* O domínio de e-mail usado pelos seus usuários verificado como um domínio personalizado no locatário do Entra ID

#### <mark style="color:azul;">Limitações adicionais no Entra ID</mark>

* Os mapeamentos de atributos têm origem exclusivamente no Entra *objeto de usuário* atributos. Os grupos de segurança não podem fornecer diretamente um valor para um atributo do Zoom; a associação ao grupo controla o escopo, não o valor.
* Os ciclos incrementais de provisionamento são executados aproximadamente a cada 40 minutos. As alterações não são instantâneas depois que o provisionamento é habilitado.
* O `Colaboração` valor de `tipoDeUtilizador` não é suportado com o Entra ID devido a uma limitação específica da Microsoft.

{% hint style="info" %}
**Nota**

A configuração padrão de provisionamento pode ser realizada a partir de qualquer um dos `entra.microsoft.com` ou `portal.azure.com`. O editor de esquema usado na Etapa 1, no entanto, só pode ser acessado pela URL do Portal do Azure com o `forceSchemaEditorEnabled` parâmetro anexado. Essa sinalização não tem efeito em `entra.microsoft.com`. Use o link do Portal do Azure na Etapa 1 para todas as etapas desta parte para evitar alternar entre portais no meio da configuração.
{% endhint %}

### Etapa 1: Declarar o atributo no esquema do aplicativo Zoom

Declarar um atributo é uma ação única por atributo. Declare todos os atributos que você pretende usar antes de configurar quaisquer mapeamentos, para que todos os destinos estejam disponíveis na Etapa 2.

1. Inicie sessão no Portal do Azure usando a URL do editor de esquema: `https://portal.azure.com/?Microsoft_AAD_Connect_Provisioning_forceSchemaEditorEnabled=true#home`
2. Em **Serviços do Azure**, Selecionar **Microsoft Entra ID**.
3. No menu de navegação à esquerda, em **Gerir**, clique em **Aplicativos empresariais**.
4. Na lista de aplicativos, clique no seu aplicativo Zoom.\
   **Nota**: O nome do aplicativo é definido pelo administrador do Entra quando o aplicativo é criado. Ele frequentemente é chamado de **Zoom** ou **Zoom SSO**, mas pode ser diferente no seu locatário.
5. No menu de navegação à esquerda, em **Gerir**, clique em **Provisionamento**.\
   **Nota**: Atualmente, o Azure apresenta um de dois layouts. Na experiência legada, Selecionar **Editar mapeamentos de atributos** em **Gerenciar provisionamento**. Na experiência mais recente, a página abre em uma **Visão geral** aba; Selecionar **Provisionamento** novamente no menu à esquerda. Ambos os caminhos chegam ao mesmo destino.
6. Clique no **Mapeamentos** menu suspenso, depois clique em **Provisionar usuários do Microsoft Entra ID**.\
   **Nota**: Em locatários que ainda exibem a nomenclatura legada, esta opção aparece como **Provisionar usuários do Active Directory do Azure**.
7. No canto inferior esquerdo, Selecionar o **Mostrar opções avançadas** caixa de seleção.
8. Clique **Editar lista de atributos para Zoom**.
9. Desloque-se até à primeira linha vazia e preencha o seguinte:
   * **Nome**: Inserir a string completa do atributo, por exemplo `urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomPhoneSite`
   * **Tipo**: Selecionar **Cadeia de caracteres** ou **Booleano**, correspondendo ao tipo de dados documentado na referência da API SCIM2.
10. Repita o passo 9 para cada atributo adicional.
11. No canto superior esquerdo, clique **Salvar**.

{% hint style="warning" %}
**Aviso**

Os nomes dos atributos diferenciam maiúsculas de minúsculas e devem corresponder exatamente à referência da API. `zoomPhoneSite` é válido; `zoomphonesite` e `ZoomPhoneSite` não são. Um atributo com capitalização incorreta é aceito pelo editor de esquema sem erro e falha silenciosamente na API do Zoom.

Para atributos documentados como `booleano`, **Cadeia de caracteres** também é válido, desde que a origem mapeada forneça o texto literal `true` ou `false`. Selecionar **Cadeia de caracteres** é frequentemente mais prático quando a origem é um atributo de extensão do Entra, que armazena texto.
{% endhint %}

### Passo 2: Mapeie uma origem de diretório para o atributo

O Entra ID oferece três tipos de mapeamento, e a escolha entre eles é a decisão mais importante na configuração.

<table><thead><tr><th width="133.376708984375">Tipo de mapeamento</th><th>Usar quando</th><th>Comportamento</th></tr></thead><tbody><tr><td><strong>Direto</strong></td><td>Um campo do Entra já contém o valor exato que o Zoom espera.</td><td>Passa o valor de origem sem alterações.</td></tr><tr><td><strong>Constante</strong></td><td>Todo usuário no escopo deve receber o mesmo valor.</td><td>Envia um valor fixo para cada usuário provisionado.</td></tr><tr><td><strong>Expressão</strong></td><td>O valor deve ser derivado, traduzido ou variar de acordo com o atributo do usuário.</td><td>Avalia uma expressão em relação aos campos de origem e envia o resultado.</td></tr></tbody></table>

**Para criar o mapeamento:**

1. Regresse a **Provisionamento** → **Mapeamentos** → **Provisionar usuários do Microsoft Entra ID**.
2. No canto inferior esquerdo, clique em **Adicionar novo mapeamento**.
3. Configurar o mapeamento de acordo com o tipo selecionado — consulte as orientações abaixo.
4. Clique no **Atributo de destino** lista pendente e Selecionar o atributo declarado no Passo 1.
5. Clique no **Corresponder objetos utilizando este atributo** lista pendente e Selecionar **Não**.\
   **Nota**: Os atributos personalizados do Zoom são valores de configuração, não chaves de correspondência de identidade. Apenas o atributo que correlaciona usuários do Entra com usuários do Zoom — normalmente `Nome de usuário` — deve ser definido como **Sim**.
6. Clique no **Aplicar este mapeamento** lista pendente e Selecionar **Sempre**, para que o valor seja aplicado tanto na criação como nas atualizações subsequentes.
7. Clique **OK**.
8. Repita para cada atributo e, em seguida, clique em **Salvar** na parte superior da página de **Mapeamento de atributos** página.

#### <mark style="color:azul;">O mapeamento direto transmite um campo existente sem transformação</mark>

* **Tipo de mapeamento**: **Direto**
* **Atributo de origem**: Um campo do Entra cujo valor já corresponde exatamente ao que o Zoom espera, caráter por caráter
* **Valor padrão se for nulo (Opcional)**: Um valor alternativo aplicado quando o campo de origem está vazio

O mapeamento direto é a opção menos frágil e deve ser preferido sempre que os dados do diretório o permitirem. Se `physicalDeliveryOfficeName` — apresentado como **Localização do escritório** no perfil de usuário do Entra — já contiver valores que correspondem exatamente aos nomes das unidades do Zoom Phone, mapeá-lo diretamente não requer qualquer lógica.

{% hint style="info" icon="lightbulb" %}
**Dica**

Preencha **Valor padrão se for nulo** sempre que um valor de origem em falta pudesse causar uma falha ou um resultado não pretendido. Um padrão de `Unidade Principal` num mapeamento de unidade garante que os usuários sem uma localização de escritório sejam ainda assim aprovisionados com êxito, em vez de ficarem num estado indefinido.
{% endhint %}

#### <mark style="color:azul;">O mapeamento constante aplica um valor a toda a população no âmbito</mark>

* **Tipo de mapeamento**: **Constante**
* **Valor constante**: O valor fixo a enviar

O mapeamento constante é adequado para implementações de configuração única e é também o mecanismo por trás de vários comportamentos específicos do Zoom. Definir `zoomPhoneExtNumber` como uma constante de `0` instrui o Zoom a Atribuir a próxima extensão Disponível na unidade do usuário, eliminando totalmente as colisões de extensões.

#### <mark style="color:azul;">O mapeamento de expressão traduz ou deriva um valor no momento do aprovisionamento</mark>

* **Tipo de mapeamento**: **Expressão**
* **Expressão**: Uma instrução `IIF()` aninhada que avalia um ou mais atributos de origem

O mapeamento de expressão é necessário sempre que o valor do diretório e o valor do Zoom não são a mesma cadeia de carateres:

```
IIF([officeLocation]="London","LON-01",
IIF([officeLocation]="Manchester","MAN-01",
"Unidade principal"))
```

{% hint style="danger" %}
**Aviso**

As expressões comparam o texto exatamente como digitado, incluindo maiúsculas e minúsculas. `GB` e `gb` são valores diferentes, assim como `Reino Unido` e `reino unido`. Uma comparação que falha não gera erro — ela segue para o ramo padrão, e o usuário é provisionado silenciosamente com a configuração errada.
{% endhint %}

Envolva os valores de origem em `ToUpper()` e compare com literais em maiúsculas para neutralizar inconsistências de caixa:

```
IIF(ToUpper([country])="GB","202",
IIF(ToUpper([country])="UNITED KINGDOM","202",
"-1"))
```

#### <mark style="color:azul;">O formato do campo de origem varia conforme o modo como o usuário do Entra foi criado</mark>

Esta é a causa mais comum de mapeamentos de expressões que parecem corretos, mas se comportam de forma inconsistente em uma população.

* **Localização de uso** é imposto pela Microsoft para conter sempre um código ISO 3166-1 alfa-2 válido, como `GB`, porque controla a disponibilidade de licença e de Recursos. Este campo é confiável.
* **País ou região** não sofre essa imposição, e seu conteúdo depende do método de criação. Usuários criados por meio da interface gráfica do portal de administração do Entra selecionam em uma lista suspensa de nomes completos de países, portanto o campo normalmente armazena `Reino Unido`. Usuários criados por importação de CSV ou PowerShell normalmente são preenchidos com `GB` — por convenção, não por imposição.

Em qualquer locatário em que os usuários tenham sido criados por mais de um método, `país` não terá um formato consistente. Padronize o campo antes de construir a expressão ou teste explicitamente ambos os formatos, como mostrado acima.

### Etapa 3: Traga usuários e grupos para o escopo de provisionamento

A atribuição determina quais usuários a configuração afeta. Usuários fora do escopo de atribuição do aplicativo nunca são afetados por nenhum mapeamento, o que torna a atribuição o principal controle de segurança durante a implementação.

1. Navegue até **Microsoft Entra ID** → **Aplicativos empresariais** → seu aplicativo Zoom → **Usuários e grupos**.
2. Clique **Adicionar usuário/grupo**.
3. Em **Usuários e grupos**, selecione o usuário ou grupo de segurança pretendido.
4. Em **Selecione uma função**, escolha a função apropriada.
5. Clique **Atribuir**.

Na prática, apenas dois valores de função importam. Outras opções, como **Corp** e **Pro** são nomes legados que estão sendo descontinuados ou destinados a cenários incomuns.

<table><thead><tr><th width="157.5225830078125">Função</th><th>Efeito</th></tr></thead><tbody><tr><td><strong>básico</strong></td><td>Provisiona o usuário sem uma licença paga de reunião. Selecione isto quando um atributo personalizado — como um Plano de tarifação de chamadas do Zoom Phone — for responsável por atribuir o direito pago.</td></tr><tr><td><strong>Licenciado</strong></td><td>Atribui o plano de licença da conta Zoom <em>padrão</em> por exemplo, Zoom Workplace empresarial Plus. Esta tela não permite que um pacote específico seja escolhido; o padrão é configurado do lado do Zoom.</td></tr></tbody></table>

Esta seleção de função se aplica uma vez por usuário ou grupo adicionado ao aplicativo, independentemente de quantos atributos personalizados estejam sendo provisionados.

**Para provisionar grupos do Entra como grupos do Zoom**, o que está desativado por padrão:

1. Navegue até **Provisionamento** → **Mapeamentos** e selecione **Provisionar grupos do Microsoft Entra ID**.
2. Alternar **Ativado** para **Sim**.
3. Confirme que os mapeamentos padrão estão em vigor: `displayName` → `displayName`, e `membros` → `membros`.
4. Clique **Salvar**.
5. Regresse a **Usuários e grupos** e confirme que o próprio grupo está atribuído ao aplicativo, não apenas os seus membros individuais. O provisionamento de grupos processa apenas grupos atribuídos diretamente.

{% hint style="warning" %}
**Atenção: O que o SCIM faz e não faz com grupos**

Se ainda não existir um grupo Zoom com um nome correspondente, o SCIM cria um usando o grupo do Entra `displayName` exatamente como digitado. O grupo é criado com membros, mas **sem qualquer configuração do produto**. Um administrador ainda deve abrir **Gerenciamento de usuário** → **Gerenciamento de grupo** no Portal web do Zoom e aplicar as Configurações pretendidas — políticas do Zoom Phone em nível de grupo, permissões de chamada ou outra configuração do produto. O SCIM provisiona a existência e os membros de um grupo; ele não define o que esse grupo faz dentro do Zoom.
{% endhint %}

### Etapa 4: Validar com Provision on Demand

**Provision on Demand** é executado independentemente do **Status de provisionamento** Alternar, que é exatamente por isso que ele é a ferramenta correta para validação. Cada etapa até este ponto — inclusive esta — pode ser concluída enquanto o provisionamento permanece desativado.

1. Navegue até **Provisionamento** → **Visão geral do provisionamento**.
2. Clique **Provision on Demand**.
3. Pesquise e Selecione um único usuário de teste, depois clique **Provisionar**.
4. Revise o resultado. O Entra informa as quatro etapas que executa para cada Evento de provisionamento — **Importar**, **Determinar se está no escopo**, **Corresponder**, e **Provisionar** — cada um expansível individualmente.
5. Confirme que os valores dos atributos mostrados correspondem à sua intenção.
6. Iniciar sessão no Portal web do Zoom e confirme que a configuração foi aplicada.

{% hint style="info" %}
**Recomendação**

Valide com um usuário que represente o *mais difícil* caso em sua população — um usuário no exterior, um usuário criado por um método diferente, ou um usuário cujo campo de origem está vazio. Um teste que cubra apenas o caso direto não revelará os modos de falha descritos na Etapa 2.
{% endhint %}

### Etapa 5: Habilitar o provisionamento contínuo

Habilitar o provisionamento coloca a configuração em vigor para cada usuário no escopo. Conclua e verifique as Etapas 1 a 4 primeiro.

1. Navegue até **Microsoft Entra ID** → **Aplicativos empresariais** → seu aplicativo Zoom → **Provisionamento** → **Provisionamento**.
2. Alternar **Status de provisionamento** para **Ligado**.
3. Clique **Salvar**.

O primeiro ciclo pode levar até aproximadamente 40 minutos. Os ciclos incrementais subsequentes são executados em intervalos de cerca de 40 minutos. Novos ingressantes, alterações de atributos e desativações sincronizam-se conforme esse Agendar, e não imediatamente.

### Etapa 6: Verificar usando os logs de provisionamento do Entra

1. Navegue até **Microsoft Entra ID** → **Aplicativos empresariais** → seu aplicativo Zoom → **Monitorar** → **Logs de provisionamento**.
2. Pesquise ou filtre o usuário de teste e, em seguida, Selecionar o Evento relevante. A visualização de detalhes é aberta com quatro abas: **Etapas**, **Resolução de problemas e recomendações**, **Propriedades modificadas**, e **Resumo**.
3. Revise o **Resumo** para confirmar se a ação foi bem-sucedida ou falhou.
4. Se falhou, abra **Resolução de problemas e recomendações**, que exibe a ação tentada, o nome principal do usuário afetado e — em **Detalhes** — o código de erro e a mensagem de erro completa retornados pela API do Zoom.

Isto é mais confiável do que inspecionar a tela de mapeamento porque mostra os valores literais transmitidos em vez do que o mapeamento foi pretendido para produzir. Quando o log do Entra não for conclusivo, vá para os logs de chamadas do Zoom App Marketplace descritos em **Verificação do lado do Zoom e erros comuns**, que mostram a troca bruta de solicitações e respostas.

#### <mark style="color:azul;">Comportamento de Integração e desintegração no Entra ID</mark>

* O escopo é o principal controle de segurança. Os usuários fora do escopo de atribuição do aplicativo nunca são modificados por nenhum mapeamento nesta configuração.
* Desativar um usuário no Entra ou removê-lo do escopo reverte o provisionamento automaticamente e fecha o ciclo de desintegração.
* Cada falha produz uma entrada de registro correspondente — com a ressalva sobre falhas silenciosas mencionada acima.

### Etapa 7: Aplicar os cenários de referência no Entra ID

Os cenários, pré-requisitos e definições de atributos estão na [**Cenários de referência**](#reference-scenarios) seção. Somente os mapeamentos do Entra são apresentados aqui.

**Cenário 0 — Departamento.** Na Etapa 1, declare `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:departamento` como **Cadeia de caracteres**, tendo o cuidado de usar o espaço de nomes empresarial em vez do espaço de nomes Zoom. Mapeie-o como **Direto** do campo do Entra `departamento` campo. Nenhum **Valor padrão se for nulo** é necessário — um campo de origem vazio simplesmente não envia nada, e não é necessário que exista nenhum objeto no lado do Zoom.

**Cenário 1 — Localização do Zoom Phone e extensão automática.** Mapear `zoomPhoneSite` como **Direto** de `physicalDeliveryOfficeName`, com **Valor padrão se for nulo** definido como `Unidade Principal`. Mapear `zoomPhoneExtNumber` como **Constante** com um valor de `0` a menos que você esteja migrando uma configuração preexistente de extensões. Quando os valores de Localização do escritório não corresponderem exatamente aos nomes de Localização do Zoom, substitua um **Expressão** mapeamento no formato mostrado na Etapa 2.

**Cenário 2 — Plano de tarifação de chamadas variável por país.** Como o Entra não pode obter um valor de um grupo, é necessária uma expressão. Estenda-a com camadas adicionais de `IIF()` por país e considere os formatos alpha-2 e de texto completo, conforme descrito na Etapa 2:

```
IIF(ToUpper([country])="GB","202",
IIF(ToUpper([country])="UNITED KINGDOM","202",
IIF(ToUpper([country])="US","200",
IIF(ToUpper([country])="UNITED STATES","200",
"-1"))))
```

Quando o atributo do Plano de tarifação de chamadas atribuir o direito pago, Selecionar **básico** em vez de **Licenciado** na Etapa 3. Selecionar **Licenciado** aplica também a licença padrão da conta, o que pode não ser o resultado comercial pretendido.

**Cenário 3 — Pacote da central de contato, Função e região.** Mapear `zoomContactCenterPackage` com uma **Expressão** orientada por um campo de diretório que distingue níveis de agente e `zoomContactCenterRole` como **Direto** de um campo que contém o nome da Função. Sair/sair `região do Zoom da central de contato` não mapeado em implantações de região única.

## **Configurando SCIM com o Okta**

#### <mark style="color:azul;">Requisitos adicionais para o Okta</mark>

* Privilégios de administrador do Okta com Acessar ao Editor de Perfil

#### <mark style="color:azul;">Limitações adicionais no Okta</mark>

* Quando um usuário pertence a vários grupos que fornecem valores conflitantes para o mesmo atributo, somente o valor do grupo de maior prioridade é transmitido. Consulte a Etapa 5.

{% hint style="warning" %}
**Atenção: dois perfis, duas finalidades**

O Okta mantém dois perfis distintos que são relevantes aqui, e compreender a separação evita a maior parte da confusão inicial. O **perfil de usuário do Okta** é onde um valor é *armazenado* para uma pessoa no diretório. O **perfil do aplicativo Zoom usuário** é onde um valor é *enviado* para Zoom, e seus atributos carregam o nome externo e o namespace SCIM. Uma configuração por usuário precisa de ambos, além de um mapeamento Conectando-os. Uma configuração em nível de grupo precisa apenas do atributo do perfil do aplicativo, com o valor definido na atribuição do grupo.
{% endhint %}

### Etapa 1: Declare o atributo no perfil de usuário do aplicativo Zoom

Este é o atributo que realmente transmite um valor para Zoom. Declará-lo é uma ação única por atributo.

1. Iniciar sessão no painel de administração da Okta.
2. No menu de navegação à esquerda, clique **Aplicativos**, depois clique **Aplicativos**.
3. Em **ESTADO**, clique em **Ativo**.
4. Clique no **Zoom** aplicativo.\
   **Nota**: O nome do aplicativo é definido pelo administrador da Okta quando o aplicativo é criado. Frequentemente é chamado **Zoom**, mas pode ser diferente no seu locatário.
5. Clique no **Provisionamento** aba.
6. Em **Mapeamentos de Atributos do Zoom**, clique em **Aceda ao Editor de Perfil**.
7. Em **Atributos**, clique em **+ Adicionar atributo**.
8. Conclua o seguinte:
   * **Tipo de dados**: Selecionar **string** ou **booleano**, correspondendo à referência da API SCIM2.
   * **Exibir nome**: Inserir o nome do atributo, por exemplo `zoomPhoneSite`.
   * **Nome da variável**: Inserir o mesmo nome.
   * **Nome externo**: Inserir o nome do atributo exatamente como documentado pelo Zoom, por exemplo `zoomPhoneSite`.
   * **Namespace externo**: Inserir `urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomPhoneSite`
   * **Descrição** (Opcional): Gravar por que o atributo existe e de onde vêm os seus valores.
   * **Tipo de atributo**: Selecionar **Pessoal** para um valor por usuário, ou **grupo** para um valor herdado por meio da associação ao grupo.
9. Clique **Salvar**, ou **Salvar e Adicionar outro**.

{% hint style="danger" %}
**Aviso**

O nome externo e o namespace externo devem estar ambos corretos. A orientação publicada do Zoom especifica o namespace externo como o URN completo *incluindo* o nome do atributo — por exemplo `urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomRevenueAcceleratorRole` — em vez de apenas do namespace. Isto difere da convenção genérica do SCIM. Siga o formato mostrado acima, pois reflete a configuração que a Zoom documenta como funcional.

Os nomes dos atributos diferenciam maiúsculas de minúsculas em toda parte. Um atributo com a capitalização incorreta é aceito pelo Editor de Perfil sem erro e falha silenciosamente na API do Zoom.
{% endhint %}

### Etapa 2: Criar um atributo de origem no perfil do usuário do Okta

Conclua esta etapa em que o valor é mantido por usuário. Ignore-a se o valor for idêntico para cada usuário, ou se será fornecido em nível de grupo em vez disso.

1. No menu de navegação à esquerda, clique **Diretório**, depois clique **Editor de Perfil**.
2. Clique no **usuário** aba.
3. Na **usuário** caixa, sob **Filtros**, clique em **Todos**.
4. À direita de **Okta**, clique em **usuário** perfil.
5. Em **Atributos**, clique em **+ Adicionar atributo**.
6. Conclua o seguinte:
   * **Tipo de dados**: Corresponda ao atributo Zoom declarado na Etapa 1.
   * **Exibir nome** e **Nome da variável**: Insira um nome, por exemplo `zoomPhoneSite`.
   * **Enumeração** (Opcional): Selecionar **Defina uma lista enumerada de valores** onde o atributo Zoom aceita apenas um conjunto fixo de valores.
   * **Atributo obrigatório** (Opcional): Selecionar **Sim** onde cada usuário no escopo deve possuir um valor.
7. Clique **Salvar**.

{% hint style="info" icon="lightbulb" %}
**Dica**

Use o mesmo nome para o atributo de perfil de usuário do Okta e o atributo de perfil do aplicativo Zoom. O Okta não exige isso, mas nomes correspondentes tornam a lista de mapeamento autoexplicativa e reduzem significativamente o tempo de solução de problemas à medida que o número de atributos cresce.
{% endhint %}

Use o **Enumeração** opção sempre que o Zoom documentar um conjunto fixo de valores — pacotes do central de contato, códigos de pacote do Workplace, valores do plano do Revenue Accelerator. Restringir o campo no ponto de entrada evita que um erro de digitação se transforme em uma falha silenciosa de provisionamento que aparece semanas depois como uma permissão ausente.

### Etapa 3: Mapeie o atributo de origem para o atributo do Zoom

1. Navegue até **Aplicativos** → **Aplicativos** → **Ativo** → o **Zoom** aplicativo.
2. Clique no **Provisionamento** aba.
3. Em **Mapeamentos de Atributos do Zoom**, localize o atributo declarado na Etapa 1 e clique no ícone de edição à direita dele.\
   **Nota**: Se o atributo não estiver visível, clique em **Mostrar Atributos Não Mapeados**.
4. Clique no **Valor do atributo** lista pendente e Selecionar **Mapear do perfil do Okta**.
5. Clique no menu suspenso de origem — que exibe `login | cadeia de caracteres` por padrão — e Selecionar o atributo de perfil de usuário do Okta criado na Etapa 2.
6. Selecionar **Criar e atualizar**.\
   **Nota**: **Criar apenas** aplica o valor quando o usuário do Zoom é provisionado pela primeira vez e nunca mais. Selecionar intencionalmente, para valores que não devem ser sobrescritos após a atribuição inicial; Selecionar **Criar e atualizar** em todos os outros casos, para que as alterações do diretório sejam propagadas.
7. Clique **Salvar**.
8. Repita para cada atributo.

{% hint style="warning" %}
**Atenção: Derivando ou traduzindo um valor**

Quando o valor do Okta e o valor do Zoom não são a mesma cadeia de caracteres, o **Valor do atributo** o campo também aceita o Idioma de Expressão do Okta, que oferece suporte a lógica condicional e funções de string. A sintaxe da expressão e as funções Disponível variam conforme a versão do Okta; valide qualquer expressão em relação a um único usuário de teste usando **Pré-visualização** antes de aplicá-la mais amplamente, e consulte a documentação atual do Idioma de Expressão do Okta para funções suportadas.

Quando a tradução é simples e o conjunto de valores é pequeno, definir o valor Zoom diretamente no atributo do Okta como uma lista enumerada — ou usar um atributo de nível de grupo, como na Etapa 5 — geralmente é mais sustentável do que uma expressão.
{% endhint %}

### Etapa 4: Habilitar o provisionamento para o aplicativo

Os mapeamentos de atributos não têm efeito até que as operações de provisionamento correspondentes sejam habilitadas. Habilite-as antes de atribuir valores na Etapa 5.

1. Navegue até **Aplicativos** → **Aplicativos** → **Ativo** → o **Zoom** aplicativo.
2. Clique no **Provisionamento** aba.
3. Em **Provisionamento para o aplicativo**, clique em **Editar**.
4. Habilite as Configurações descritas abaixo, depois clique **Salvar**.

| Configuração                     | Efeito                                                                                                                                                                                       |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Criar usuários**               | Cria ou vincula um usuário no Zoom quando o aplicativo é atribuído a um usuário no Okta.                                                                                                     |
| **Alterar atributos do usuário** | Atualiza os atributos de um usuário no Zoom quando o aplicativo é atribuído. Alterações subsequentes no perfil do usuário no Okta substituem automaticamente o valor correspondente no Zoom. |
| **Desativar usuários**           | Desativa a conta Zoom quando o aplicativo é desatribuído no Okta, ou quando a conta do Okta é desativada. As contas podem ser reativadas ao atribuir novamente o aplicativo.                 |

{% hint style="danger" %}
**Aviso**

**Alterar atributos do usuário** é o que faz com que os mapeamentos de atributos personalizados tenham efeito nos usuários existentes. Sem isso, os mapeamentos se aplicam apenas no momento da criação do usuário, e qualquer alteração subsequente no Okta não chegará ao Zoom.
{% endhint %}

### Passo 5: Atribuir valores a usuários ou grupos

**Para atribuir um valor a um usuário individual:**

1. Navegue até **Diretório** → **Pessoas** e clique no nome do usuário.
2. Clique no **Perfil** aba, depois clique **Editar**.
3. Preencha o atributo criado na Etapa 2 com o valor que o Zoom espera.
4. Clique **Salvar**.

O valor é transmitido prontamente. Confirme o resultado no Portal web do Zoom antes de aplicar a mesma ação de Alterar em maior escala.

**Para Atribuir um valor a um grupo** — o padrão mais escalável em que a configuração segue a estrutura organizacional:

1. Confirme se o atributo foi declarado na Etapa 1 com **Tipo de atributo: grupo**. Se foi declarado como **Pessoal**, defina um equivalente no nível do grupo repetindo a Etapa 1 para o **usuário do Zoom** perfil em **Diretório** → **Editor de Perfil** → **usuário** → **Todos**, selecionando **grupo** como o tipo de atributo.
2. Navegue até **Diretório** → **grupo** → o **Todos** aba, depois clique **Adicionar grupo**.
3. Inserir um **Nome** e Opcional **Descrição**, depois clique **Salvar**.
4. Abra o grupo e clique no **Aplicativos** aba.
5. Clique **Atribuir aplicativo**, depois clique **Atribuir** à direita do **Zoom** aplicativo.
6. Preencha os atributos ao nível do grupo com os valores que devem aplicar-se a cada Membros.
7. Clique **Salvar e voltar**, depois clique **Concluído**.
8. Clique no grupo **Pessoas** aba, depois clique **Atribuir Pessoas**.
9. Pesquise usuários pelo primeiro nome, endereço de e-mail principal ou Nome de usuário e clique no botão Adicionar ao lado de cada um.
10. Clique **Concluído**.

Os Membros herdam automaticamente os valores de atributos do grupo. Os usuários adicionados posteriormente os herdam ao se juntarem, o que torna este padrão durável para a Integração contínua em vez de um exercício de migração pontual.

#### <mark style="color:azul;">A prioridade do grupo resolve valores conflitantes quando um usuário pertence a vários grupos</mark>

Quando um usuário é Membros de mais de um grupo que fornece um valor para o mesmo atributo, o Okta transmite o valor do grupo de maior prioridade.

1. Navegue até **Aplicativos** → **Aplicativos** → **Ativo** → o **Zoom** aplicativo.
2. Clique no **Atribuições** aba.
3. Em **Filtros**, clique em **grupo**.
4. Arraste e solte os grupos para a ordem pretendida.

{% hint style="info" %}
**Recomendação**

Ordene os grupos do mais específico para o mais geral, para que um grupo de escopo restrito — uma unidade ou Função específica — tenha precedência sobre um abrangente. Inverter esta ordem faz com que o grupo geral substitua todos os específicos, o que normalmente se apresenta como uma população inteira recebendo a mesma configuração indesejada.
{% endhint %}

### Passo 6: Verifique usando o Registo do Sistema da Okta

1. Navegue até **Relatórios** → **Registo do sistema**.
2. Filtre pelo usuário de destino ou pelo aplicativo Zoom e restrinja o intervalo de tempo à tentativa de provisionamento.
3. Abra o Evento relevante e reveja os detalhes, que incluem o resultado e qualquer erro retornado pelo aplicativo downstream.

Falhas de provisionamento não resolvidas também aparecem no aplicativo Zoom **Provisionamento** aba. Quando o registro do Okta não for conclusivo, avance para os logs de ligar do Zoom App Marketplace descritos em **Verificação do lado do Zoom e erros comuns**, que mostram a troca bruta de solicitações e respostas.

{% hint style="warning" %}
**Atenção: a falha silenciosa específica do Okta**

Um atributo declarado no perfil de usuário do Zoom, mas nunca mapeado, ou mapeado sem **Alterar atributos do usuário** ativado na Etapa 4, não transmite nada enquanto permanece visível na lista de mapeamentos. Nenhum erro é gerado. Se um valor não estiver chegando ao Zoom e o Registro do Sistema não mostrar nenhum Evento correspondente, verifique o mapeamento e as Configurações de provisionamento antes de investigar mais a fundo.
{% endhint %}

#### <mark style="color:azul;">Comportamento de Integração e desligamento no Okta</mark>

* O escopo é o principal controle de segurança. Usuários não atribuídos ao aplicativo Zoom no Okta nunca são modificados por qualquer mapeamento nesta configuração.
* Com **Desativar usuários** ativado, ao desatribuir o aplicativo ou desativar a conta do Okta, a conta Zoom é desativada automaticamente.
* Reatribuir o aplicativo reativa uma conta Zoom previamente desativada, o que torna a associação ao grupo um mecanismo viável para gerir quem sai e quem retorna.

### Etapa 7: Aplicar os cenários de referência no Okta

Os cenários, pré-requisitos e definições de atributos estão na [**Cenários de referência**](#reference-scenarios) seção. Apenas a configuração do Okta é fornecida aqui.

**Cenário 0 — Departamento.** Na Etapa 1, declare o atributo com **Exibir nome** e **Nome da variável** `departamento`, **Nome externo** `departamento`, e **Namespace externo** `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário`. Use **Tipo de atributo: Pessoal**. O perfil base do usuário no Okta já contém um `departamento` atributo, então a Etapa 2 pode ser ignorada — mapeie diretamente a partir dele na Etapa 3, selecionando **Criar e atualizar**.

{% hint style="warning" %}
**Atenção: formato de namespace para atributos de extensão empresarial**

O AVISO na Etapa 1 descreve a convenção do Zoom de acrescentar o nome do atributo ao namespace Externo. Essa orientação está documentada para atributos sob a extensão do Zoom. `departamento` pertence à extensão empresarial SCIM padrão, em que o comportamento normal do Okta é manter o namespace e o nome externo em campos separados, como mostrado acima. Se o valor não chegar ao Zoom, tente a forma com o nome acrescentado — `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:departamento` — e confirme qual forma funcionou no registro de chamadas do Marketplace.
{% endhint %}

**Alternativas se `departamento` já estiver mapeado.** Qualquer um dos seguintes se comporta de forma idêntica, fica sob o mesmo pai e não tem pré-requisitos — substitua o nome do atributo tanto no **Nome externo** e no namespace, e adicione um atributo de origem correspondente na Etapa 2 se o perfil do Okta ainda não tiver um:

| Atributo          | Notas                                                                                                                                                                        |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `centro de custo` | campo Corporativo, varia entre os usuários, então um valor incorreto fica visível                                                                                            |
| `Organização`     | Frequentemente idêntico em todos os usuários, o que torna um erro mais difícil de identificar                                                                                |
| `employeeNumber`  | Frequentemente já mapeado como um campo de identidade — verifique antes de declarar                                                                                          |
| `pronomes`        | Fica sob a **Zoom** extensão, em vez da empresarial, portanto usa o mesmo namespace que todos os outros cenários deste guia e evita completamente a questão de formato acima |

**Cenário 1 — Localização do Zoom Phone e extensão automática.** Declare `zoomPhoneSite` com **Tipo de atributo: grupo** e defina seu valor no grupo do Okta de cada unidade, de modo que a associação ao grupo determine a unidade diretamente e nenhuma lógica de tradução seja necessária. Declare `zoomPhoneExtNumber` como um atributo pessoal com valor padrão de `0` a menos que esteja migrando uma configuração de extensões já existente.

**Cenário 2 — Plano de tarifação de chamadas variável por país.** Declare `zoomPhoneCallingPlan` com **Tipo de atributo: grupo** e crie um grupo por região do Plano de tarifação de chamadas, definindo o valor do plano na atribuição do aplicativo Zoom de cada grupo. Os usuários herdam o plano correto por meio da associação, e o valor armazenado no Okta é exatamente o valor que o Zoom espera. Isso também torna a configuração visível e auditável na **Atribuições** aba, e isso resiste a inconsistências em como os dados do diretório subjacente foram preenchidos. Um grupo que contenha `-1` oferece uma maneira limpa de desprovisionar direitos de Plano de tarifação de chamadas sem excluir o usuário.

**Cenário 3 — Pacote da central de contato, Função e região.** Declare `zoomContactCenterPackage` como um atributo enumerado restrito aos três valores permitidos, para que um Pacote inválido nunca possa ser inserido. Declare `zoomContactCenterRole` como um atributo no nível do grupo, já que a Função geralmente segue a estrutura da equipe. Sair `região do Zoom da central de contato` não mapeado em implantações de região única.

## Solução de problemas

### Erros

#### <mark style="color:azul;">Usuário não existe ou não pertence a esta conta</mark>

Este erro ocorre quando o endereço de e-mail de um usuário-alvo não consegue ser provisionado devido a uma conta já existente. Os administradores Zoom são incentivados a entrar em contato com o usuário diretamente e Convidar manualmente o usuário para a conta.

<div data-with-frame="true"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdXyiyMnR4S4EhYFqFUXgrePk-RwciKw8-jcxKxViZiIZ4I2kp0j1f_alWR7Hq9WuYhwz6ohh4LodWERfiXSr27LFN20r-r95xBJ6AjD7lF9k58yIJeYLpMmHR3BHYcPTMYkVwqZw?key=ug1dFE_WGWGnyMfD5tJnNw" alt="" width="563"><figcaption><p>Exemplo de um erro de provisionamento.</p></figcaption></figure></div>

#### <mark style="color:azul;">Você Não Pode Adicionar Usuários Pagos</mark>

Este erro ocorre quando o SCIM tenta provisionar um usuário quando não há licenças suficientes na conta. Para resolver o erro, o usuário deve ser provisionado como um usuário básico ou uma licença deve ser disponibilizada para provisionamento.

<div data-with-frame="true"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdXyiyMnR4S4EhYFqFUXgrePk-RwciKw8-jcxKxViZiIZ4I2kp0j1f_alWR7Hq9WuYhwz6ohh4LodWERfiXSr27LFN20r-r95xBJ6AjD7lF9k58yIJeYLpMmHR3BHYcPTMYkVwqZw?key=ug1dFE_WGWGnyMfD5tJnNw" alt="" width="563"><figcaption><p>Exemplo de um erro de provisionamento.</p></figcaption></figure></div>

### Usando os registros SCIM para solucionar problemas de provisionamento de usuários

Zoom fornece os 100 registros mais recentes de solicitações de API em [Zoom Marketplace](https://marketplace.zoom.us/). Um administrador Zoom pode usar esses registros para confirmar quais informações estão sendo enviadas e recebidas por meio das APIs de provisionamento. Para Acessar os registros, entre no Zoom Marketplace como um administrador Zoom e clique em **Gerir**. Na página seguinte, Selecionar **Registros de chamadas** em **Gerenciamento de aplicativos pessoais**. A partir daí, clique em uma entrada para expandir os registros de API e revisar o conteúdo.

A imagem a seguir mostra um exemplo de uma solicitação de provisionamento de usuário SCIM, com a identidade e os atributos de licenciamento do usuário destacados para referência.

<div data-with-frame="true"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcIxosFPBR8E4f1hj0vZQ7_nxnRd_isIqJYhKTQbocw4UfXlCBCkscqx8bGvY8JwuazgtRROPJm9PCZfZ4hJ5GQBqBzJA-PgS-mXkptGa0xq82SMXjl9Ip-faCDk3OQuLUXK0iobQ?key=ug1dFE_WGWGnyMfD5tJnNw" alt=""><figcaption><p>Exemplo de uma solicitação de provisionamento de usuário SCIM.</p></figcaption></figure></div>

Assim como o mapeamento de resposta, o Zoom só pode aplicar as informações enviadas pelo provedor de identidade na solicitação de provisionamento. Use estes registros para confirmar que a identidade do usuário e os atributos de licenciamento estão sendo enviados pelo provedor de identidade. Se as informações esperadas estiverem ausentes dessas declarações, entre em contato com seu provedor de identidade para obter Suporte.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://library.zoom.com/technical-library/pt/canto-do-administrador/account-and-endpoint-management/scim-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
