--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # SCIM2ClientUtil - com escopo # SCIM2ClientUtil - com escopo {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura A API SCIM2ClientUtil fornece métodos de utilitário para obter os identificadores exclusivos de sistemas de provedores externos e usar essas informações ao chamar a API SCIM2Client. Essa API é executada no namespace `sn_auth` e requer que o plug-in SCIM v2 - Cliente de gestão de identidade entre domínios da ServiceNow (com.snc.integration.scim2.client) seja instalado para acessar a API. Para obter informações adicionais sobre o SCIM, consulte [Sistema para gestão de identidade entre domínios (SCIM)](https://www.servicenow.com/docs/access?context=scim&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). ## SCIM2ClientUtil - getProviderIdByFilter (cadeia de caracteres do provedor, cadeia de caracteres resourceName, filtro de cadeia de caracteres) {#ariaid-title2} 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. Essa API é útil ao mapear campos ServiceNow 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 o mapeamento de recursos do provedor, consulte [Create a SCIM Provider Resource Mapping](https://www.servicenow.com/docs/access?context=scim-provider-resource-mapping&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). {#S2CUtil-getProviderIdByFilter_S_S_S__table_j21_ks5_ctb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | provedor | Cadeia de caracteres | Nome do provedor de serviço de SCIM configurado. Tabela: no campo de nome da tabela do 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 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 gestão de identidade entre domínios: protocolo | [Tabela 1. Parâmetros] {#S2CUtil-getProviderIdByFilter_S_S_S__table_j21_ks5_ctb} {#S2CUtil-getProviderIdByFilter_S_S_S__table_k21_ks5_ctb__entry__2} | 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. | [Tabela 2. Retorna] {#S2CUtil-getProviderIdByFilter_S_S_S__table_k21_ks5_ctb} 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); Saída: "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); Saída: "125d500b535973005e0addeeff8c12a2" ## SCIM2ClientUtil - getProviderIdByResourceId (cadeia de caracteres do provedor, cadeia de caracteres resourceName, cadeia de caracteres resourceId) {#ariaid-title3} 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 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 o mapeamento de recursos do provedor, consulte [Criação de um mapeamento de recursos do provedor de SCIM](https://www.servicenow.com/docs/access?context=scim-provider-resource-mapping&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). {#S2CUtil-getProviderIdByResId_S_S_S__table_rks_rd5_ctb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | provedor | Cadeia de caracteres | Nome do provedor de serviço de SCIM configurado. Tabela: no campo de nome da tabela do 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 na instância ServiceNow (o cliente). Tabela: no campo primary_table da tabela Mapeamento de recursos do Provedor de SCIM \[sys_scim_provider_resource_mapping\]. | [Tabela 3. Parâmetros] {#S2CUtil-getProviderIdByResId_S_S_S__table_rks_rd5_ctb} {#S2CUtil-getProviderIdByResId_S_S_S__table_sks_rd5_ctb__entry__2} | 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. | [Tabela 4. Retorna] {#S2CUtil-getProviderIdByResId_S_S_S__table_sks_rd5_ctb} 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); Saída: "005d500b536073005e0addeeff7b12f4"