---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# KI-Suche Zuordnungs-API für externe Anwender

# KI-Suche Zuordnungs-API für externe Anwender {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die API für die externe Anwenderzuordnung der KI-Suche bietet Endpunkte, die die Erfassung von Anwenderzuordnungsinformationen aus externen Quellen im Index der Anwendung ServiceNow® KI-Suche ermöglichen.

## KI-Suche Externe Anwenderzuordnung -- POST /ais/external_content/user_mapping/import_multiple/{target_table} {#ariaid-title2}

Importiert eine Liste externer Anwenderzuordnungen in eine Anwenderzuordnungstabelle KI-Suche. Jede Zuordnung gibt extern definierte Benutzer- und Gruppenaliasse für einen Benutzer Now Platform an. KI-Suche verwendet diese Aliasse, um zu bestimmen, welche externen Dokumentsuchergebnisse der Benutzer anzeigen kann.
Informationen dazu, wie die Sicherheit externer Inhalte KI-Suche externe Benutzerzuordnungen verwendet, finden Sie unter [Sicherheit externer Inhalte für die KI-Suche](https://www.servicenow.com/docs/access?context=external-content-security-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

Anwender- und Gruppennamen in externen Anwenderzuordnungen müssen mit den Namen übereinstimmen, die in den Sicherheitszugriffsberechtigungen für externe Dokumente angegeben sind, die über den Endpunkt POST /ais/external_content/ ingestDocument/{schema_table_name} der API zur Erfassung externer Inhalte erfasst wurden. Weitere Informationen zum Erfassen externer Dokumente mit Sicherheitszugriffsberechtigungen für extern definierte Benutzer und Gruppen finden Sie unter [API zur Erfassung externer Inhalte](https://www.servicenow.com/docs/VAvTuYKF8yNvp9slvCfNSA#external-content-ingestion-api "Die API zur Erfassung externer Inhalte bietet Endpunkte, die die Erfassung von Inhalten aus Quellen außerhalb Ihrer Instanz ServiceNowServiceNow KI-Suche im Index der Anwendung [] ermöglichen.").

Um Importverläufe für externe Anwenderzuordnungsdatensätze anzuzeigen, die über diesen Endpunkt importiert wurden, navigieren Sie zu KI-SucheExterner InhaltImportverlauf von Anwenderzuordnungen. Von einem Verlaufsdatensatz aus können Sie die Datensätze „Importsatz" \[sys_import_set\] und „Multi-Importsatz" \[sys_multi_import_set\] für eine Importaufgabe anzeigen. Verwenden Sie Informationen aus diesen Datensätzen, um sicherzustellen, dass Ihre externen Anwenderzuordnungen ordnungsgemäß importiert wurden.

### URL-Format

URL mit Versionsangabe: /api/now/{api_version}/ais/external_content/user_mapping/import_multiple/{target_table}

### Unterstützte Anforderungsparameter

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

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel <kbd class="ph userinput">v1</kbd> oder <kbd class="ph userinput">v2</kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| target_table | Der Name der Anwenderzuordnungstabelle KI-Suche, in der die importierten Zuordnungen angezeigt werden sollen. Beispiel: <kbd class="ph userinput">x_snc_sharepoint_user_table</kbd>. Hinweis: Sie müssen die Zuordnungstabelle für Zielbenutzer KI-Suche über erstellen KI-SucheExterner InhaltAnwenderzuordnung erstellen Modul, bevor Sie diesen Endpunkt verwenden. Wenn Sie eine nicht vorhandene Anwenderzuordnungstabelle angeben, schlägt die Anforderung fehl. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfadparameter]

{#ext_user_map-POST-import_multiple__entry__8}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#ext_user_map-POST-import_multiple__entry__12}

| Name | Beschreibung |
|-|-|
| {Objekt} | Erforderlich. Unbenanntes Objekt. Datentyp: Objekt { "records": [Array] } |
| {object}.records | Erforderlich. Array von Objekten, in dem jedes Objekt eine Anwenderzuordnung für den Import in die angegebene Zieltabelle darstellt. Datentyp: Array "records": [ { "external_group": [Array], "external_user": [Array], "mapping_value": "String" } ] |
| {object}.records.external_group | Array von Zeichenfolgen, wobei jede Zeichenfolge der Name einer extern definierten Gruppe ist, die als Alias für den Anwender Now Platform festgelegt werden soll, der durch den Parameter „ {object}.records.mapping_value " angegeben wird. Datentyp: Array Die Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der extern definierten Gruppen, die für die Benutzerzuordnung ausgewählt wurden. Beispiele: "external_group": [ "itil", "hr-admin", "report-dev" ] |
| {object}.records.external_user | Array von Zeichenfolgen, wobei jede Zeichenfolge der Name eines extern definierten Anwenders ist, der als Alias für den Anwender Now Platform festgelegt werden soll, der durch den Parameter „ {object}.records.mapping_value " angegeben wird. Datentyp: Array Die Werte können in einem beliebigen Format vorliegen, abhängig von den Namen der extern definierten Anwenderaccounts, die für die Anwenderzuordnung ausgewählt wurden. Beispiele: "external_user": [ "beth-anglin", "ad\beth.anglin", "beth-anglin@sharepoint" ] |
| {object}.records.mapping_value | E-Mail -Feldwert, der einen vorhandenen Datensatz in der Tabelle „Benutzer" \[sys_user\] eindeutig identifiziert. Alle extern definierten Aliasse für Anwender und Gruppen in der Anforderung werden dem Anwender Now Platform mit dieser E-Mail-Adresse zugeordnet. Hinweis: Die API behandelt diesen Parameter als eindeutigen Bezeichner für den Anwenderzuordnungsdatensatz. Wenn Sie eine andere Anwenderzuordnung mit dem gleichen Zuordnungswert ( map_value) eines vorhandenen Anwenderzuordnungsdatensatzes importieren, überschreibt der neue Datensatz den vorhandenen Datensatz. Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstextparameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#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}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
[Tabelle : 4. Anforderungskopfzeilen]

{#ext_user_map-POST-import_multiple__entry__30}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwortkopfzeilen]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Parameter des Antworttexts (JSON oder XML)

{#ext_user_map-POST-import_multiple__entry__42}

| Name | Beschreibung |
|-|-|
| Fehler | Objekt, das den Fehler beschreibt, der bei der Verarbeitung der Anforderung aufgetreten ist. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der bei der Verarbeitung der Anforderung aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der bei der Verarbeitung der Anforderung aufgetreten ist. Datentyp: Zeichenfolge |
| import_set_id | Sys_id für den neuen Datensatz, der in der Importsatz-Tabelle \[sys_import_set\] durch eine erfolgreiche Anforderung erstellt wurde. Datentyp: Zeichenfolge |
| multi_import_set_id | Sys_id für den neuen Datensatz, der in der Tabelle „Multi-Importsatz" \[sys_multi_import_set\] durch eine erfolgreiche Anforderung erstellt wurde. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnis für eine nicht erfolgreiche Anforderung. Enthält eine Nachricht, die den Grund für den Fehler bei der Anforderung beschreibt. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Gültige Werte: * failure {#ext_user_map-POST-import_multiple__ul_h5r_z54_pnb} Datentyp: Zeichenfolge |
[ ]

### cURL-Anforderung

Importieren Sie extern definierte Anwender- und Gruppenaliasse für die Now Platform -Anwender Beth Anglin und Abel Tuter in eine KI-Suche -Anwenderzuordnungstabelle mit dem Namen 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"
            ]
          }
        ]
      }'

Die Antwort zeigt die sys_ids für die generierten Datensätze für Importsätze und Multi-Importsätze.

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

### cURL-Anforderung {#ext_user_map-POST-import_multiple__example_qz3_1pz_spb}

Importieren Sie eine ungültige Anforderung, die einen leeren Zuordnungsdatensatz enthält.

    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"
            ]
          },
          {}
        ]
      }'

Die Anforderung schlägt mit dem Status 400 fehl, und in der Antwort wird die Art des Fehlers angegeben.

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