SCIM2ClientUtil – Scoped

Die SCIM2ClientUtil- API bietet Dienstprogrammfunktionen, um die eindeutigen Bezeichner externer Anbietersysteme zu erhalten und diese Informationen dann beim Aufruf der SCIM2Client- API zu verwenden.

Diese API wird im sn_auth- Namespace ausgeführt und erfordert die Installation des Plugins „SCIM v2 – ServiceNow Cross-Domain Identity Management Client“ (com.snc.integration.scim2.client), um auf die API zugreifen zu können.

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

SCIM2ClientUtil – getProviderIdByFilter(String provider, String resourceName, String filter)

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

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

Weitere Informationen zur Zuordnung von Provider-Ressourcen finden Sie unter SCIM-Provider-Ressourcenzuordnung erstellen.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Anbieter	Zeichenfolge	Erforderlich. Name des konfigurierten SCIM-Service Providers Der Name des Service Providers wird im Namensfeld der Tabelle „SCIM-Provider“ [sys_scim_provider] definiert.
resourceName	Zeichenfolge	Erforderlich. Name des Ressourcentyps, z. B. Benutzer oder Gruppe. Dieser Wert befindet sich im Feld resource_name in der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_provider_resource_mapping].
filter	Zeichenfolge	Erforderlich. Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Weitere Informationen zu den verfügbaren Filterparametern und dem zugehörigen Format finden Sie im folgenden Abschnitt im Dokument der Internet Engineering Task Force: System für domänenübergreifendes Identitätsmanagement: Protokoll https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2

Tabelle : 2. Ausgabe

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 Sie den Ressourcenbezeichner des Benutzers mithilfe des Filters 'username eq "abel.tuter" erhalten.

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

Antwort:

// Example of a successful response
{
  "005d500b536073005e0addeeff7b12f4"
}

Das folgende Beispiel zeigt, wie ein Skript verwendet wird, um den Ressourcenbezeichner des Managers mithilfe des Filters 'userName eq "' + manager + '"' zuerhalten.

(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);

Antwort:

// Example of a successful response
{
  "125d500b535973005e0addeeff8c12a2"
}

SCIM2ClientUtil – getProviderIdByResourceId(String provider, String resourceName, String resourceId)

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

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

Weitere Informationen zur Zuordnung von Provider-Ressourcen finden Sie unter SCIM-Provider-Ressourcenzuordnung erstellen.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Anbieter	Zeichenfolge	Erforderlich. Name des konfigurierten SCIM-Service Providers Der Name des Service Providers wird im Namensfeld der Tabelle „SCIM-Provider“ [sys_scim_provider] definiert.
resourceName	Zeichenfolge	Erforderlich. Name des Ressourcentyps, z. B. Benutzer oder Gruppe. Dieser Wert befindet sich im Feld resource_name in der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_provider_resource_mapping].
resourceId	Zeichenfolge	Erforderlich. Sys_id der Ressource, die in der Instanz ServiceNow (dem Client) gespeichert ist. Dieser Wert befindet sich im Feld primary_table in der Tabelle „SCIM-Provider-Ressourcenzuordnung“ [sys_scim_provider_resource_mapping].

Tabelle : 4. Ausgabe

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 Sie den Ressourcenbezeichner des Benutzers mit der sys_id f282abf03710200044e0bfc8bcbe5d12 erhalten.

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

Antwort:

// Example of a successful response
{
  "005d500b536073005e0addeeff7b12f4"
}