SCIM2ClientUtil – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer
  • Die SCIM2ClientUtil Die API stellt Dienstprogrammmethoden bereit, um die eindeutigen Bezeichner von externen Anbietersystemen abzurufen und diese Informationen dann beim Aufrufen von zu verwenden SCIM2Client API.

    Diese API wird in ausgeführt sn_auth Namespace und erfordert die Installation des Plugins SCIM v2 – ServiceNow Cross-Domain Identity Management Client (com.snc.integration.scim2.client), um auf die API zuzugreifen.

    Weitere Informationen zu SCIM finden Sie unter System für domänenübergreifendes Identitätsmanagement (SCIM) .

    SCIM2ClientUtil – getProviderIdByFilter(Zeichenfolgenanbieter, Zeichenfolge ResourceName, Zeichenfolgenfilter)

    Gibt den eindeutigen Bezeichner einer angegebenen Ressource aus einem angegebenen externen Anbietersystem für eine eindeutige Ressourcen-ID in zurück ServiceNow Instanz, die einen Filterausdruck verwendet, um die gewünschte Ressource zu beschreiben.

    Diese API ist bei der Zuordnung nützlich ServiceNow Felder zu SCIM-Feldern, in denen der Ressourcenbezeichner im externen Anbietersystem benötigt wird. Vor dem Aufrufen dieser Methode muss ein eindeutiges Feld für die Ressource in der Systemattribut-Zuordnung definiert werden, die sich in der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_Provider_resource_Mapping] befindet.

    Weitere Informationen zur Zuordnung von Anbieterressourcen finden Sie unter Create a SCIM Provider Resource Mapping.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Anbieter Zeichenfolge Name des konfigurierten SCIM-Service Providers.

    Tabelle: Im Namensfeld der Tabelle „SCIM-Provider“ [sys_scim_Provider].

    resourceName Zeichenfolge Name des Ressourcentyps, z. B. Anwender oder Gruppe.

    Tabelle: Im Feld resource_Name der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_Provider_resource_Mapping].

    Filter Zeichenfolge Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll.

    Weitere Informationen zu den verfügbaren Filterparametern und dem zugehörigen Format finden Sie im folgenden Abschnitt im Internet Engineering Task Force-Dokument: System für domänenübergreifendes Identitätsmanagement: Protokoll

    https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2

    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutiger Ressourcenbezeichner, der vom externen Service Provider verwendet wird.

    Löst eine Ausnahme aus, wenn beim Abrufen der Informationen ein Problem auftritt.

    Das folgende Beispiel zeigt, wie der Ressourcenbezeichner des Anwenders mithilfe des Filters abgerufen wird „Anwendername eq „abel.tuter““ .

    var response = sn_auth.SCIM2ClientUtil.getProviderIdByFilter('SNOW Provider','User','username eq "abel.tuter"'); 
    gs.info('response: ' + response);

    Ausgabe:

    
     "005d500b536073005e0addeeff7b12f4"
    

    Das folgende Beispiel zeigt, wie Sie ein Skript verwenden, um den Ressourcenbezeichner des Managers mithilfe des Filters abzurufen „Anwendername eq“ „“ + Manager + „““ .

    (function getValue(resourceGR) {
      try {
        var manager = resourceGR.manager.user_name;
        return sn_auth.SCIM2ClientUtil.getProviderIdByFilter('SCIM Provider Demo', 'User', 'userName eq "' + manager + '"');
      } catch (e) {
        gs.error('Unable to get attribute value using script' + e);
        // Handle failure scenario here
      }
    })(resourceGR);

    Ausgabe:

    
      "125d500b535973005e0addeeff8c12a2"

    SCIM2ClientUtil – getProviderIdByResourceId(Zeichenfolgenanbieter, Zeichenfolge ResourceName, Zeichenfolge resourceId)

    Gibt den eindeutigen Bezeichner einer angegebenen Ressource aus einem angegebenen externen Anbietersystem für eine eindeutige Ressourcen-ID in zurück ServiceNow Instanz.

    Diese API ist bei der Zuordnung nützlich ServiceNow Felder zu SCIM-Feldern, in denen der Ressourcenbezeichner im externen Anbietersystem benötigt wird. Vor dem Aufrufen dieser Methode muss ein eindeutiges Feld für die Ressource in der Systemattributzuordnung definiert werden, das sich in der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_Provider_resource_Mapping] befindet.

    Weitere Informationen zur Zuordnung von Anbieterressourcen finden Sie unter Create a SCIM Provider Resource Mapping.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Anbieter Zeichenfolge Name des konfigurierten SCIM-Service Providers.

    Tabelle: Im Namensfeld der Tabelle „SCIM-Provider“ [sys_scim_Provider].

    resourceName Zeichenfolge Name des Ressourcentyps, z. B. Anwender oder Gruppe.

    Tabelle: Im Feld resource_Name der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_Provider_resource_Mapping].

    resourceId Zeichenfolge SYS_ID der in gespeicherten Ressource ServiceNow Instanz (der Client).

    Tabelle: Im Feld „primary_table“ der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_Provider_resource_Mapping].

    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutiger Ressourcenbezeichner, der vom externen Service Provider verwendet wird.

    Löst eine Ausnahme aus, wenn beim Abrufen der Informationen ein Problem auftritt.

    Das folgende Beispiel zeigt, wie der Ressourcenbezeichner des Anwenders mit der sys_ID f282abf0371020004e0bfc8bcbe5d12 abgerufen wird.

    var response = sn_auth.SCIM2ClientUtil.getProviderIdByResourceId('SNOW Provider','User','f282abf03710200044e0bfc8bcbe5d12'); 
    gs.info('response: ' + response);

    Ausgabe:

    
      "005d500b536073005e0addeeff7b12f4"