---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Pesquisa com IA API Mapeamento de usuário externo

# Pesquisa com IA API Mapeamento de usuário externo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

A API Mapeamento de usuário externo da Pesquisa com IA fornece endpoints que permitem a ingestão de informações de mapeamento de usuário de fontes externas no índice da aplicação ServiceNow® Pesquisa com IA.

## Pesquisa com IA Mapeamento de usuário externo - POST /ais/external_content/user_mapping/import_multiple/{target_table} {#ariaid-title2}

Importa uma lista de mapeamentos de usuário externo para uma tabela de mapeamento de usuário Pesquisa com IA. Cada mapeamento especifica aliases de usuário e grupo definidos externamente para um usuário Now Platform. Pesquisa com IA usa esses aliases para determinar quais resultados de pesquisa de documento externo o usuário pode exibir.
Para saber como Pesquisa com IA a segurança de conteúdo externo utiliza mapeamentos de usuário externo, consulte [Segurança de conteúdo externo para Pesquisa com IA](https://www.servicenow.com/docs/access?context=external-content-security-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

Os nomes de usuário e grupo em mapeamentos de usuário externo devem corresponder aos especificados nas permissões de acesso de segurança para documentos externos ingeridos por meio do endpoint POST /ais/external_content/ingestDocument/{schema_table_name} da API de ingestão de conteúdo externo. Para obter mais informações sobre como ingerir documentos externos com permissões de acesso de segurança para usuários e grupos definidos externamente, consulte [API de ingestão de conteúdo externo](https://servicenow-prod.fluidtopics.net/nDBQAalH57pSUkgDP17Rmw#external-content-ingestion-api "A API de ingestão de conteúdo externo fornece endpoints que permitem a ingestão de conteúdo de fontes fora da sua instância [ ServiceNow para o índice da aplicação ServiceNow Pesquisa com IA.").

Para exibir históricos de importação de registros de mapeamento de usuário externo importados por meio deste endpoint, navegue até Pesquisa com IAConteúdo ExternoHistórico de importação de mapeamento de usuário. Em um registro de histórico, você pode exibir os registros do Conjunto de importação \[sys_import_set\] e do Conjunto de importação múltipla \[sys_multi_import_set\] para uma tarefa de importação. Use as informações desses registros para verificar se os mapeamentos de usuário externo foram importados corretamente.

### Formato da URL

URL com controle de versões: /api/now/{api_version}/ais/external_content/user_mapping/import_multiple/{target_table}

### Parâmetros de solicitação compatíveis

{#ext_user_map-POST-import_multiple__entry__2}{#ext_user_map-POST-import_multiple__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| target_table | O nome da tabela de mapeamento de usuário Pesquisa com IA na qual você deseja que os mapeamentos importados apareçam. Por exemplo, <kbd class="ph userinput">x_snc_sharepoint_user_table</kbd>. Nota: Você deve criar a tabela de mapeamento de usuário de destino Pesquisa com IA por meio de Pesquisa com IAConteúdo ExternoCriar mapeamento de usuário módulo antes de usar este endpoint. Se você especificar uma tabela de mapeamento de usuário que não existe, a solicitação falhará. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#ext_user_map-POST-import_multiple__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#ext_user_map-POST-import_multiple__entry__12}

| Nome | Descrição |
|-|-|
| {objeto} | Obrigatório. Objeto sem nome. Tipo de dados: objeto { "records": [Array] } |
| {object}.registros | Obrigatório. Matriz de objetos na qual cada objeto representa um mapeamento de usuário a ser importado para a tabela de destino especificada. Tipo de dados: matriz "records": [ { "external_group": [Array], "external_user": [Array], "mapping_value": "String" } ] |
| {object}.records.external_group | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um grupo definido externamente a ser definido como um alias para o usuário Now Platform especificado pelo parâmetro {object}.records.mapping_value. Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes dos grupos definidos externamente selecionados para o mapeamento de usuário. Os exemplos incluem: "external_group": [ "itil", "hr-admin", "report-dev" ] |
| {object}.records.external_user | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um usuário definido externamente a ser definido como um alias para o usuário Now Platform especificado pelo parâmetro {object}.records.mapping_value. Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes das contas de usuário definidas externamente selecionadas para o mapeamento de usuário. Os exemplos incluem: "external_user": [ "beth-anglin", "ad\beth.anglin", "beth-anglin@sharepoint" ] |
| {object}.records.mapping_value | Valor do campo de e-mail que identifica exclusivamente um registro existente na tabela Usuário \[sys_user\]. Todos os aliases de usuário e grupo definidos externamente na solicitação são mapeados para o usuário Now Platform com este endereço de e-mail. Nota: A API trata este parâmetro como o identificador exclusivo do registro de mapeamento de usuário. Se você importar outro mapeamento de usuário com o mesmo mapping_value de um registro de mapeamento de usuário existente, o novo registro substituirá o registro existente. Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_user_map-POST-import_multiple__entry__24}{#ext_user_map-POST-import_multiple__accept-JSON-only-entry-RESTAPI}{#ext_user_map-POST-import_multiple__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]

{#ext_user_map-POST-import_multiple__entry__30}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_user_map-POST-import_multiple__entry__34}{#ext_user_map-POST-import_multiple__entry-400-status-code}{#ext_user_map-POST-import_multiple__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 201 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML)

{#ext_user_map-POST-import_multiple__entry__42}

| Nome | Descrição |
|-|-|
| erro | Objeto que descreve o erro encontrado durante o processamento da solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| import_set_id | Sys_id do novo registro criado na tabela Conjunto para importação \[sys_import_set\] por uma solicitação bem-sucedida. Tipo de dados: cadeia de caracteres |
| multi_import_set_id | Sys_id do novo registro criado na tabela Conjunto para importação múltipla \[sys_multi_import_set\] por uma solicitação bem-sucedida. Tipo de dados: cadeia de caracteres |
| resultado | Resultado de uma solicitação malsucedida. Inclui uma mensagem que descreve o motivo da falha na solicitação. Tipo de dados: cadeia de caracteres |
| status | Status de uma solicitação malsucedida. Valores válidos: * failure {#ext_user_map-POST-import_multiple__ul_h5r_z54_pnb} Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Importe aliases de usuário e grupo definidos externamente para Now Platform usuários Beth Anglin e Abel Tuter para uma tabela de mapeamento de usuário Pesquisa com IA chamada x_snc_sharepoint_user_table.

    curl -X POST 'https://instance.servicenow.com/api/now/v1/ais/external_content/user_mapping/import_multiple/x_snc_sharepoint_user_table' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
        "records": [
          {
            "mapping_value": "beth.anglin@example.com",
            "external_user": [
              "ad\beth-anglin",
              "beth.anglin@sharepoint"
            ],
            "external_group": [
              "itil",
              "itil-admin",
              "itil-dev"
            ]
          },
          {
            "mapping_value": "abel.tuter@example.com",
            "external_user": [
              "ad\abel-tuter",
              "abel.tuter@sharepoint"
            ],
            "external_group": [
              "hr",
              "hr-admin",
              "hr-dev"
            ]
          }
        ]
      }'

A resposta mostra os sys_ids dos registros de Conjunto para importação e Conjunto para importação múltipla gerados.

    {
      "import_set_id": "6e9ddb629d987010f877878bd9f0e9dd",
      "multi_import_set_id": "269ddb629d987010f877878bd9f0e9de"
    }

### Solicitação de cURL {#ext_user_map-POST-import_multiple__example_qz3_1pz_spb}

Importar solicitação inválida que contém um registro de mapeamento vazio.

    curl 'https://instance.servicenow.com/api/now/v1/ais/external_content/user_mapping/import_multiple/u_ext_content_user_mapping' \
      --request POST \
      --user 'username':'password' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
        "records": [
          {
            "mapping_value": "beth.anglin@example.com",
            "external_user": [
              "ad\beth-anglin",
              "beth.anglin@sharepoint"
            ],
            "external_group": [
              "reports",
              "reports-admin",
              "reports-dev"
            ]
          },
          {}
        ]
      }'

A solicitação falha com status 400 e a resposta indica a natureza da falha.

    {
      "result": "Error in processing the message"
    }