> 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/area-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 Entra ID ou Okta e Zoom

## Visão geral

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

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 isoladamente, ele explica o modelo subjacente para que os administradores possam consultar um atributo na referência da API SCIM2 do Zoom e Configurar isso de forma independente, sem esperar que um artigo específico do produto seja publicado.

### Como usar este guia

Leia a Introdução começando com [**Entendendo os atributos SCIM**](#understanding-scim-attributes) primeiro, juntamente com as seções que seguem — pré-requisitos, dados do diretório, cenários de referência e Verificação do lado do Zoom. Eles se aplicam independentemente do provedor de identidade (IdP) que você usa. Em seguida, trabalhe na seção Microsoft Entra ID ou 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 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 da Zoom para Okta](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063256).

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

O provisionamento mal configurado afeta os usuários existentes, incluindo a remoção de licenças já em uso. Valide cada Alterar contra um único usuário de teste antes de aplicá-lo a uma população em produção.
{% endhint %}

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

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

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

* conta Zoom Corporativo (for plan)/Corporativa (for licence), 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
* Uma [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 que estão sendo provisionados
* O provisionamento SCIM já foi estabelecido entre o provedor de identidade e Zoom
* A licença Zoom, plano, add-on ou objeto de configuração que está sendo atribuído já deve existir e estar Disponível na conta Zoom

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

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

* O SCIM atribui apenas permissões existentes; não pode criar os objetos que referencia. Consulte a seçã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 Plano de tarifação de chamadas do Zoom Phone é um exemplo — pacotes add-on, como o Customer Engagement Pack, não podem ser provisionados por meio do SCIM.
* O `tipo de utilizador` o atributo é documentado pelo Zoom como planejado para descontinuação.

## **Introdução**

### **Entendendo 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:User: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 adiante. Para os nossos propósitos imediatos, estamos focados em duas: a **Espaço de nomes** e a **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>Informa ao Zoom a que esquema a configuração pertence e atua como base compartilhada para quase todos os atributos de produto e licenciamento do Zoom. Transmitido 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. Transmitido ao Zoom como a segunda metade do identificador. Sensível a maiúsculas e minúsculas.</td></tr><tr><td><strong>Tipo de dados</strong></td><td><code>string</code></td><td>Informa 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>Essentials</code>, <code>Premium</code>, ou <code>Elite</code> para o Zoom central de contato, por exemplo. Passado para o 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 de usuário. Os atributos de configuração e licenciamento do produto usam `urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário`, que é o namespace que este guia usa ao longo de todo o texto. Campos empresariais padrão, como `department`, `gerente`, e `centro de custo` usar `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário`. Um terceiro, `urn:us:zoom:scim:schemas:extension:1.0:ZoomUser`, carrega informações sobre o tipo de login retornadas nas respostas da API, em vez de configuradas durante o provisionamento. Um atributo criado no namespace 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 são importantes: **Criar um usuário** e **Atualizar um usuário**.

Trabalhe principalmente a partir de **Atualizar um usuário**A criação acontece uma vez por pessoa, mas as Alterar de atributos acontecem continuamente — uma mudança de escritório, uma Alterar de plano, uma Alterar de 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 razão 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. Todos os atributos abordados neste guia estão listados nele.
* Encontre seu atributo pelo nome e grave o seu **tipo de dados** e os seus **valores permitidos**.
* Leia a descrição ao lado dele. As descrições trazem comportamentos que você não pode inferir pelo nome do atributo — `zoomPhoneExtNumber` definido como `0` dispara 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 desse `urn:ietf:params:scim:schemas:extension:zoom:1.0:Usuário` objeto é um **filho** dele. 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
Cólon        :
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 pesquisa para solicitar ao Zoom e nada a gerar — o identificador é duas coisas que você já tem, unidas por dois pontos.

#### <mark style="color:azul;">O pai mantém-se o mesmo; apenas o filho muda</mark>

Como o pai está 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:usuário

Zoom Phone unidade            urn:ietf:params:scim:schemas:extension:zoom:1.0:User:zoomPhoneSite
Número do Zoom Phone          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:User:zoomPhoneCallingPlan
```

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

```
Pacote da central de contato     urn:ietf:params:scim:schemas:extension:zoom:1.0:usuário:zoomContactCenterPackage
Função de Acelerador de Receita   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 elemento filho, o seu tipo de dados e os seus valores permitidos.

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

#### <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 empresta os termos **básico** e **avançado** do [Guia de Campo 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 na chegada**, 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 solicitação, ambos são construídos com a mesma estrutura pai-dois-pontos-filho, e ambos são declarados e mapeados pelos mesmos passos no Entra ID e no Okta.

* **mapeamento básico** escreve texto no perfil de um usuário. O Zoom armazena o valor exatamente como foi enviado e nunca o verifica em relação a nada.
* **mapeamento avançado** faz uma reivindicação sobre a conta. O Zoom pega o valor e procura um objeto correspondente, ou um assento livre 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>Qual é 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 um assento adquirido</td></tr><tr><td><strong>Exemplos</strong></td><td><code>department</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 o assento 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 muito para o avançado — e ela determina **o custo de um erro**. Um departamento incorreto é um erro cosmético em um perfil. Um nome de unidade incorreto ou um assento de licença indisponível deixa um usuário sem um telefone funcionando ou sem o produto que ele foi contratado para usar e, em uma implantação em produção, pode retirar um direito de alguém que já o possuía.

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 de Zoom de um usuário. O Zoom armazena cada valor exatamente como enviado e nunca o valida em relação a um objeto existente, portanto não há nada para criar no Zoom previamente e nada para quebrar se um valor estiver errado.

**Os campos principais de identidade normalmente 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 pai, e tanto as integrações do Entra ID quanto do Okta os mapeiam prontos para uso. Verifique-os em vez de recriá-los. `título`, `números de telefone`, e `localidade` também são de nível superior, mas podem precisar de ser adicionados.

**Os campos empresariais usam um segundo pai.** A construção não Alterar — apenas o pai 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:enterprise:2.0:User:costCenter
Número do Funcionário       urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:númeroDoFuncionário
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:manager
```

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

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

Mapeie primeiro um atributo básico — `department` é um bom candidato, e é tratado como **Cenário 0** nos cenários de referência — e executá-lo do início ao fim para um único usuário de teste antes de configurar qualquer coisa na extensão Zoom. A `department` o valor que aparece corretamente em um perfil do Zoom comprova a declaração do esquema, o mapeamento, o escopo e sua capacidade de ler os logs de provisionamento. Todo atributo avançado que se segue difere apenas no que aponta, 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 o que um usuário pode fazer: uma unidade do Zoom Phone e um Plano de tarifação de chamadas, uma Função e Pacote de central de contato, um Pacote do Workplace, um segmento do Revenue Accelerator. Esses atributos ficam sob a extensão Zoom principal usada ao longo deste guia.

A diferença que importa é que estes valores não são armazenados — eles são **resolvido**. O Zoom pega o valor que você envia e procura um objeto correspondente ou um assento disponível. Onde o mapeamento básico escreve texto em um 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. Todo atributo avançado depende de algo ter sido construído ou comprado primeiro no Portal web do Zoom, e os modos de falha são consideravelmente menos tolerantes do que um cargo digitado incorretamente.

#### <mark style="color:azul;">As três camadas comuns a toda configuração</mark>

Independentemente de qual atributo ou de qual provedor de identidade, o trabalho é o mesmo em 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>Diga ao provedor de identidade que o atributo existe no aplicativo Zoom para que ele fique disponível como um alvo de mapeamento.</td><td>Etapa 1</td><td>Etapa 1</td></tr><tr><td><strong>2. Mapeamento</strong></td><td>Defina de onde o valor vem.</td><td>Etapa 2</td><td>Etapas 2–3</td></tr><tr><td><strong>3. 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>

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

#### <mark style="color:azul;">Entra e Okta diferem em onde um valor pode se originar</mark>

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

* **Entra ID obtém valores apenas dos atributos do objeto de usuário.** Um valor deve vir de um campo no 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 string, é necessária uma expressão para traduzir 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 todos os Membros. Quando a configuração segue a estrutura organizacional, isso elimina totalmente a necessidade de lógica de tradução.

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

### **Requisitos de pré-configuração do lado do 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** constrói essa configuração em nome do usuário.

Uma grande parte dos atributos de mapeamento avançado são **referências**: o valor que você envia deve se resolver em um objeto que já existe no Zoom — uma unidade, uma função, um modelo, um plano comprado, um número específico ou número do ramal. Uma única regra governa todos eles:

> Se um atributo nomeia algo, essa coisa já deve existir, deve ser escrita exatamente como foi enviada e — quando depende de um pool finito — deve ter capacidade não utilizada.

Quando um objeto referenciado não existe, o SCIM nem o cria nem coloca a solicitação em fila. O atributo falha imediatamente, 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 construir cada um. Leia as notas no nível da conta e, depois, a seção de cada produto que você 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 da conta listados no início deste guia — URL intuitivo, SSO, autorização SCIM e um domínio associado verificado — são pré-requisitos para cada atributo a seguir. Configurar a segurança e o SSO em [**Centro de administração**](https://zoom.com/account) → [**Segurança e confiança**](https://zoom.com/account/setting/security), e gerencie Domínios associados em [**Centro de administração**](https://zoom.com/account) → **Conta** → [**perfil da conta**](https://zoom.com/account); veja [configuração de SSO/SCIM do Zoom + Microsoft Entra ID](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064121).

Mais dois pontos merecem ser explicitados:

* **Comprar uma vaga não é o mesmo que atribuí-la.** O SCIM executa a atribuição, mas a vaga deve existir primeiro. Veja [Atribuindo ou removendo licenças do Zoom dos usuários](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064911).
* **As vagas devem pertencer exatamente ao plano solicitado.** Enviar um atributo de licença quando aquele plano específico não tiver vagas livres falha mesmo que um plano diferente na conta mostre capacidade sobrando.

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

O Zoom Phone inclui o maior conjunto de atributos de referência porque um usuário de telefone é montado a partir de várias partes de infraestrutura pré-comprada ou pré-construída.

| Atributo                                                                       | O que já deve existir                                                                                                                                                                | Como criá-lo                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| A licença do Zoom Phone                                                        | Uma vaga do Zoom Phone está Disponível — a autorização obrigatória antes que qualquer coisa abaixo possa ser vinculada.                                                              | Compre com antecedência. Veja [Comprando e atribuindo licenças do 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 assim que múltiplas unidades são habilitadas.      | [Centro do administrador](https://zoom.com/account) → configuração do produto → sistema de telefonia → [Informações da empresa](https://zoom.com/pbx/page/telephone/settings#/settings) → **Adicionar unidade**, ou **Importar** para criação em massa. Veja [Gerenciando 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á detido por outro usuário, fila de chamadas ou recepcionista automático não pode ser reutilizado. | [Centro do administrador](https://zoom.com/account) → configuração do produto → Números de telefone → [Números de telefone](https://zoom.com/cpw/page/phoneNumbers#/number-list). Compre ou porte aqui e deixe o número de destino sem atribuição para que o SCIM possa reivindicá-lo. Veja [Usando 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 [Gerenciando 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, ainda não em uso. Não é necessário ao enviar `0`, que delega a atribuição ao Zoom.                                                                        | [Centro do administrador](https://zoom.com/account) → configuração do produto → sistema de telefonia → [Usuários & Salas](https://zoom.com/pbx/page/telephone/phoneUsers#/users) → Selecionar o objeto que contém o número do ramal → **Perfil** → **número do ramal** → **Editar**. Ver [Alterando as 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, adquirido e com capacidade Disponível, referenciado pelo seu código exato do plano.                                                                | Compre com antecedência. Veja [Comprando e atribuindo licenças do Zoom Phone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0077929) e [Gerenciando 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 em [referência do Plano de tarifação de chamadas do Zoom Phone](https://developers.zoom.us/docs/api/references/phone-calling-plans/), ou retornado como `tipo` pelo [Listar o Plano de tarifação de chamadas](https://developers.zoom.us/docs/api/references/phone-calling-plans/) API juntamente com contagens de assentos Disponível. |
| `zoomPhoneAssinaturaDoPlanoDeChamadas` (somente contas com várias assinaturas) | A assinatura específica da qual o plano deve retirar, quando a conta possui mais de uma assinatura do mesmo plano.                                                                   | Planos e Faturamento → gerenciamento de assinaturas.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

**O pool de ramais é compartilhado entre tipos de objetos, não apenas usuários.** Filas de ligar, atendentes automáticos, grupos de linha compartilhada e telefones de área comum consomem ramais de todo o mesmo intervalo. Esta é a causa mais frequente de falhas de "ramal já em uso" porque o ramal parece livre quando um administrador verifica apenas a lista de usuário.

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

**Os sites são o bloqueador mais comum** porque criá-las implica requisitos próprios. Os endereços da unidade são validados contra uma base de dados de endereços do mundo real porque sustentam 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 ao 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 contém 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 — `Essentials`, `Premium`, ou `Elite` — comprado com assentos não utilizados.                                                                    | comprar com antecedência; O Premium pode exigir entrar em contato com o Suporte do Zoom para comprar pacotes adicionais primeiro. Veja [Alterando as Configurações de usuário da central de contato Zoom](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. Omiti-la atribui a Função padrão de Agente, que existe por padrão.                                 | [Centro de administração](https://zoom.com/account) → gestão de CX → central de contato → [Funções](https://zoom.com/cci/index/admin#/admin-next/admin-roles) → **Adicionar** → Configurar permissões → **Salvar**. Ver [Gerenciando Funções do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0061941).                                                                                                                 |
| `zoomContactCenterRegion`             | A região. Omiti-la atribui a região principal da conta, que deve ser configurada.                                                                         | [Centro de administração](https://zoom.com/account) → gestão de CX → central de contato → [Preferências](https://zoom.com/cci/index/admin#/admin-preferences) → Regiões → **Adicionar Região** → Inserir um nome e Selecionar uma Zona SIP → **Adicionar**. Ver [Gerenciando regiões do Zoom central de contato](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0057668).                                                                         |
| `zoomCentralDeContatoModeloDeUsuário` | O modelo do usuário, nomeado exatamente. Modelos do tipo Adicionar aplicam-se na criação do usuário; modelos do tipo Atualizar aplicam-se na atualização. | [Centro de administração](https://zoom.com/account) → gerenciamento de CX → central de contato → usuários → [Modelos](https://zoom.com/cci/index/admin#/admin-agents#templates) → **Adicionar modelo** → Escolher **Adicionar** → Configurar funções, pacotes, filas e habilidades → **Adicionar**. Ver [Gerenciamento do modelo de Configurações de usuário da central de contato Zoom](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 uma solicitação de suporte, e não de uma Alternar de autoatendimento, sinalize isso com antecedência se uma implantação multirregional estiver planejada.
{% endhint %}

**Caixas de entrada, filas e habilidades não têm atributo SCIM.** Para provisioná-los, crie-os previamente em [Centro de administração](https://zoom.com/account) → gestão de CX → central de contato, anexá-los a um modelo de usuário e Atribuir esse modelo por meio de `zoomCentralDeContatoModeloDeUsuário`. Eles, portanto, tornam-se pré-condições do *modelo* em vez de do usuário individual — o que também torna o modelo o único objeto a manter à medida que esses requisitos sofrem Alterar.

<table><thead><tr><th width="123.2821044921875">Objeto</th><th>Como criá-lo</th></tr></thead><tbody><tr><td>Fila</td><td><a href="https://zoom.com/account">Centro de administração</a> → gestão de CX → central de contato → <a href="https://zoom.com/cci/index/admin#/admin-queues">Filas</a> → <strong>Adicionar fila</strong> → nome, canal, agentes → <strong>Salvar</strong>. Ver <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><a href="https://zoom.com/account">Centro de administração</a> → gestão de CX → central de contato → <a href="https://zoom.com/cci/index/admin#/admin-next/admin-skills">Habilidades</a> → Selecionar uma categoria → <strong>Adicionar Habilidade</strong> → nome → <strong>Adicionar</strong>. Ver <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><a href="https://zoom.com/account">Centro de administração</a> → gestão de CX → central de contato → <a href="https://zoom.com/cci/index/admin#/admin-next/admin-inbox">Caixa de entrada</a> → <strong>Adicionar Caixa de entrada</strong>. Ver <a href="https://support.zoom.com/hc/en/article?id=zm_kb&#x26;sysparm_article=KB0059471">Gerenciando 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.** Enviando um modelo juntamente com `zoomContactCenterRole` significa que o atributo de 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 adquirido com um assento Disponível.                            | Comprar com antecedência; plano da conta e Informações de faturamento.                                                                                                                                                                                                                                                                                                                         |
| `zoomRevenueAcceleratorFunção`                                      | A Função, padrão ou personalizada — por exemplo `Gerente de Vendas` — nomeado exatamente. | [Centro de administração](https://zoom.com/account) → Usuários → [Funções](https://zoom.com/role#/) → **Revenue Accelerator** aba → **+ Adicionar Função** → nome e descrição → **Adicionar** → Configurar permissões → **Salvar alterações**. Ver [Usando o Gerenciamento de função do Zoom Revenue Accelerator](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0059285). |
| `zoomRevenueAcceleratorSegmento`                                    | O segmento ao qual o usuário pertence.                                                    | Configurações de administrador do Revenue Accelerator.                                                                                                                                                                                                                                                                                                                                         |
| `zoomRevenueAcceleratorRegion`                                      | A região — por exemplo, `EUA`.                                                            | Configurações de administrador do Revenue Accelerator.                                                                                                                                                                                                                                                                                                                                         |

#### <mark style="color:azul;">Licenças do Zoom Workplace e Função da conta</mark>

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

| Atributo                                                                                                                                                                                                                                                                                | O que já deve existir                                                                                 | Como criá-lo                                                                                                                                                                                                                                                                              |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Função[]` (`valor` / `Exibir`)                                                                                                                                                                                                                                                         | A Função da conta, nomeada exatamente. As Funções são referenciadas pelo SCIM, nunca criadas por ele. | [Centro de administração](https://zoom.com/account) → Usuários → [Funções](https://zoom.com/role#/) → **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 da Qualidade, Gestão da conformidade, CX Insights, Assistente de Vendas com IA e seus `...Assinatura` contrapartes | O pacote ou add-on correspondente, adquirido com assentos não utilizados.                             | Planos e Faturamento → Gestão de Planos → edite o plano → aumente o número de licenças. Veja [A atualizar a sua conta e complementos](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063375).                                                                        |
| `tipo de login` (`sso` / `emailProfissional`), sob `urn:us:zoom:scim:schemas:extension:1.0:ZoomUser`                                                                                                                                                                                    | SSO configurado na conta, para o tipo de login SSO.                                                   | [Centro de administração](https://zoom.com/account) → Segurança e confiança → [logon único](https://zoom.com/account/sso/saml).                                                                                                                                                           |

Para um atributo de licença ou add-on, não há objeto a nomear, mas a pré-condição tem o mesmo efeito: sem uma vaga Disponível nesse pool específico, a atribuição falha.

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

Todo atributo básico de mapeamento é elegível, conforme abrangido em **Mapeamento básico: informações de perfil** — Zoom armazena esses valores literalmente e nunca os valida em relação a um objeto existente. Dois atributos na extensão Zoom se comportam da mesma maneira:

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

**Referências com padrão** são um caso intermediário: omitir `zoomPhoneSite`, `zoomContactCenterRole`, ou `zoomContactCenterRegion` reverte para a unidade principal, a Função de Agente padrão e a região principal, respectivamente. Esses padrões precisam existir por si mesmos, e existem por padrão.

**Grupos são uma exceção parcial.** Quando o provisionamento de grupo está ativado, 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 [Centro de administração](https://zoom.com/account) → Usuários → [Grupos](https://zoom.com/account/group#/) depois que o grupo aparecer.

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

Considere a implementação do lado do Zoom como uma fase prévia com sua própria aprovação, concluída e verificada antes de começar o trabalho de mapeamento de atributos. Sites, números, planos, funções e modelos frequentemente pertencem a uma equipe diferente da Configurações do provedor de identidade, e descobrir um objeto ausente durante os testes de provisionamento custa consideravelmente mais do que confirmar sua existência antecipadamente.
{% endhint %}

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

O SCIM transmite exatamente 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.
* **Os respetivos valores coincidem exatamente com os 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 e preenchido deliberadamente para estas Integrações é mais sustentável do que reaproveitar um campo para o qual também escrevem outros sistemas.

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

Decida a fonte da verdade antes de tocar na configuração do fornecedor de identidade. A maioria das implementações SCIM falhadas 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. Os respetivos requisitos empresariais e pré-requisitos do lado do Zoom são idênticos, independentemente do fornecedor de identidade, pelo que são definidos aqui uma única vez. Cada secção específica do fornecedor 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 respetivo perfil do Zoom, tendo como origem o diretório. Este é o mapeamento básico recomendado anteriormente como um primeiro teste de ponta a ponta, e está incluído aqui para que o procedimento seja percorrido nas secções de ambos os fornecedores de identidade.

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

**Atributo.** Note que o pai difere dos três cenários abaixo — `department` reside sob a extensão empresarial, não a 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 `department` campo no perfil do usuário, portanto nenhum novo atributo de origem é necessário. |

**Por que começar aqui.** Um valor de departamento que aparece corretamente em um perfil do Zoom comprova a declaração do esquema, o mapeamento, o escopo e sua capacidade de ler os registros de provisionamento — sem colocar uma licença ou uma configuração do 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 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 `department` já estiver mapeado, verifique-o em vez de declarar uma duplicata — e, se você quiser um atributo para Configurar do zero em vez disso, `centro de custo`, `Organização`, e `employeeNumber` ficam 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 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** Os sites já devem existir. Crie-os abaixo de [**Centro do administrador**](https://zoom.com/account) → **Configuração do produto** → **sistema de telefonia** → [**Informações da empresa**](https://zoom.com/pbx/page/telephone/settings#/settings) → **Adicionar unidade**, ou em massa através de **Importar**. Os endereços da unidade são validados contra uma base de dados de endereços do mundo real porque suportam serviços de chamada de emergência, por isso 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 do Zoom caractere por caractere |
| `zoomPhoneExtNumber` | string | `0` aciona a atribuição automática                                   |

**Por que o valor `0` importa.** Zoom é o único sistema que sabe quais ramais já estão em uso — incluindo ramais atribuídos a filas de ligação e recepcionistas automáticos, em vez de usuários. Delegar a atribuição ao Zoom remove toda uma categoria de falha de provisionamento. Obter os ramais do diretório em vez disso é apropriado durante uma migração, quando preservar os números de ramal existentes importa, mas o mapeamento deve mudar para `0` assim que a migração for concluída, para que os novos usuários 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 recebe exatamente o nome `Unidade principal`, visível em [**Centro do administrador**](https://zoom.com/account) → **Configuração do produto** → **sistema de telefonia** → [**Informações da empresa**](https://zoom.com/pbx/page/telephone/settings#/settings). 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 o Plano de tarifação de chamadas 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 comprados e estar disponíveis na conta. Os valores do plano estão documentados em [referência do Plano de tarifação de chamadas do Zoom Phone](https://developers.zoom.us/docs/api/references/phone-calling-plans/).

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

**Como obter o código correto do plano.** `zoomPhoneCallingPlan` usa o código numérico do plano, e não o nome de um plano. A maneira mais confiável de obtê-lo é a [Listar o Plano de tarifação de chamadas](https://developers.zoom.us/docs/api/references/phone-calling-plans/) API, que retorna o nome de cada plano `nome`, o seu `tipo` — o código que você mapeia — e o seu `subscrito` e `disponível` contagens de assentos. 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, então um administrador que trabalha apenas a partir do portal deve traduzir o nome de Exibir usando o [referência do Plano de tarifação de chamadas do 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 referência lista nomes de constantes em vez da redação do portal, portanto confirme a correspondência nas características do plano — região e medido versus ilimitado — em vez do 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 `zoomPhoneAssinaturaDoPlanoDeChamadas`.

**Por que `-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 valor algum. Ele também oferece uma maneira limpa de remover os direitos de chamadas sem excluir o usuário.

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

Os agentes da central de contato devem ser provisionados com o Pacote ZCC e a Função corretos 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 | `Essentials`, `Premium`, `Elite`                                              |
| `zoomContactCenterRole`    | string | Qualquer nome de Função do ZCC. O padrão é `Agente` se omitido.               |
| `zoomContactCenterRegion`  | string | Qualquer região do ZCC configurada. O padrão é a região principal se omitida. |

**Ao omitir atributos deliberadamente.** Sair/sair `zoomContactCenterRegion` 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á correto é preferível a mapeá-lo — cada mapeamento é uma obrigação de manutenção.

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

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

Cada provedor de identidade tem seu próprio log, coberto na Etapa 6 de cada provedor de identidade. O log do Zoom abaixo é idêntico para ambos e é o gravar definitivo do que o Zoom realmente recebeu.

#### <mark style="color:azul;">Os logs de ligar do Zoom App Marketplace 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é a [**Zoom App Marketplace**](https://marketplace.zoom.us/) → **Gerenciar** → **Apps na conta**.
3. Selecionar o aplicativo que representa a conexão com o provedor de identidade. No Entra, isso normalmente é chamado **Identidade do Azure** ou similar.
4. Abra o **Registos de ligar** aba.
5. Usar **Pesquisar por pontos de extremidade**, ou pelos filtros de intervalo de datas, método e status, para localizar a ligação relevante.
6. Selecionar a linha para expandi-la.
7. Revisar `corpo da solicitação` 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, `status HTTP`, e o conjunto de atributos resultante.

O Zoom mantém os 100 registros de solicitações de API mais recentes, portanto investigue uma falha prontamente, e não depois que outra atividade de provisionamento a tenha substituído.

#### <mark style="color:azul;">Erros comuns de provisionamento e 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 habilitou o logon único.</td><td>SSO é um pré-requisito para SCIM. Habilitar e Configurar o SSO na conta Zoom primeiro.</td></tr><tr><td>400</td><td>O usuário está inativo ou bloqueado.</td><td>O usuário do Zoom de destino não pode ser atualizado em 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:Edit".</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 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. Liberte 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 ao 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 ao longo dos ciclos.</td></tr></tbody></table>

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

Um valor que o Zoom aceita, mas que não corresponde a nada — um nome de unidade com um espaço no final, ou um nome de Função que desde então foi renomeado no Zoom — pode ser aceito sintaticamente e não ser aplicado a nada. Nenhuma entrada de log sinaliza essa ocorrência. As variantes específicas de plataforma do mesmo problema são abordadas 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 o SCIM com 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 um valor diretamente a 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 é ativado.
* O `Colaboração` valor de `tipo de utilizador` não é compatível com o Entra ID devido a uma limitação específica da Microsoft.

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

A configuração de provisionamento padrão pode ser realizada a partir de qualquer um dos `entra.microsoft.com` ou `portal.azure.com`. O editor de esquema usado na Etapa 1, porém, só é acessível por meio do URL do Portal do Azure com o `forceSchemaEditorEnabled` parâmetro anexado. Esse sinalizador não tem efeito sobre `entra.microsoft.com`. Use o link do Portal do Azure na Etapa 1 para todas as etapas desta parte para evitar trocar de portal no meio da configuração.
{% endhint %}

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

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

1. Inicie sessão no Portal do Azure usando o 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 **Gerenciar**, clique **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. Geralmente é chamado de **Zoom** ou **Zoom SSO**, mas pode ser diferente no seu locatário.
5. No menu de navegação à esquerda, em **Gerenciar**, clique **Provisionamento**.\
   **Nota**: O Azure atualmente apresenta um de dois layouts. Na experiência legada, selecione **Editar mapeamentos de atributos** em **Gerenciar provisionamento**. Na experiência mais recente, a página é aberta em uma **Visão geral** aba; selecione **Provisionamento** novamente no menu à esquerda. Ambos os caminhos chegam ao mesmo destino.
6. Clique em **Mapeamentos** menu suspenso, depois clique em **Provisionar Utilizadores do Microsoft Entra ID**.\
   **Nota**: Em inquilinos que ainda exibem nomenclatura legada, esta opção aparece como **Provisionar usuários do Azure Active Directory**.
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 complete o seguinte:
   * **Nome**: Inserir a cadeia de atributos completa, por exemplo `urn:ietf:params:scim:schemas:extension:zoom:1.0:User: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" %}
**Atenção**

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 `verdadeiro` ou `false`. Selecionar **Cadeia de caracteres** é muitas vezes mais prático quando a origem é um atributo de extensão do Entra, que armazena texto.
{% endhint %}

### Passo 2: Mapear 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>Use 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 variado por 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. Voltar para **Provisionamento** → **Mapeamentos** → **Provisionar Utilizadores do Microsoft Entra ID**.
2. No canto inferior esquerdo, clique **Adicionar Novo Mapeamento**.
3. Configurar o mapeamento de acordo com o tipo selecionado — consulte a orientação abaixo.
4. Clique em **Atributo de destino** menu suspenso e Selecionar o atributo declarado na Etapa 1.
5. Clique em **Corresponder objetos usando este atributo** menu suspenso 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 utilizadores do Entra com utilizadores do Zoom — normalmente `Nome de usuário` — deve ser definido como **Sim**.
6. Clique em **Aplicar este mapeamento** menu suspenso e Selecionar **Sempre**, de modo que o valor se aplica tanto na criação quanto nas atualizações subsequentes.
7. Clique **OK**.
8. Repita para cada atributo e depois clique **Salvar** na parte superior do **Mapeamento de atributos** página.

#### <mark style="color:azul;">O mapeamento direto passa 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, caractere por caractere
* **Valor padrão se nulo (Opcional)**: Uma alternativa aplicada 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á contém valores que correspondem exatamente aos nomes das unidades do Zoom Phone, mapeá-lo diretamente não requer nenhuma lógica.

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

Preencha **Valor padrão se nulo** sempre que um valor de origem ausente pudesse causar uma falha ou um resultado indesejado. Um padrão de `Unidade principal` em um mapeamento de unidade garante que os usuários sem uma Localização de escritório ainda sejam provisionados com êxito, em vez de cair em um estado indefinido.
{% endhint %}

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

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

O mapeamento constante é adequado para implantações de configuração única e também é o mecanismo por trás de vários comportamentos específicos do Zoom. Definir `zoomPhoneExtNumber` para um valor constante de `0` instrui o Zoom a Atribuir o Próximo(a) ramal Disponível dentro da unidade do usuário, eliminando completamente conflitos de ramal.

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

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

O mapeamento por expressão é necessário sempre que o valor do diretório e o valor do Zoom não forem a mesma string:

```
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 a capitalização. `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 com a configuração errada sem aviso.
{% endhint %}

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

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

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

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

* **Localização de uso** é imposto pela Microsoft para sempre conter um código ISO 3166-1 alfa-2 válido, como `GB`, porque rege a disponibilidade da licença e dos Recursos. Este campo é confiável.
* **País ou região** não impõe essa validaçã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 geralmente são preenchidos com `GB` — por convenção, não por validação.

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

### Etapa 3: Inclua usuários e grupos no 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 implantação.

1. Navegue para **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 desejado.
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 nomenclaturas legadas que estão sendo descontinuadas ou destinadas 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 a licença paga.</td></tr><tr><td><strong>Licenciado</strong></td><td>Atribui o plano de licença da conta Zoom <em>padrão</em> plano de licença, por exemplo Zoom Workplace empresarial Plus. Esta tela não permite escolher um pacote específico; o padrão é configurado do lado do Zoom.</td></tr></tbody></table>

Essa 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 Zoom**, que está desativado por padrão:

1. Navegue para **Provisionamento** → **Mapeamentos** e Selecionar **Provisionar grupos do Microsoft Entra ID**.
2. Alternar **Ativado** para **Sim**.
3. Confirme se os mapeamentos padrão estão em vigor: `displayName` → `displayName`, e `membros` → `membros`.
4. Clique **Salvar**.
5. Voltar para **Usuários e grupos** e confirme se o próprio grupo está atribuído ao aplicativo, não apenas 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 do grupo do Entra `displayName` exatamente como foi digitado. O grupo é criado com membros, mas **sem nenhuma configuração de produto**. Um administrador ainda precisa abrir [**Centro de administração**](https://zoom.com/account) → **Usuários** → [**Grupos**](https://zoom.com/account/group#/) no Portal web do Zoom e aplicar as Configurações pretendidas — políticas do Zoom Phone no nível do grupo, permissões de chamada ou outra configuração de produto. O SCIM provisiona a existência e a associação de membros de um grupo; ele não define o que esse grupo faz no Zoom.
{% endhint %}

### Etapa 4: valide com Provisionamento sob demanda

**Provisionamento sob demanda** funciona independentemente do **Status de provisionamento** o Alternar, razão pela qual é a ferramenta correta para validação. Todas as etapas até este ponto — incluindo esta — podem ser concluídas enquanto o provisionamento permanece desativado.

1. Navegue para **Provisionamento** → **Visão geral do provisionamento**.
2. Clique **Provisionamento sob demanda**.
3. Pesquise e selecione um único usuário de teste e, em seguida, clique **Provisionamento**.
4. Revise o resultado. O Entra relata as quatro etapas que executa para cada Evento de provisionamento — **Importar**, **Determinar se está no âmbito**, **Corresponder**, e **Provisionamento** — cada uma expansível individualmente.
5. Confirme se os valores dos atributos mostrados correspondem à sua intenção.
6. Iniciar sessão no Portal web do Zoom e confirmar que a configuração foi aplicada.

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

Valide com um usuário que represente o *mais difícil* caso na sua população — um usuário no estrangeiro, um usuário criado através de um método diferente ou um usuário cujo campo de origem está vazio. Um teste que cubra apenas o caso simples 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 ao vivo para cada usuário no escopo. Conclua e verifique primeiro as Etapas 1 a 4.

1. Navegue para **Microsoft Entra ID** → **Aplicativos empresariais** → seu aplicativo Zoom → **Provisionamento** → **Provisionamento**.
2. Alternar **Status de provisionamento** para **Ativado**.
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 participantes, alterações de atributos e desativações são sincronizados nessa Agendar, em vez de imediatamente.

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

1. Navegue para **Microsoft Entra ID** → **Aplicativos empresariais** → seu aplicativo Zoom → **Monitorar** → **Logs de provisionamento**.
2. Pesquise ou filtre pelo usuário de teste, depois, Selecionar o Evento relevante. A visualização de detalhes se abre com quatro abas: **Passos**, **Soluçã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 **Solução de problemas e recomendações**, que exibe a ação tentada, o nome principal do usuário afetado e — sob **Detalhes** — o código de erro e a mensagem de erro completa retornados pela API do Zoom.

Esta opção é mais fiável do que inspecionar a tela de mapeamento, porque mostra os valores literais transmitidos, e não aquilo que o mapeamento deveria produzir. Quando o registo do Entra não for conclusivo, consulte os registos de ligar do Zoom App Marketplace descritos em **Verificação do lado do Zoom e erros comuns**, que Mostrar a troca bruta de solicitação e resposta.

#### <mark style="color:azul;">Integração e comportamento de desligamento 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 qualquer mapeamento nesta configuração.
* Desativar um usuário no Entra, ou removê-lo do escopo, reverte o provisionamento automaticamente e fecha o ciclo de desativação.
* Cada falha produz uma entrada de registo correspondente — com a ressalva de falha silenciosa mencionada acima.

### Passo 7: Aplique 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. Aqui são fornecidos apenas os mapeamentos do Entra.

**Cenário 0 — Departamento.** No Passo 1, declare `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:departamento` como **Cadeia de caracteres**, tendo o cuidado de usar o namespace empresarial em vez do namespace do Zoom. Mapeie-o como **Direto** do Entra `department` campo. Não **Valor padrão se nulo** é necessário — um campo de origem vazio simplesmente não envia nada, e nenhum objeto do lado do Zoom precisa existir.

**Cenário 1 — unidade do Zoom Phone e extensão automática.** Mapear `zoomPhoneSite` como **Direto** de `physicalDeliveryOfficeName`, com **Valor padrão se nulo** definido como `Unidade principal`. Mapear `zoomPhoneExtNumber` como **Constante** com um valor de `0` a menos que esteja migrando uma configuração preexistente de extensões. Quando os valores de Localização do escritório não corresponderem exatamente aos nomes das unidades do Zoom, substitua uma **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 consegue obter um valor de um grupo, é necessária uma expressão. Estenda-a com camadas adicionais `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 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 um **Expressão** orientado por um campo de diretório que diferencia os níveis de agente e `zoomContactCenterRole` como **Direto** de um campo que contém o nome da Função. Sair/sair `zoomContactCenterRegion` não mapeado em implantações de região única.

## **Configurando o 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 importantes aqui, e entender 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 de usuário do aplicativo Zoom** é onde um valor é *enviado* ao Zoom, e seus atributos contêm o nome externo e o namespace do SCIM. Uma configuração por usuário precisa de ambos, além de um mapeamento que os conecte. Uma configuração no 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 o Zoom. Declará-lo é uma ação única por atributo.

1. Iniciar sessão no painel de administração do Okta.
2. No menu de navegação à esquerda, clique **Aplicativos**, depois clique em **Aplicativos**.
3. Em **STATUS**, clique **ATIVO**.
4. Clique em **Zoom** aplicativo.\
   **Nota**: O nome do aplicativo é definido pelo administrador do Okta quando o aplicativo é criado. Ele é frequentemente denominado **Zoom**, mas pode ser diferente no seu locatário.
5. Clique em **Provisionamento** aba.
6. Em **Mapeamentos de Atributos do Zoom**, clique **Acessar o Editor de Perfil**.
7. Em **Atributos**, clique **+ Adicionar atributo**.
8. Conclua o seguinte:
   * **Tipo de dados**: Selecionar **string** ou **booleano**, correspondente à referência da API SCIM2.
   * **Nome de Exibir**: 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:User:zoomPhoneSite`
   * **Descrição** (Opcional): gravar por que o atributo existe e de onde vêm 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 da 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 do namespace isoladamente. Isso difere da convenção genérica SCIM. Siga o formato mostrado acima, pois ele reflete a configuração que a Zoom documenta como funcional.

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

### Etapa 2: Crie um atributo de origem no perfil do usuário 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 for fornecido no nível de grupo em vez disso.

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

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

Use o mesmo nome para o atributo de perfil do 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 **Enum** opção sempre que o Zoom documentar um conjunto fixo de valores — pacotes de central de contato, códigos de pacote do Workplace, valores do plano do Revenue Accelerator. Limitar o campo no momento da entrada evita que um erro de digitação se transforme em uma falha silenciosa de provisionamento que só aparece semanas depois como um direito ausente.

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

1. Navegue para **Aplicativos** → **Aplicativos** → **ATIVO** → o **Zoom** aplicativo.
2. Clique em **Provisionamento** aba.
3. Em **Mapeamentos de Atributos do Zoom**, localize o atributo declarado na Etapa 1 e clique no ícone de edição à sua direita.\
   **Nota**: Se o atributo não estiver visível, clique **Mostrar Atributos Não Mapeados**.
4. Clique em **Valor do atributo** menu suspenso e Selecionar **Mapear do perfil do Okta**.
5. Clique na lista suspensa da origem — que exibe `login | string` 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 deliberadamente, para valores que não devem ser substituídos após a atribuição inicial; Selecionar **Criar e atualizar** nos demais casos, para que as alterações no diretório se propaguem.
7. Clique **Salvar**.
8. Repita para cada atributo.

{% hint style="warning" %}
**Atenção: Derivar ou traduzir 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** campo também aceita o Idioma de Expressão do Okta, que oferece suporte à lógica condicional e a funções de string. A sintaxe da expressão e as funções disponíveis 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 em maior escala e consulte a documentação atual do Idioma de Expressão do Okta para ver as funções compatíveis.

Quando a tradução é simples e o conjunto de valores é pequeno, definir o valor do Zoom diretamente no atributo do Okta como uma lista enumerada — ou usar um atributo no nível de grupo, como na Etapa 5 — geralmente é mais fácil de manter 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 para **Aplicativos** → **Aplicativos** → **ATIVO** → o **Zoom** aplicativo.
2. Clique em **Provisionamento** aba.
3. Em **Provisionamento para o aplicativo**, clique **Editar**.
4. Habilite as Configurações descritas abaixo e, em seguida, 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.                                                                                           |
| **Atualizar 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 do Okta não irão Alterar o valor correspondente no Zoom. |
| **Desativar usuários**             | Desativa a conta Zoom quando o aplicativo não é atribuído no Okta, ou quando a conta Okta é desativada. As contas podem ser reativadas ao Atribuir novamente o aplicativo.         |

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

**Atualizar atributos do usuário** é o que faz com que os mapeamentos de atributos personalizados entrem em vigor para 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 irá Alterar o valor correspondente no Zoom.
{% endhint %}

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

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

1. Navegue para **Diretório** → **Pessoas** e clique no nome do usuário.
2. Clique em **Perfil** aba, então 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 alteração 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 que o atributo foi declarado na Etapa 1 com **Tipo de atributo: grupo**. Se foi declarado como **Pessoal**, defina um equivalente ao nível do grupo repetindo a Etapa 1 no **usuário do Zoom** perfil abaixo do **Diretório** → **Editor de Perfil** → **Usuários** → **Todos**, selecionando **grupo** como o tipo de atributo.
2. Navegue para **Diretório** → **Grupos** → o **Todos** aba, então clique **Adicionar grupo**.
3. Insira um **Nome** e uma **Descrição**, depois clique em **Salvar**.
4. Abra o grupo e clique no **Aplicativos** aba.
5. Clique **Atribuir aplicativo**, depois clique em **Atribuir** à direita do **Zoom** aplicativo.
6. Preencha os atributos de nível do grupo com os valores que devem se aplicar a todos os Membros.
7. Clique **Guardar e voltar**, depois clique em **Concluído**.
8. Clique no grupo **Pessoas** aba, então 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 atributo do grupo. Os usuários adicionados mais tarde herdam-nos ao ingressar, o que torna este padrão duradouro para 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 é membro de mais de um grupo que fornece um valor para o mesmo atributo, o Okta transmite o valor do grupo com maior prioridade.

1. Navegue para **Aplicativos** → **Aplicativos** → **ATIVO** → o **Zoom** aplicativo.
2. Clique em **Atribuições** aba.
3. Em **Filtros**, clique **Grupos**.
4. Arraste e solte os grupos na ordem pretendida.

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

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

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

1. Navegue para **Denunciar** → **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 revise o detalhe, que inclui 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, passe para os registros de ligar do Zoom App Marketplace descritos em **Verificação do lado do Zoom e erros comuns**, que Mostrar a troca bruta de solicitação e resposta.

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

Um atributo declarado no perfil do usuário do Zoom, mas nunca mapeado, ou mapeado sem **Atualizar atributos do usuário** habilitado 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 System Log 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 nenhum mapeamento nesta configuração.
* Com **Desativar usuários** habilitado, desatribuir o aplicativo ou desativar a conta do Okta desativa a conta Zoom automaticamente.
* Reatribuir o aplicativo reativa uma conta Zoom previamente desativada, o que torna o pertencimento ao grupo um mecanismo viável para gerenciar quem sai e quem retorna.

### Etapa 7: Aplique 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. Aqui é fornecida apenas a configuração do Okta.

**Cenário 0 — Departamento.** Na Etapa 1, declare o atributo com **Nome de Exibir** e **Nome da variável** `department`, **Nome externo** `department`, 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 do Okta já contém um `department` atributo, portanto 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 da extensão empresarial**

O AVISO na Etapa 1 descreve a convenção do Zoom de acrescentar o nome do atributo ao namespace External. Essa orientação está documentada para atributos na extensão Zoom. `department` 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 acréscimo — `urn:ietf:params:scim:schemas:extension:empresarial:2.0:usuário:departamento` — e confirme qual forma foi bem-sucedida no registro de chamadas do Marketplace.
{% endhint %}

**Alternativas se `department` já estiver mapeado.** Qualquer um dos itens a seguir se comporta de forma idêntica, fica sob o mesmo pai e não traz pré-condições — substitua o nome do atributo tanto na **Nome externo** quanto no namespace, e adicione um atributo de origem correspondente na Etapa 2, se o perfil do Okta ainda não contiver um:

| Atributo          | Notas                                                                                                                                                                        |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `centro de custo` | campo Corporativa, varia entre usuários, de modo que um valor incorreto fica visível                                                                                         |
| `Organização`     | Frequentemente idêntico entre todos os usuários, o que torna um erro mais difícil de detectar                                                                                |
| `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 — unidade 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 o pertencimento ao grupo determine a unidade diretamente e nenhuma lógica de tradução seja necessária. Declare `zoomPhoneExtNumber` como um atributo pessoal com um valor padrão de `0` a menos que você esteja migrando uma configuração preexistente de extensões.

**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 em cada atribuição do aplicativo Zoom do grupo. Os usuários herdam o plano correto por meio do pertencimento, e o valor armazenado no Okta é o valor exato que o Zoom espera. Isso também torna a configuração visível e auditável a partir da **Atribuições** aba, e isso resiste a inconsistências na forma como os dados do diretório subjacente foram preenchidos. Um grupo que contém `-1` oferece uma forma limpa de desprovisionar direitos 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 restringido aos três valores permitidos, de modo 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/sair `zoomContactCenterRegion` 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
