SCIM2ClientUtil - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura
  • . SCIM2ClientUtil A API fornece métodos de utilitário para obter os identificadores exclusivos de sistemas do provedor externo e, em seguida, usar essas informações ao chamar o. SCIM2Client API.

    Esta API é executada no sn_auth E requer que o plug-in SCIM v2 - ServiceNow Cross-domain Identity Management Client (com.snc.integration.scim2.client) seja instalado para acessar a API.

    Para obter informações adicionais sobre SCIM, consulte Sistema para Gestão de identidade entre domínios (SCIM) .

    SCIM2ClientUtil - getProviderIdByFilter(provedor de cadeia de caracteres, cadeia de caracteres ResourceName, filtro de cadeia de caracteres)

    Retorna o identificador exclusivo de um recurso especificado de um sistema de provedor externo especificado para um ID de recurso exclusivo em um ServiceNow instância usando uma expressão de filtro para descrever o recurso desejado.

    Esta API é útil ao mapear ServiceNow Campos para campos de SCIM em que o identificador de recurso no sistema do provedor externo é necessário. Antes de chamar este método, um campo exclusivo deve ser definido para o recurso no mapa de atributos do sistema, localizado na tabela Mapeamento de recursos do provedor de SCIM [sys_scim_provider_resource_mapping ].

    Para obter informações adicionais sobre mapeamento de recursos do provedor, consulte Create a SCIM Provider Resource Mapping.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    provedor Cadeia de caracteres Nome do provedor de serviço de SCIM configurado.

    Tabela: No campo de nome da tabela Provedor de SCIM [sys_scim_provider].

    resourceName Cadeia de caracteres Nome do tipo de recurso, como Usuário ou Grupo.

    Tabela: No campo resource_name da tabela Mapeamento de recursos do provedor de SCIM [sys_scim_provider_resource_mapping].

    filtros Cadeia de caracteres Expressão de filtro a ser aplicada aos resultados de retorno.

    Para obter informações adicionais sobre os parâmetros de filtro disponíveis e seu formato associado, consulte a seção a seguir no documento Força-tarefa de engenharia da Internet: Sistema para Gestão de identidade entre domínios: Protocolo

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

    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres Identificador de recurso exclusivo usado pelo provedor de serviço externo.

    Lança uma exceção se houver algum problema ao buscar as informações.

    O exemplo a seguir mostra como obter o identificador de recurso do usuário usando o filtro "nome de usuário eq "abel.tuter"' .

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

    Saída:

    
     "005d500b536073005e0addeeff7b12f4"
    

    O exemplo a seguir mostra como usar um script para obter o identificador de recurso do gerente usando o filtro "Nome de usuário eq "", gerente e """ .

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

    Saída:

    
      "125d500b535973005e0addeeff8c12a2"

    SCIM2ClientUtil - getProviderIdByResourceId(provedor de cadeia de caracteres, cadeia de caracteres ResourceName, cadeia de caracteres resourceId)

    Retorna o identificador exclusivo de um recurso especificado de um sistema de provedor externo especificado para um ID de recurso exclusivo em um ServiceNow instância.

    Esta API é útil ao mapear ServiceNow Campos para campos de SCIM em que o identificador de recurso no sistema do provedor externo é necessário. Antes de chamar este método, um campo exclusivo deve ser definido para o recurso no mapa de atributos do sistema, localizado na tabela Mapeamento de recursos do provedor de SCIM [sys_scim_provider_resource_mapping].

    Para obter informações adicionais sobre mapeamento de recursos do provedor, consulte Create a SCIM Provider Resource Mapping.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    provedor Cadeia de caracteres Nome do provedor de serviço de SCIM configurado.

    Tabela: No campo de nome da tabela Provedor de SCIM [sys_scim_provider].

    resourceName Cadeia de caracteres Nome do tipo de recurso, como Usuário ou Grupo.

    Tabela: No campo resource_name da tabela Mapeamento de recursos do provedor de SCIM [sys_scim_provider_resource_mapping].

    resourceId Cadeia de caracteres Sys_id do recurso salvo em ServiceNow instância (o cliente).

    Tabela: No campo primary_table da tabela Mapeamento de recursos do provedor de SCIM [sys_scim_provider_resource_mapping].

    Tabela 4. Retornos
    Tipo Descrição
    Cadeia de caracteres Identificador de recurso exclusivo usado pelo provedor de serviço externo.

    Lança uma exceção se houver algum problema ao buscar as informações.

    O exemplo a seguir mostra como obter o identificador de recurso do usuário com sys_id f282abf03710200044e0bfc8bcbe5d12.

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

    Saída:

    
      "005d500b536073005e0addeeff7b12f4"