SCIM2ClientUtil : dans le champ d’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture
  • L’API SCIM2ClientUtil fournit des méthodes utilitaires permettant d’obtenir les identificateurs uniques des systèmes de fournisseurs externes, puis d’utiliser ces informations lors de l’appel de l’API SCIM2Client .

    Cette API s’exécute dans l’espace de noms sn_auth et nécessite l’installation du module d’extension SCIM v2 - Client de gestion des identités interdomaines ServiceNow (com.snc.integration.scim2.client) pour accéder à l’API.

    Pour plus d’informations sur SCIM, voir Système de gestion des identités interdomaines (SCIM).

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

    Renvoie l’identificateur unique d’une ressource spécifiée provenant d’un système fournisseur externe spécifié pour un ID de ressource unique dans une ServiceNow instance à l’aide d’une expression de filtre pour décrire la ressource souhaitée.

    Cette API est utile lors du mappage ServiceNow des champs sur les champs SCIM où l’identificateur de ressource dans le système du fournisseur externe est nécessaire. Avant d’appeler cette méthode, un champ unique doit être défini pour la ressource dans la carte d’attributs système, située dans la table Mappage des ressources de fournisseur SCIM [sys_scim_provider_resource_mapping ].

    Pour plus d’informations sur le mappage des ressources de fournisseur, reportez-vous à la section Create a SCIM Provider Resource Mapping.

    Tableau 1. Paramètres
    Nom Type Description
    fournisseur Chaîne Nom du fournisseur de service SCIM configuré.

    Table : dans le champ Nom de la table Fournisseur SCIM [sys_scim_provider].

    resourceName Chaîne Nom du type de ressource, par exemple Utilisateur ou Groupe.

    Table : dans le champ resource_name de la table Mappage des ressources de fournisseur SCIM [sys_scim_provider_resource_mapping].

    filtre Chaîne Expression de filtre à appliquer aux résultats de retour.

    Pour plus d’informations sur les paramètres de filtre disponibles et leur format associé, reportez-vous à la section suivante du document de l’Internet Engineering Task Force : Système de gestion des identités interdomaines : Protocole

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

    Tableau 2. Renvoie
    Type Description
    Chaîne Identificateur de ressource unique utilisé par le fournisseur de service externe.

    Lève une exception en cas de problème lors de l’extraction des informations.

    L’exemple suivant montre comment obtenir l’identificateur de ressource de l’utilisateur à l’aide du filtre 'username eq « abel.tuter"'.

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

    Sortie :

    
     "005d500b536073005e0addeeff7b12f4"
    

    L’exemple suivant montre comment utiliser un script pour obtenir l’identificateur de ressource du gestionnaire à l’aide du filtre 'userName 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);

    Sortie :

    
      "125d500b535973005e0addeeff8c12a2"

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

    Renvoie l’identificateur unique d’une ressource spécifiée provenant d’un système fournisseur externe spécifié pour un ID de ressource unique dans une ServiceNow instance.

    Cette API est utile lors du mappage ServiceNow des champs sur les champs SCIM où l’identificateur de ressource dans le système du fournisseur externe est nécessaire. Avant d’appeler cette méthode, un champ unique doit être défini pour la ressource dans la carte d’attributs système, située dans la table Mappage des ressources de fournisseur SCIM [sys_scim_provider_resource_mapping].

    Pour plus d’informations sur le mappage des ressources de fournisseur, reportez-vous à la section Create a SCIM Provider Resource Mapping.

    Tableau 3. Paramètres
    Nom Type Description
    fournisseur Chaîne Nom du fournisseur de service SCIM configuré.

    Table : dans le champ Nom de la table Fournisseur SCIM [sys_scim_provider].

    resourceName Chaîne Nom du type de ressource, par exemple Utilisateur ou Groupe.

    Table : dans le champ resource_name de la table Mappage des ressources de fournisseur SCIM [sys_scim_provider_resource_mapping].

    resourceId Chaîne Sys_id de la ressource enregistrée dans l’instance ServiceNow (le client).

    Table : dans le champ primary_table de la table Mappage des ressources de fournisseur SCIM [sys_scim_provider_resource_mapping].

    Tableau 4. Renvoie
    Type Description
    Chaîne Identificateur de ressource unique utilisé par le fournisseur de service externe.

    Lève une exception en cas de problème lors de l’extraction des informations.

    L’exemple suivant montre comment obtenir l’identificateur de ressource de l’utilisateur avec le sys_id f282abf03710200044e0bfc8bcbe5d12.

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

    Sortie :

    
      "005d500b536073005e0addeeff7b12f4"