SCIM2ClientUtil - com escopo

A API SCIM2ClientUtil fornece funções de utilitário para obter os identificadores exclusivos de sistemas de provedor externo e, em seguida, usar essas informações ao chamar a API SCIM2Client.

Esta API é executada no namespace 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 System for Cross-domain Identity Management (SCIM).

SCIM2ClientUtil - getProviderIdByFilter(Provedor de cadeia de caracteres, ResourceName de cadeia de caracteres, 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 uma instância ServiceNow usando uma expressão de filtro para descrever o recurso desejado.

Esta API é útil ao executar o mapeamento de campos ServiceNow para campos 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 o mapeamento de recursos do provedor, consulte Criar um mapeamento de recursos do Provedor de SCIM.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
provedor	Cadeia de caracteres	Obrigatório. Nome do provedor de serviços de SCIM configurado. O nome do provedor de serviço é definido no campo de nome da tabela Provedor de SCIM [sys_scim_provider].
resourceName	Cadeia de caracteres	Obrigatório. Nome do tipo de recurso, como Usuário ou Grupo. Este valor está localizado no campo resource_name na tabela Mapeamento de recursos do Provedor de SCIM [sys_scim_provider_resource_mapping].
filtros	Cadeia de caracteres	Obrigatório. Expressão de filtro a ser aplicada aos resultados retornados. Para obter informações adicionais sobre os parâmetros de filtro disponíveis e o formato associado, consulte a seção a seguir no documento da Força-tarefa de engenharia da Internet: Sistema para gerenciamento de identidade entre domínios: protocolo https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2

Tabela 2. Retorna

Tipo	Descrição
Cadeia de caracteres	Identificador de recurso exclusivo usado pelo provedor de serviços 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 'username eq "abel.tuter"'.

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

Resposta:

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

O exemplo a seguir mostra como usar um script para obter o identificador de recurso do gerenciador usando o filtro '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);

Resposta:

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

SCIM2ClientUtil - getProviderIdByResourceId(cadeia de caracteres provider, 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 uma instância ServiceNow.

Essa API é útil ao mapear campos ServiceNow para campos 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 o mapeamento de recursos do provedor, consulte Criar um mapeamento de recursos do Provedor de SCIM.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
provedor	Cadeia de caracteres	Obrigatório. Nome do provedor de serviços de SCIM configurado. O nome do provedor de serviço é definido no campo de nome da tabela Provedor de SCIM [sys_scim_provider].
resourceName	Cadeia de caracteres	Obrigatório. Nome do tipo de recurso, como Usuário ou Grupo. Este valor está localizado no campo resource_name na tabela Mapeamento de recursos do Provedor de SCIM [sys_scim_provider_resource_mapping].
resourceId	Cadeia de caracteres	Obrigatório. Sys_id do recurso salvo na instância ServiceNow (o cliente). Este valor está localizado no campo primary_table na tabela Mapeamento de recursos do Provedor de SCIM [sys_scim_provider_resource_mapping].

Tabela 4. Retorna

Tipo	Descrição
Cadeia de caracteres	Identificador de recurso exclusivo usado pelo provedor de serviços 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 o sys_id f282abf03710200044e0bfc8bcbe5d12.

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

Resposta:

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