Sistema para API de gestão de identidade entre domínios (SCIM)

A API do Sistema para gestão de identidade entre domínios (SCIM) fornece endpoints para criar, ler, atualizar e excluir operações em usuários e grupos usando o protocolo SCIM.

O protocolo SCIM é um protocolo baseado em HTTP de nível de aplicação baseado no padrão HTTP [RFC7230]. Use esta API para provisionar e gerenciar dados de identidade, como usuários e grupos, na Web e em ambientes de domínio cruzado, como provedores de serviços de empresa para nuvem ou cenários entre nuvens.

Para acessar esta API, você deve ativar o plug-in SCIM v2 - ServiceNow®Cross-domain Identity Management (com.snc.integration.scim2).

Mapeamento de recursos

O serviço de SCIM tem seis recursos:

• Usuário (núcleo e extensão)
• Grupo (núcleo e extensão)
• Empresa
• CostCenter
• Departamento
• Local

A maioria dos atributos nesses recursos de SCIM é mapeada para campos correspondentes em uma tabela ServiceNow existente. As tabelas a seguir definem esses mapeamentos. Os atributos que não correspondem aos campos nas tabelas ServiceNow existentes são mapeados para duas tabelas específicas do SCIM. Para obter informações adicionais sobre essas tabelas, consulte Tabelas específicas do SCIM.

O recurso Usuário de SCIM tem esquemas principais (esquema: urn:ietf:params:scim:schemas:core:2.0:User) e de extensão (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User). A maioria dos atributos de esquema de extensão e core do usuário é mapeada para a tabela Usuário [sys_user].

Tabela 1. Recurso do usuário para mapeamento da tabela Usuário [sys_user]

Nome do atributo de SCIM	Nome do campo de usuário
ativo	ativo
address.country	país
addresses.default.country	país
addresses.home.country	país
endereços.localidade	cidade
endereços.padrão.localidade	cidade
endereços.residência.localidade	cidade
endereços.Códigopostal	zip
endereços.padrão.Código_postal	zip
address.home.postalCode	zip
endereços.região	state
address.default.region	state
address.home.region	state
endereços.streetAddress	rua
address.default.streetAddress	rua
endereços.home.streetAddress	rua
displayName	nome
e-mails.valor	e-mail
e-mails.padrão.valor	e-mail
e-mails.trabalho.valor	e-mail
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on
name.familyName	last_name
nome.givenName	first_name
nome.prefixohonorífico	introdução
name.middleName	middle_name
phoneNumbers.value	telefone
phoneNumbers.home.value	home_phone
phoneNumbers.mobile.value	mobile_phone
phoneNumbers.work.value	telefone
PreferredLanguage	preferred_language
fuso horário	time_zone
título	título
userName	user_name

Tabela 2. Recurso do usuário para mapeamento da tabela Usuário do sistema Scim [sys_scim_user]

Nome do atributo de SCIM	Nome do campo Usuário Scim do sistema
IDexterno	external_id

O esquema estendido do Usuário de SCIM (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) é mapeado para a tabela Usuário [sys_user].

Tabela 3. Recurso estendido do usuário para mapeamento da tabela do usuário [sys_user]

Nome do atributo de SCIM	Nome do campo de usuário
nome.empresa	nome.empresa
empresa.valor	empresa.sys_id
costCenter.name	centro_custo.nome
centro de custos.valor	centro_custo.sys_id
departamento.nome	departamento.nome
departamento.valor	departamento.sys_id
employeeNumber	employee_number
gênero	gênero
location.name	location.name
local.valor	local.sys_id
manager.displayName	gerente.nome
gerente.valor	gerente.sys_id

O esquema de recursos do Grupo de SCIM (urn:ietf:params:scim:schemas:core:2.0:Group) é mapeado para a tabela Grupo [sys_user_group].

Tabela 4. Recurso de grupo para mapeamento de tabela de Grupo [sys_user_group]

Nome do atributo de SCIM	Nome do campo de grupo
displayName	nome
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on

O parâmetro externalId do Grupo de SCIM é mapeado para a tabela Sys Scim Group [sys_scim_group].

Tabela 5. Recurso de grupo para mapeamento de tabela do Grupo de Scim do Sistema [sys_scim_group]

Nome do atributo de SCIM	Nome do campo Grupo Scim do sistema
IDexterno	external_id

O esquema de extensão do Grupo SCIM ServiceNow (urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group) é mapeado para a tabela Grupo [sys_user_group].

Tabela 6. Recurso de grupo para mapeamento de tabela de Grupo [sys_user_group]

Nome do atributo de SCIM	Nome do campo de grupo
empresa.valor	empresa.sys_id
nome.empresa	nome.empresa

O esquema de recursos da Empresa de SCIM (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company) é mapeado para a tabela Empresa [core_company].

Tabela 7. Recurso da empresa para mapeamento da tabela da empresa [core_company]

Nome do atributo de SCIM	Nome do campo da empresa
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on
nome	nome

O esquema do recurso SCIM CostCenter (urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter) é mapeado para a tabela Centro de custos [cmn_cost_center].

Tabela 8. Recurso de CostCenter para mapeamento de tabela de Centro de custos [cmn_cost_center]

Nome do atributo de SCIM	Nome do campo Centro de custos
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on
nome	nome

O esquema de recursos do Departamento de SCIM (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department) é mapeado para a tabela Departamento [cmn_department].

Tabela 9. Mapeamento de tabela de recurso de departamento para departamento [cmn_department]

Nome do atributo de SCIM	Nome do campo Departamento
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on
nome	nome

O esquema de recursos do local do SCIM (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location) é mapeado para a tabela Local [cmn_location].

Tabela 10. Recurso do local para mapeamento da tabela do local [cmn_location]

Nome do atributo de SCIM	Nome do campo de local
id	sys_id
meta.criado	sys_created_on
meta.lastModified	sys_updated_on
nome	nome

Tabelas específicas do SCIM

Duas tabelas, Sys Scim User [sys_scim_user] e Sys Scim Group [sys_scim_group], contêm os atributos de SCIM que não são mapeados para tabelas ServiceNow existentes. Os itens a seguir definem o conteúdo dessas tabelas.

Tabela 11. Tabela Usuário do sistema Scim [sys_scim_user]

Nome do campo	Descrição
Criado	Data e hora em que o registro associado foi criado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Criado por	Nome da entidade que criou o registro. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
ID externo	ID externo usado pela entidade que criou este registro de usuário para fazer referência ao usuário em seu sistema. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
ID do sistema	Identificador exclusivo do registro em uma instância ServiceNow. Tipo de dados: cadeia de caracteres Tamanho máximo: 32
Atualizado	Data e hora em que o registro associado foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Atualizado por	Nome da entidade que atualizou o registro associado pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Atualizações	Número de vezes que o registro foi atualizado. Tipo de dados: inteiro Tamanho máximo: 40
Usuário	Referência ao usuário associado a este registro Referência: tabela Usuário [sys_user] Tamanho máximo: 32
Tipo de usuário	Tipo de registro do usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Externo Estagiário Temp Desconhecido Tipo de dados: cadeia de caracteres Tamanho máximo: 40

Tabela 12. Tabela Grupo de Scim do sistema [sys_scim_group]

Nome do campo	Descrição
Criado	Data e hora em que o registro associado foi criado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Criado por	Nome da entidade que criou o registro. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
ID externo	ID externo usado pela entidade que criou este registro de grupo para fazer referência ao grupo em seu sistema. Tipo de dados: cadeia de caracteres Tamanho máximo: 255
Grupo	Referência ao grupo associado a este registro. Referência: tabela Grupo [sys_user_group] Tamanho máximo: 32
ID do sistema	Identificador exclusivo do registro em uma instância ServiceNow. Tipo de dados: cadeia de caracteres Tamanho máximo: 32
Atualizado	Data e hora em que o registro associado foi atualizado pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Atualizado por	Nome da entidade que atualizou o registro associado pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40
Atualizações	Número de vezes que o registro foi atualizado. Tipo de dados: inteiro Tamanho máximo: 40

Funções e listas de controle de acesso

A função scim_admin é necessária para acessar as tabelas específicas do SCIM e os endpoints do SCIM privados e permite o acesso às tabelas Usuário [sys_user] e Grupo [sys_user_group].

O serviço de SCIM tem quatro ACLs para acessar a tabela Sys Scim User [sys_scim_user] e a tabela Sys Scim Group [sys_scim_group] que permitem criar, excluir, ler e gravar. Essas ACLs são mapeadas somente para a função scim_admin.

SCIM - EXCLUIR /scim/Grupos/{group_id}

Exclui o registro de grupo especificado da tabela Grupo [sys_user_group] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups/{group_id}

URL padrão: /api/now/scim/Groups/{group_id}

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
group_id	Sys_id do registro do grupo a ser excluído. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 15. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 18. Códigos de status

Código de status	Descrição
204	Nenhum conteúdo. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres

Solicitação de cURL para excluir um grupo

Este exemplo mostra como excluir um registro de grupo da tabela Grupo [sys_user_group].

curl "https://instance-servicenow.com/api/now/scim/Groups/a0a9e9fb1b7e3010593876a61a4bcbe0" \
--request DELETE \
--header "Accept:application/scim+json" \

SCIM - GET /scim/Grupos

Retorna um ou mais registros de grupo da tabela Grupo [sys_user_group] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups

URL padrão: /api/now/scim/Groups

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 20. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível com este método. Por exemplo, para filtrar todos os grupos cujo nome começa com "RH", insira SW "RH". Para especificar mais de um filtro de campo, concatene os filtros usando o operando E. Por exemplo, para filtrar todos os grupos cujo nome começa com "HR" e foram modificados pela última vez antes de 3 de outubro de 2021, insira displayName SW "HR" AND meta.lastModified lt "2021-10-33T00:00:00Z". Use a referência com pontos para especificar atributos aninhados. Somente os seguintes campos de grupo SCIM estão disponíveis para uso em filtros: displayName externalId: oferece suporte somente ao operador EQ. id meta.criado meta.lastModified Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, exceto que externalId não é permitido. Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: sem classificação
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 21. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 24. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros de grupo. Tipo de dados: matriz de objetos "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ]
Recursos.empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
Recursos.empresa.exibição	Nome da empresa. Tipo de dados: cadeia de caracteres
Recursos.empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
Recursos.empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
Recursos.displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
Resources.externalId	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
Resources.id	Sys_id do grupo. Tipo de dados: cadeia de caracteres
Recursos.meta	Metadados pertencentes ao grupo. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Recursos.meta.criados	Data e hora em que o registro do grupo foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora da última modificação do registro do grupo. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do grupo que está sendo recuperado. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	Tipo de recurso dos Grupos de SCIM. Tipo de dados: cadeia de caracteres
Recursos.membros	Lista de usuários e grupos associados ao grupo. Tipo de dados: matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Recursos.membros.exibição	Nome do membro do grupo associado. Tipo de dados: cadeia de caracteres
Recursos.membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
Recursos.membros.$ref	URI do membro do grupo associado. Tipo de dados: cadeia de caracteres
Recursos.esquemas	Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres
esquemas	Lista de URIs dos esquemas de resposta da lista de SCIM usados para processar a solicitação. Tipo de dados: matriz
startIndex	Índice baseado em um na tabela Grupo [sys_user_group] na qual o endpoint começou a recuperar registros. Tipo de dados: número
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL para vários grupos

Este exemplo mostra como solicitar vários grupos (quatro neste caso), usando o parâmetro count.

curl "https://instance-sevicenow.com/api/now/scim/Groups?count=4" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":44,
  "Resources":[
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"019ad92ec7230010393d265c95c260dd",
      "meta":{
        "resourceType":"Group",
        "created":"2020-03-17T11:39:14Z",
        "lastModified":"2020-03-17T11:39:14Z",
        "location":"https://instance-sevicenow.com/api/now/scim/Groups/019ad92ec7230010393d265c95c260dd"
      },
      "displayName":"Analytics Settings Managers"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0a52d3dcd7011200f2d224837e6103f2",
      "meta":{
        "resourceType":"Group",
        "created":"2021-09-29T16:42:02Z",
        "lastModified":"2021-09-29T16:42:02Z",
        "location":"https://instance-sevicenow.com/api/now/scim/Groups/0a52d3dcd7011200f2d224837e6103f2"
      },
      "displayName":"Application Development",
      "members":[
        {
          "value":"dc6053dcd7011200f2d224837e6103e0",
          "display":"John Doe",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/dc6053dcd7011200f2d224837e6103e0"
        },
        {
          "value":"443193dcd7011200f2d224837e61037d",
          "display":"Abel Tutor",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/443193dcd7011200f2d224837e61037d"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "81fd65ecac1d55eb42a426568fc87a63",
          "name": "ACME Japan",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c4e7b573b331300ad3cc9bb34efc461",
      "meta":{
        "resourceType":"Group",
        "created":"2021-09-29T05:11:33Z",
        "lastModified":"2021-09-29T05:11:33Z",
        "location":"instance-sevicenow.com/api/now/scim/Groups/0c4e7b573b331300ad3cc9bb34efc461"
      },
      "displayName":"Problem Analyzers",
      "members":[
        {
          "value":"d3dbbf173b331300ad3cc9bb34efc466",
          "display":"Problem Manager",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/babb4639b76233004fbc2089ee11a97f"
        },
        {
          "value":"38cb3f173b331300ad3cc9bb34efc4d6",
          "display":"Problem Coordinator B",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/cbcc4639b76233004fbc2089ee111047"
        },
        {
          "value":"26fbff173b331300ad3cc9bb34efc4bd",
          "display":"Problem Administrator",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Users/45324639b76232189fbc2089ee11bc34"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "913465ecac1d569b42a426568fc88af3",
          "name": "ACME London",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
        "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"
      ],
      "id":"0c5e2a7ce4001410f877ce457cda6b98",
      "meta":{
        "resourceType":"Group",
        "created":"2020-04-06T03:47:08Z",
        "lastModified":"2020-07-29T04:02:26Z",
        "location":"instance-sevicenow.com/api/now/scim/Groups/0c5e2a7ce4001410f877ce457cda6b98"
      },
      "displayName":"Business Application Registration Approval Group"
    }
  ],
  "startIndex":1,
  "itemsPerPage":4
}

Solicitação de cURL para vários grupos usando excludeAttributes

Este exemplo mostra como solicitar vários grupos (quatro neste caso), usando o parâmetro count e excluindo os campos meta e membros.

curl "https://instance-sevicenow.com/api/now/scim/Groups?excludedAttributes=meta%2C%20members&count=4" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":44,
  "Resources":[
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"019ad92ec7230010393d265c95c260dd",
      "displayName":"Analytics Settings Managers",
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "913465ecac1d569b42a426568fc88af3",
          "name": "ACME London",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3"
        }
      }
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0a52d3dcd7011200f2d224837e6103f2",
      "displayName":"Application Development"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c4e7b573b331300ad3cc9bb34efc461",
      "displayName":"Problem Analyzers"
    },
    {"schemas":
      [
        "urn:ietf:params:scim:schemas:core:2.0:Group"",
        “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”,
        “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”
      ],
      "id":"0c5e2a7ce4001410f877ce457cda6b98",
      "displayName":"Business Application Registration Approval Group",
      "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
        "company": {
          "value": "81fd65ecac1d55eb42a426568fc87a63",
          "name": "ACME Japan",
          "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
        }
      }
    }
  ],
  "startIndex":1,
  "itemsPerPage":4
}

SCIM - GET /scim/Grupos/{group_id}

Retorna o registro de grupo especificado da tabela Grupo [sys_user_group] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups/{group_id}

URL padrão: /api/now/scim/Groups/{group_id}

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
group_id	Sys_id do registro do grupo a ser retornado.

Tabela 26. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 27. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 30. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
id	Sys_id do grupo. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao grupo. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do grupo foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do grupo. Tipo de dados: cadeia de caracteres
meta.local	URI do grupo que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso dos Grupos de SCIM. Tipo de dados: cadeia de caracteres
membros	Lista de usuários e grupos associados ao grupo. Tipo de dados: matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
membros.exibição	Nome do membro do grupo associado. Tipo de dados: cadeia de caracteres
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
membros.$ref	URI do membro do grupo associado. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

Solicitação de cURL para grupo específico

Este exemplo mostra como recuperar um registro de grupo específico.

curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T18:20:43Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"},
    "displayName":"HR Group",
    "members":[
      {
        "value":"62826bf03710200044e0bfc8bcbe5df1",
        "display":"Abel Tuter",
        "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      }
    ], 
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
      "company": {
        "value": "81fd65ecac1d55eb42a426568fc87a63",
        "name": "ACME Japan",
        "$ref": "http://111.111.1.11:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
      }
    }
  }
}

SCIM - PATCH /scim/Grupos/{group_id}

Permite adicionar, atualizar e excluir campos especificados em um registro de grupo na tabela Grupo [sys_user_group] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Para obter informações adicionais, consulte a seção Modificando com PATCH da RFC 7644.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups/{group_id}

URL padrão: /api/now/scim/Groups/{group_id}

Parâmetros de solicitação compatíveis

Tabela 31. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
group_id	Sys_id do registro do grupo a ser atualizado.

Tabela 32. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 33. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Operações	Obrigatório. Lista de objetos de operação para corrigir o registro de grupo especificado. Tipo de dados: matriz de objetos "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operações.op	Obrigatório. Operação a ser executada. Valores válidos: adicionar: adicione o campo e o valor especificados ao registro do grupo. remove: remove o valor do campo especificado. Substituído pelo tipo de dados "nulo". substituir: substitui o valor do campo especificado. Tipo de dados: cadeia de caracteres
Operations.path	Necessário para operações de remoção, opcional para outras. Nome/caminho do campo a ser modificado. O parâmetro path pode ter um dos seguintes formatos: Um campo direto, como displayName Em caso de matriz complexa, um ponteiro para um elemento específico com um filtro, como: e- mails [type eq "work"] { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" }, { "op": "replace", "path": "members[value eq \"sysid1\"]", "value": { "value": "sysid2" } } ] } Tipo de dados: cadeia de caracteres Padrão: considera o campo um recurso.
Operations.value	Valor do campo especificado no parâmetro Operations.path. O formato deste parâmetro depende do tipo de dados do campo associado. Por exemplo, se estiver atualizando uma cadeia de caracteres simples, como o título, o campo value será expresso como uma cadeia de caracteres. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Você também pode declarar valores de cadeia de caracteres simples sem parâmetros path, como: "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] Veja a seguir como adicionar um membro ao grupo: { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } Se o campo que está sendo atualizado não estiver no esquema base, você deverá colocar o par nome-valor em um objeto que especifica o URN do esquema associado. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Por exemplo: "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "groupNumber": "13454" }, } Tipo de dados: qualquer
Operações.valor.tipo	Nome do campo a ser atualizado. Tipo de dados: cadeia de caracteres
Operações.valor.valor	Valor para atualizar o campo. Tipo de dados: cadeia de caracteres
esquemas	Obrigatório. URI do esquema de SCIM da operação de patch: "urn:ietf:params:scim:api:messages:2.0:PatchOp" Tipo de dados: cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 34. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 36. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
204	Bem-sucedido. Sem conteúdo (aplicável somente à API de patch do grupo do SCIM) - Este status 204 depende do estado da propriedade de IU do SCIM, Habilitar resposta da API de patch do grupo sem conteúdoe está sujeito ao parâmetro de atributo aprovado de acordo com a RFC: https ://www.rfc-editor.org/rfc/rfc7644#page-35. Valor da propriedade padrão: falso A propriedade Habilitar resposta de API de patch de grupo sem conteúdo pode ser usada para obter ganhos adicionais de desempenho de execução de resposta se o cliente não planejar consumir recursos de resposta.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Verifique se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. Foi fornecido um usuário ou grupo sys_id inválido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação ou que a solicitação não exceda o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	O grupo já existe. O parâmetro displayName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
id	Sys_id do grupo. Tipo de dados: cadeia de caracteres
membros	Lista de usuários e grupos associados ao grupo. Tipo de dados: matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
membros.exibição	Nome do membro do grupo associado. Tipo de dados: cadeia de caracteres
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
membros.$ref	URI do membro do grupo associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao grupo. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do grupo foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do grupo. Tipo de dados: cadeia de caracteres
meta.local	URI do grupo que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso dos Grupos de SCIM. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

Solicitação de cURL

Este exemplo mostra como adicionar um ID externo a um registro de grupo e substituir a lista atual de membros associados (usuários).

curl "https://instance-servicenow.com/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e" \
--request PATCH \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "externalId",
      "value": "278fdc2e-a6aa-4140-bd23-9ba4987a2938"
    },
    {
      "op": "replace",
      "path": "members",
      "value": [
        {
          "value": "62826bf03710200044e0bfc8bcbe5df1"
        },
        {
          "value": "a8f98bb0eb32010045e1a5115206fe3a"
        }
      ]
    }
  ]
}"

Resposta:

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id": "a92b84f96b073010638c83eece44af4e",
  "externalId": "278fdc2e-a6aa-4140-bd23-9ba4987a2938",
  "meta": {
    "resourceType": "Group",
    "created": "2021-10-07T13:58:22Z",
    "lastModified": "2021-10-07T15:48:44Z",
    "location":
      "https://instance-sevicenow/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e"
  },
  "displayName": "HR Team",
  "members": [
    {
      "value": "62826bf03710200044e0bfc8bcbe5df1",
      "display": "Abel Tuter",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
    },
    {
      "value": "a8f98bb0eb32010045e1a5115206fe3a",
      "display": "Abraham Lincoln",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/a8f98bb0eb32010045e1a5115206fe3a"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref": "http://instance-sevicenow/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    }
  }
}

SCIM - POST /scim/Grupos

Cria um registro de grupo na tabela Grupo [sys_user_group] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Você pode definir o nome de exibição do grupo, um ID externo usado para correlacionar este grupo a um sistema externo e adicionar membros (usuários/grupos) ao grupo.

Nota:

A funcionalidade de pesquisa e modificações em massa, conforme observado na especificação RFC7643, não é compatível com este endpoint.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups

URL padrão: /api/now/scim/Groups

Parâmetros de solicitação compatíveis

Tabela 37. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 38. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 39. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Obrigatório. Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
membros	Lista de usuários ou outros grupos a serem associados ao grupo. Tipo de dados: matriz de objetos "members:" [ { "value": "String" } ] Tamanho máximo: 100 - Você pode modificar esse tamanho máximo atualizando a propriedade do sistema com.snc.interation.scim2.max.member.count.
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
esquemas	Obrigatório. Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 40. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 42. Códigos de status

Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Verifique se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. Foi fornecido um usuário ou grupo sys_id inválido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação ou que a solicitação não exceda o número máximo de membros.
409	O grupo já existe. O parâmetro displayName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
id	Sys_id do grupo. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao grupo. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do grupo foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do grupo. Tipo de dados: cadeia de caracteres
meta.local	URI do grupo que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso dos Grupos de SCIM. Tipo de dados: cadeia de caracteres
membros	Lista de usuários e grupos associados ao grupo. Tipo de dados: matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
membros.exibição	Nome do membro do grupo associado. Tipo de dados: cadeia de caracteres
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
membros.$ref	URI do membro do grupo associado. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

cURL solicita POST de um novo grupo e adiciona membro

Este exemplo cria o group51 e adiciona o usuário Abel Tutor como um membro.

curl "https://instance-servicenow.com/api/now/scim/Groups" \
--request POST \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group",
    “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”, 
    “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”],
  \"displayName\": \"HR Team\",
  \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\",
  \"members\": [
    {
      \"value\": \"62826bf03710200044e0bfc8bcbe5df1\",
      \"$ref\": \"Users/62826bf03710200044e0bfc8bcbe5df1\"
    }
  ]
}"

Resposta:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T18:20:43Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"},
    "displayName":"HR Team",
    "members":[
      {
        "value":"62826bf03710200044e0bfc8bcbe5df1",
        "display":"Abel Tuter",
        "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      }
    ],
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
      "company": {
        "value": "81fd65ecac1d55eb42a426568fc87a63",
        "name": "ACME Japan",
        "$ref": http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63
      }
    }
  }
}

SCIM - PUT /scim/Grupos/{group_id}

Atualiza o registro de grupo especificado na tabela Grupo [sys_user_group] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Os campos omitidos na solicitação não são atualizados. Você pode limpar explicitamente um campo definindo seu valor como nulo para um único campo de valor e como uma matriz vazia para campos de tipo de matriz, como members.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Groups/{group_id}

URL padrão: /api/now/scim/Groups/{group_id}

Parâmetros de solicitação compatíveis

Tabela 43. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
group_id	Sys_id do registro do grupo a ser atualizado.

Tabela 44. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 45. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
membros	Lista de usuários para substituir a lista atual de membros. Tipo de dados: matriz de objetos "members:" [ { "value": "String" } ] Tamanho máximo: 100 - Você pode modificar esse tamanho máximo atualizando a propriedade do sistema com.snc.interation.scim2.max.member.count.
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
esquemas	Obrigatório. Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 46. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 48. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Verifique se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. Foi fornecido um usuário ou grupo sys_id inválido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação ou que a solicitação não exceda o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	O grupo já existe. O parâmetro displayName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
empresa	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: objeto "company": { "display": "String", "$ref": "String", "value": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Formato:<host> /Empresas/<company sys_id> , como: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id da empresa associada. Tipo de dados: cadeia de caracteres
displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: cadeia de caracteres
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao grupo pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
id	Sys_id do grupo. Tipo de dados: cadeia de caracteres
membros	Lista de usuários e grupos associados ao grupo. Tipo de dados: matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
membros.exibição	Nome do membro do grupo associado. Tipo de dados: cadeia de caracteres
Membros.valor	Sys_id do registro de usuário ou grupo associado. Tipo de dados: cadeia de caracteres
membros.$ref	URI do membro do grupo associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao grupo. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do grupo foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do grupo. Tipo de dados: cadeia de caracteres
meta.local	URI do grupo que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso dos Grupos de SCIM. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Grupo de SCIM usados para processar a solicitação. Esquemas de grupo compatíveis: urn:ietf:params:scim:schemas:core:2.0:Group - Esquema principal especificado no documento do Sistema de força-tarefa de engenharia da Internet para Cross-domain Identity Management: Core Schema (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow esquema de extensão. Este esquema contém atributos que estão presentes na tabela Grupos [sys_user_group] em um sistema base ServiceNow, mas não fazem parte do esquema principal. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” — Esquema de extensão personalizado. Este esquema faz parte do resourceType "Grupo" na tabela sys_scim_schema_extension. Se o esquema não estiver ativo, o URN do esquema não será retornado na resposta. Tipo de dados: matriz de cadeias de caracteres

Solicitação de cURL atualizando membros do grupo usando PUT

O exemplo a seguir muda o membro associado ao grupo para AbrahãoLincoln em vez de Abel Tutor e muda o nome do grupo para Equipe de RH.

curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request PUT \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group",
    “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”, 
    “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”],
  \"displayName\": \"HR Team\",
  \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\",
  \"members\": [
    {
      \"value\": \"a8f98bb0eb32010045e1a5115206fe3a\",
      \"$ref\": \"Users\"
    }
  ]
}" 

Resposta:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T21:19:40Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"
  },
  "displayName":"HR Team",
  "members":[
    {
      "value":"a8f98bb0eb32010045e1a5115206fe3a",
      "display":"Abraham Lincoln",
      "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref": "http://192.168.1.25:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    }
  }
}

SCIM - EXCLUIR /scim/Usuários/{user_id}

Exclui o registro de usuário especificado da tabela Usuário [sys_user] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users/{user_id}

URL padrão: /api/now/scim/Users/{user_id}

Parâmetros de solicitação compatíveis

Tabela 49. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
user_id	Sys_id do registro do usuário a ser excluído.

Tabela 50. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 51. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 52. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 54. Códigos de status

Código de status	Descrição
204	Nenhum conteúdo. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como excluir um registro de usuário da tabela Usuário [sys_user].

curl "https://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992" \
--request DELETE \
--header "Accept:application/scim+json"  \

SCIM - GET /scim/Usuários

Retorna um ou mais registros de usuário da tabela Usuário [sys_user] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users

URL padrão: /api/now/scim/Users

Parâmetros de solicitação compatíveis

Tabela 55. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 56. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível. Por exemplo, para filtrar todos os usuários cujo nome começa com "Jo", insira userName SW "jo" (sem distinção entre maiúsculas e minúsculas). Para especificar mais de um filtro de campo, concatene os filtros usando o operando AND. Por exemplo, para filtrar todos os usuários cujo nome começa com "Jo" e cujo sobrenome contém "smi", insira userName SW "john" AND name.familyName CO "smi". Use a referência com pontos para especificar atributos aninhados. Somente os seguintes campos de usuário do SCIM estão disponíveis para uso em filtros e alguns, como observado, oferecem suporte somente ao formato fixo: ativo endereços — Somente formato fixo, como: [type eq "home" and roadAddress eq "xxxx"] [type eq "home" and locality eq "xxxx"] [type eq "home" and region eq "xxxx"] [type eq "home" and postalCode eq "xxxx"] [tipo eq "home" e país eq "xxxx"] displayName e-mails — Somente formato fixo, como: [type eq "work" and value eq "emailValue"] externalId — Somente o operador EQ é compatível. id meta.criado meta.lastModified name.familyName nome.givenName name.middleName PreferredLanguage phoneNumbers — Somente formato fixo, como: [tipo eq "trabalho" e valor eq "xxxx"] [tipo eq "mobile" e valor eq "xxxx"] [type eq “home” and value eq “xxxx”] fuso horário título userName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:employeeNumber urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:gender urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.displayName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.value Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, com exceção de externalId, que não é permitido. Além disso, somente os seguintes parâmetros de referência com pontos são compatíveis: addressess - Somente os seguintes valores são permitidos: addresses.streetAddress - Mapeia para o endereço residencial. addresses.home.streetAddress addresses.locality - Mapeia para a localidade inicial. addresses.home.locality addresses.region - Mapeia para a região inicial. addresses.home.region addresses.postalCode - Mapas para o CEP residencial. addresses.home.postalCode addresses.country - Mapas para o país de origem. addresses.home.country emails - Somente os seguintes valores são permitidos: emails.value - Mapas para o tipo de e-mail comercial. emails.work.value phoneNumbers - Somente os seguintes valores são permitidos: phoneNumbers.value - Mapeia para o tipo de número de telefone comercial. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: nenhuma classificação realizada
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela Usuário [sys_user] na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Não é válido com o parâmetro de caminho id. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 57. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 58. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 59. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 60. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros do usuário. Tipo de dados: matriz de objetos "Resources": [ { "active": Boolean, "addresses": {Object}, "displayName": "String", "emails": [Array], "externalId": "String", "groups": [Array], "id": "String", "meta": {Object}, "name": {Object}, "phoneNumbers": [Array], "preferredLanguage": "String", "schemas": [Array], "timezone": "String", "title": "String", "userName": "String", "userType": "String" } ]
Recursos.ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
Recursos.endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Resources.addresses.country	Nome do país. Tipo de dados: cadeia de caracteres
Recursos.endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
Recursos.endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
Recursos.endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
Recursos.endereço.endereço	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
Recursos.endereços.tipo	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
Recursos.displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
Recursos.e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
Recursos.e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
Recursos.e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
Resources.externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
Recursos.grupos	Lista de grupos aos quais o usuário pertence, seja por associação direta, grupos aninhados ou calculados dinamicamente. Tipo de dados: matriz de objetos "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Recursos.grupos.exibição	Nome do grupo associado. Tipo de dados: cadeia de caracteres
Recursos.grupos.tipo	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: cadeia de caracteres
Recursos.grupos.valor	Sys_id de um registro de grupo associado. Tipo de dados: cadeia de caracteres
Recursos.grupos.ref	URI do grupo associado. Tipo de dados: cadeia de caracteres
Resources.id	Sys_id do registro do usuário associado. Tipo de dados: cadeia de caracteres
Recursos.meta	Metadados pertencentes ao usuário. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Recursos.meta.criados	Data e hora em que o registro do usuário foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora da última modificação do registro do usuário. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do usuário que está sendo recuperado. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	Tipo de recurso de Usuários de SCIM. Tipo de dados: cadeia de caracteres
Resources.name	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Resources.name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
Resources.name.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
Resources.name.honorificPrefix	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
Recursos.nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
Recursos.NúmerosDeTelefone	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
Recursos.phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
Recursos.NúmeroDeTelefone.valor	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
Recursos.IdiomaPreferido	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
Recursos.esquemas	Lista de URIs dos esquemas de Usuário de SCIM usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
Recursos.fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
Recursos.título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
Recursos.NomeDoUsuário	Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
Recursos.TipoDeUsuário	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas SCIM ListResponse usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
startIndex	Índice baseado em um na tabela Usuário [sys_user] na qual os registros foram retornados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Parâmetros de extensão retornados

Nome	Descrição
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "display": "String", "value": "String", "$ref": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "display": "String", "value": "String", "$ref": "String" }
centro de custos.exibição	Nome do centro de custos. Tipo de dados: cadeia de caracteres
centro de custos.valor	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
CostCenter.$ref	URI de referência para o centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "display": "String", "value": "String", "$ref": "String" }
departamento.exibição	Nome do departamento. Tipo de dados: cadeia de caracteres
departamento.valor	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
departamento.$ref	URI de referência do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Nome do local. Tipo de dados: cadeia de caracteres
local.valor	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
location.$ref	URI de referência do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "display": "String", "value": "String", "$ref": "String" }
gerente.exibição	Nome do gerente. Tipo de dados: cadeia de caracteres
gerente.valor	Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres
gerente.$ref	URI de referência do gerente. Tipo de dados: cadeia de caracteres

Solicitação cURL usando atributos

O exemplo a seguir mostra como obter dois usuários começando no sexto registro e retornando somente o nome de exibição.

curl "https://instance-servicenow.com/api/now/scim/Users?attributes=displayName&startIndex=6&count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":619,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"02826bf03710200044e0bfc8bcbe5d6d",
        "displayName":"Sean Bonnet"
      },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
           ],
         "id":"02826bf03710200044e0bfc8bcbe5d76",
         "displayName":"Jacinto Gawron"
      }
    ],
  "startIndex":6,
  "itemsPerPage":2
}

Solicitação de cURL usando um filtro

O exemplo a seguir mostra como usar o parâmetro filter para retornar os dois primeiros registros de usuário cujo nome começa com "a".

curl "https://instance-servicenow.com/api/now/scim/Users?filter=name.givenName%20SW%20%22a%22&count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":42,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"06826bf03710200044e0bfc8bcbe5d8a",
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/06826bf03710200044e0bfc8bcbe5d8a"
          },
          "userName":"allyson.gillispie",
          "name":
            {
              "familyName":"Gillispie",
              "givenName":"Allyson"
            },
          "displayName":"Allyson Gillispie",
          "active":true,
          "emails":
            [
              {
                "value":"[e-mail]",
                "type":"work"
              }
            ],
          "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
            {
              "gender":"Female",
              "costCenter":
                {
                  "value":"d9d07bddc0a80a647cf932056ed24652",
                  "name":"Engineering"
                },
              "company":
                {
                  "value":"31bea3d53790200044e0bfc8bcbe5dec",
                  "name":"ACME North America"
                },
              "department":
                {
                  "value":"221f3db5c6112284009f4becd3039cc9",
                  "name":"Development"
                },
              "location":
                {
                  "value":"f9084ba00a0a0b910060ba2ce83f882b",
                  "name":"946 Donax Avenue, Imperial Beach,CA"
                }
            }
         },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"0a826bf03710200044e0bfc8bcbe5d7a"
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/0a826bf03710200044e0bfc8bcbe5d7a"
          },
        "userName":"adela.cervantsz",
        "name":
          {
            "familyName":"Cervantsz",
            "givenName":"Adela"
          },
        "displayName":"Adela Cervantsz",
        "active":true,
        "emails":
          [
            {
              "value":"[e-mail]",
              "type":"work"
            }
          ],
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
          {
            "gender":"Female",
            "costCenter":
              {
                "value":"91e8bbf43710200044e0bfc8bcbe5daa",
                "name":"Customer Support"
              },
            "company":
              {
                "value":"31bea3d53790200044e0bfc8bcbe5dec",
                "name":"ACME North America"
              },
            "department":
              {
                "value":"5d7f17f03710200044e0bfc8bcbe5d43",
                "name":"Customer Support"
              },
            "location":
              {
                "value":"25ab93750a0a0bb30067bd2ef3d4a5c9",
                "name":"8306 Mills Drive, Miami,FL"
              }
          }
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM - GET /scim/Usuários/{user_id}

Retorna o registro de usuário especificado da tabela Usuário [sys_user] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users/{user_id}

URL padrão: /api/now/scim/Users/{user_id}

Parâmetros de solicitação compatíveis

Tabela 61. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
user_id	Sys_id do registro do usuário a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 62. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 63. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 64. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 65. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 66. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
grupos	Lista de grupos aos quais o usuário pertence, seja por associação direta, grupos aninhados ou calculados dinamicamente. Tipo de dados: matriz de objetos "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
grupos.exibição	Nome do grupo associado. Tipo de dados: cadeia de caracteres
grupos.tipo	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: cadeia de caracteres
grupos.valor	Sys_id de um registro de grupo associado. Tipo de dados: cadeia de caracteres
grupos.$ref	URI do grupo associado. Tipo de dados: cadeia de caracteres
id	Sys_id do registro do usuário associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao usuário. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do usuário foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do usuário. Tipo de dados: cadeia de caracteres
meta.local	URI do usuário que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso de Usuários de SCIM. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Usuário de SCIM usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres

Parâmetros de extensão retornados

Nome	Descrição
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "display": "String", "value": "String", "$ref": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "display": "String", "value": "String", "$ref": "String" }
centro de custos.exibição	Nome do centro de custos. Tipo de dados: cadeia de caracteres
centro de custos.valor	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
CostCenter.$ref	URI de referência para o centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "display": "String", "value": "String", "$ref": "String" }
departamento.exibição	Nome do departamento. Tipo de dados: cadeia de caracteres
departamento.valor	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
departamento.$ref	URI de referência do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Nome do local. Tipo de dados: cadeia de caracteres
local.valor	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
location.$ref	URI de referência do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "display": "String", "value": "String", "$ref": "String" }
gerente.exibição	Nome do gerente. Tipo de dados: cadeia de caracteres
gerente.valor	Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres
gerente.$ref	URI de referência do gerente. Tipo de dados: cadeia de caracteres

Solicitação de cURL usando o usuário sys_id

O exemplo a seguir mostra como obter um registro de usuário específico passando seu sys_id.

curl "https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
    "id":"62826bf03710200044e0bfc8bcbe5df1",
    "meta":
      {
        "resourceType":"User",
        "created":"2012-02-18T03:04:52Z",
        "lastModified":"2021-10-01T14:23:34Z",
        "location":"https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      },
    "userName":"abel.tuter",
    "name":
      {
        "familyName":"Tuter",
        "givenName":"Abel"
      },
    "displayName":"Abel Tuter",
    "active":true,
    "emails":[
      {
        "value":"[e-mail]",
        "type":"work"
      }
    ],
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
      {
        "gender":"Male",
        "costCenter":
          {
            "value":"d9d07bddc0a80a647cf932056ed24652",
            "name":"Engineering"
          },
        "company":
          {
            "value":"227cdfb03710200044e0bfc8bcbe5d6b",
            "name":"ACME South America"
          },
        "department":
          {
            "value":"9a7ed3f03710200044e0bfc8bcbe5db7",
            "name":"Product Management"
           },
        "location":
          {
            "value":"25b3d04b0a0a0bb300176b546c22db27",
            "name":"SHS quadra 5, Bloco E., Brasilia"}
          }
      }

SCIM - PATCH /scim/Usuários/{user_id}

Permite adicionar, substituir e remover campos especificados em um registro de usuário na tabela Usuário [sys_user] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users/{user_id}

URL padrão: /api/now/scim/Users/{user_id}

Parâmetros de solicitação compatíveis

Tabela 67. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
user_id	Sys_id do registro do usuário a ser modificado.

Tabela 68. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 69. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Operações	Obrigatório. Lista de objetos de operação para corrigir o registro do usuário especificado. Tipo de dados: matriz "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operações.op	Obrigatório. Operação a ser executada. Valores válidos: adicionar: adicione o campo e o valor especificados ao registro do usuário. remove: remove o valor do campo especificado. substituir: substitui o valor do campo especificado. Tipo de dados: cadeia de caracteres
Operations.path	Necessário para operações de remoção. Nome/caminho do campo a ser modificado. O parâmetro path pode ter um dos seguintes formatos: Um campo direto, como título Campos aninhados, como name.givenName Em caso de matriz complexa, ela pode apontar para um elemento específico com um filtro, como: e- mails[type eq "work"] { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "title", "value": "xyz" }, { "op": "replace", "path": "name.givenName", "value": "Jennifer" }, { "op": "replace", "path": "emails[type eq \"work\"]", "value": "[e-mail]" } ] } Tipo de dados: cadeia de caracteres Padrão: considera o campo um recurso do usuário.
Operations.value	Valor do campo especificado no parâmetro Operations.path. O formato deste parâmetro depende do tipo de dados do campo associado. Por exemplo, se estiver atualizando uma cadeia de caracteres simples, como o título, o campo value será expresso como uma cadeia de caracteres. "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] Você também pode declarar valores de cadeia de caracteres simples sem usar parâmetros value ou path, como: "Operations": [ { "op": "add", "title": "xyz" } ] No entanto, ao atualizar um número de telefone, que é uma matriz que contém objetos que definem campos adicionais a serem adicionados ao registro do usuário e seus valores associados, o campo value é expresso como uma matriz de objetos. "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] Ao especificar nós de atributo, a entrada pode incluir o aninhamento da seguinte forma: { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } Ou você pode especificar o aninhamento no Operations.path: { "op": "replace", "path": "name.givenName", "value": "Jennifer" } Se o campo que está sendo atualizado não estiver no esquema base, você deverá colocar o par nome-valor em um objeto que especifica o URN do esquema associado. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Por exemplo: "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, } Tipo de dados: qualquer
Operações.valor.tipo	Nome do campo a ser atualizado. Tipo de dados: cadeia de caracteres
Operações.valor.valor	Valor para atualizar o campo. Tipo de dados: cadeia de caracteres
esquemas	Obrigatório. URI do esquema do SCIM da operação de patch urn:ietf:params:scim:api:messages:2.0:PatchOp. Tipo de dados: cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 70. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 71. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 72. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Verifique se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. Foi fornecido um usuário ou grupo sys_id inválido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação ou que a solicitação não exceda o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	O usuário já existe. O parâmetro userName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
grupos	Lista de grupos aos quais o usuário pertence, seja por associação direta, grupos aninhados ou calculados dinamicamente. Tipo de dados: matriz de objetos "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
grupos.exibição	Nome do grupo associado. Tipo de dados: cadeia de caracteres
grupos.tipo	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: cadeia de caracteres
grupos.valor	Sys_id de um registro de grupo associado. Tipo de dados: cadeia de caracteres
grupos.$ref	URI do grupo associado. Tipo de dados: cadeia de caracteres
id	Sys_id do registro do usuário associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao usuário. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do usuário foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do usuário. Tipo de dados: cadeia de caracteres
meta.local	URI do usuário que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso de Usuários de SCIM. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Usuário de SCIM usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres

Parâmetros de extensão retornados

Nome	Descrição
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "display": "String", "value": "String", "$ref": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "display": "String", "value": "String", "$ref": "String" }
centro de custos.exibição	Nome do centro de custos. Tipo de dados: cadeia de caracteres
centro de custos.valor	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
CostCenter.$ref	URI de referência para o centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "display": "String", "value": "String", "$ref": "String" }
departamento.exibição	Nome do departamento. Tipo de dados: cadeia de caracteres
departamento.valor	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
departamento.$ref	URI de referência do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Nome do local. Tipo de dados: cadeia de caracteres
local.valor	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
location.$ref	URI de referência do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "display": "String", "value": "String", "$ref": "String" }
gerente.exibição	Nome do gerente. Tipo de dados: cadeia de caracteres
gerente.valor	Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres
gerente.$ref	URI de referência do gerente. Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir mostra como adicionar, remover e substituir valores em um registro de usuário.

curl -X PATCH \
  https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4 \
  -d '{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op" : "remove",
      "path" : "title" 
    },
    {
      "op" : "add",
      "path" : "phoneNumbers",
      "value" : [
        {
          "type" : "work",
          "value" : "9876543210"
        }
      ]
    },
    {
      "op": "replace",
      "value": {
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
            "employeeNumber": "13454"
        },
        "name": {
            "familyName": "John",
            "givenName": "Smith"
        }
      }
    }
  ]
}'

Resposta:

{
  "schemas":[
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id":"005d500b536073005e0addeeff7b12f4",
  "meta":{
    "resourceType":"User",
    "created":"2019-04-05T21:09:12Z",
    "lastModified":"2021-10-12T18:29:27Z",
    "location":"https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4"
  },
  "userName":"survey.user",
  "name":{
    "familyName":"John",
    "givenName":"Smith"
  },
  "displayName":"Smith John",
  "active":true,
  "emails":[
    {
      "value":"[e-mail]",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9876543210",
      "type":"work"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":{
    "employeeNumber":"13454"
  }
}

SCIM - POST /scim/Usuários

Cria um registro de usuário na tabela Usuário [sys_user] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

A funcionalidade de pesquisa e modificações em massa, conforme observado na especificação RFC7643, não é compatível com este endpoint.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users

URL padrão: /api/now/scim/Users

Parâmetros de solicitação compatíveis

Tabela 73. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 74. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Obrigatório. Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres
Esquema Estendido
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "value": "String" }
empresa.valor	Obrigatório se a empresa estiver incluída na publicação. Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "value": "String" }
centro de custos.valor	Obrigatório se o CostCenter estiver incluído na publicação. Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "value": "String" }
departamento.valor	Obrigatório se o departamento estiver incluído na publicação. Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "value": "String" }
local.valor	Obrigatório se o local estiver incluído na publicação. Sys_id do registro do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "value": "String" }
gerente.valor	Obrigatório se o gerente estiver incluído na publicação. Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 76. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 77. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 78. Códigos de status

Código de status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
409	O usuário já existe. O parâmetro userName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
grupos	Lista de grupos aos quais o usuário pertence, seja por associação direta, grupos aninhados ou calculados dinamicamente. Tipo de dados: matriz de objetos "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
grupos.exibição	Nome do grupo associado. Tipo de dados: cadeia de caracteres
grupos.tipo	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: cadeia de caracteres
grupos.valor	Sys_id de um registro de grupo associado. Tipo de dados: cadeia de caracteres
grupos.$ref	URI do grupo associado. Tipo de dados: cadeia de caracteres
id	Sys_id do registro do usuário associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao usuário. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do usuário foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do usuário. Tipo de dados: cadeia de caracteres
meta.local	URI do usuário que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso de Usuários de SCIM. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Usuário de SCIM usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres

Solicitação de cURL para usuário POST

Este exemplo mostra como POST o usuário Jack Sprow para a tabela Usuário [sys_user].

curl -X POST \
  https://instance-servicenow.com/api/now/scim/Users \
  -d '{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "externalId": "123456",
    "userName": "jack.sparrow",
    "name": {
        "familyName": "Sparrow",
        "givenName": "Jack"
    },
    "title": "Senior Developer",
    "preferredLanguage": "en",
    "timezone": "ET",
    "active": true,
    "emails": [
      {
        "value": "[e-mail]",
        "display": null,
        "type": "work",
        "primary": true
      }
    ],
    "phoneNumbers": [
      {
        "value": "9977553312",
        "type": "mobile",
        "primary": true
      }
    ]
}'

Resposta

{"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id":"d6287d7b1bbe3010593876a61a4bcbc3",
  "externalId":"123456",
  "meta":{
    "resourceType":"User",
    "created":"2021-10-01T16:46:48Z",
    "lastModified":"2021-10-01T16:46:48Z",
    "location":"https://instance-servicenow.com/api/now/scim/Users/d6287d7b1bbe3010593876a61a4bcbc3"
  },
  "userName":"jack.sparrow",
  "name":{
    "familyName":"Sparrow",
    "givenName":"Jack"
  },
  "displayName":"Jack Sparrow",
  "title":"Senior Developer",
  "preferredLanguage":"en",
  "timezone":"ET",
  "active":true,
  "emails":[
    {
      "value":"[e-mail]",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9977553312",
      "type":"mobile"
    }
  ]
}

SCIM - PUT /scim/Usuários/{user_id}

Atualiza o registro do usuário especificado na tabela Usuário [sys_user] de uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Users/{user_id}

URL padrão: /api/now/scim/Users/{user_id}

Parâmetros de solicitação compatíveis

Tabela 79. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
user_id	Sys_id do registro do usuário a ser atualizado.

Tabela 80. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 81. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Obrigatório. Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres
Esquema Estendido
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "value": "String" }
empresa.valor	Obrigatório se a empresa estiver incluída na publicação. Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "value": "String" }
centro de custos.valor	Obrigatório se o CostCenter estiver incluído na publicação. Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "value": "String" }
departamento.valor	Obrigatório se o departamento estiver incluído na publicação. Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "value": "String" }
local.valor	Obrigatório se o local estiver incluído na publicação. Sys_id do registro do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "value": "String" }
gerente.valor	Obrigatório se o gerente estiver incluído na publicação. Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 82. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 83. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 84. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.
409	O usuário já existe. O parâmetro userName deve ser exclusivo.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo na instância ServiceNow. Valores possíveis: verdadeiro: o usuário está ativo. falso: o usuário está inativo. Tipo de dados: booliano
endereços	Detalhes do endereço de correspondência atual do usuário. Tipo de dados: objeto "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
address.country	Nome do país. Tipo de dados: cadeia de caracteres
endereços.localidade	Nome da cidade ou localidade. Tipo de dados: cadeia de caracteres
endereços.Códigopostal	CEP ou código postal. Tipo de dados: cadeia de caracteres
endereços.região	Estado ou região. Tipo de dados: cadeia de caracteres
endereços.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações do endereço estendido de várias linhas. Tipo de dados: cadeia de caracteres
address.type	Tipo de endereço. Atualmente, oferece suporte somente à página inicial. Tipo de dados: cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente pela concatenação dos campos name. Tipo de dados: cadeia de caracteres
e-mails	Lista de contas de e-mail associadas ao usuário. Tipo de dados: matriz de objetos "emails:" [ { "type": "String", "value": "String" } ]
e-mails.tipo	Tipo de e-mail do usuário. Atualmente, oferece suporte somente ao tipo de "trabalho". Tipo de dados: cadeia de caracteres
e-mails.valor	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: cadeia de caracteres
erros	Resposta que descreve todos os erros que podem ter ocorrido durante o processamento da solicitação. Tipo de dados: objeto "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
erros.detalhe	Mensagem de erro detalhada sobre o motivo da falha da solicitação. Tipo de dados: cadeia de caracteres
erros.scimType	Palavra-chave de detalhes do erro de SCIM. Tipo de dados: cadeia de caracteres
erros.esquemas	URI dos esquemas SCIM usados para processar a resposta de erro. Tipo de dados: matriz de cadeias de caracteres
erros.status	Código de status HTTP para a resposta de erro. Tipo de dados: cadeia de caracteres
IDexterno	Identificador exclusivo atribuído ao usuário pela entidade que o provisiona. Tipo de dados: cadeia de caracteres
grupos	Lista de grupos aos quais o usuário pertence, seja por associação direta, grupos aninhados ou calculados dinamicamente. Tipo de dados: matriz de objetos "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
grupos.exibição	Nome do grupo associado. Tipo de dados: cadeia de caracteres
grupos.tipo	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: cadeia de caracteres
grupos.valor	Sys_id de um registro de grupo associado. Tipo de dados: cadeia de caracteres
grupos.$ref	URI do grupo associado. Tipo de dados: cadeia de caracteres
id	Sys_id do registro do usuário associado. Tipo de dados: cadeia de caracteres
meta	Metadados pertencentes ao usuário. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.criado	Data e hora em que o registro do usuário foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora da última modificação do registro do usuário. Tipo de dados: cadeia de caracteres
meta.local	URI do usuário que está sendo recuperado. Tipo de dados: cadeia de caracteres
meta.resourceType	Tipo de recurso de Usuários de SCIM. Tipo de dados: cadeia de caracteres
nome	Informações do nome do usuário. Tipo de dados: objeto "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	Sobrenome ou sobrenome do usuário. Tipo de dados: cadeia de caracteres
nome.givenName	Nome ou nome fornecido do usuário. Tipo de dados: cadeia de caracteres
nome.prefixohonorífico	Nome honorífico ou título do usuário, como Dr.,Bispo ou Barão. Tipo de dados: cadeia de caracteres
nome.meio	Nome do meio do usuário. Tipo de dados: cadeia de caracteres
phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: cadeia de caracteres
phoneNumbers.value	Número de telefone do usuário. Tipo de dados: cadeia de caracteres
PreferredLanguage	Idioma falado e escrito preferencial do usuário. Tipo de dados: cadeia de caracteres
esquemas	Lista de URIs dos esquemas de Usuário de SCIM usados para processar a solicitação. Tipo de dados: matriz de cadeias de caracteres
fuso horário	Fuso horário do usuário. Tipo de dados: cadeia de caracteres
título	Cargo do usuário, como diretor executivo ou diretor. Tipo de dados: cadeia de caracteres
userName	Nome de usuário exclusivo para o usuário associado. Tipo de dados: cadeia de caracteres
userType	Tipo de usuário. Este valor é usado para identificar o relacionamento da organização com o usuário. Pode ser qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temp Externo Desconhecido Tipo de dados: cadeia de caracteres

Parâmetros de extensão retornados

Nome	Descrição
empresa	Detalhes sobre a empresa associada do usuário. Tipo de dados: objeto "company": { "display": "String", "value": "String", "$ref": "String" }
empresa.tela	Nome da empresa. Tipo de dados: cadeia de caracteres
empresa.valor	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
empresa.$ref	URI de referência da empresa. Tipo de dados: cadeia de caracteres
Centro de custos	Detalhes sobre o centro de custos associado do usuário. Tipo de dados: objeto "costCenter": { "display": "String", "value": "String", "$ref": "String" }
centro de custos.exibição	Nome do centro de custos. Tipo de dados: cadeia de caracteres
centro de custos.valor	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
CostCenter.$ref	URI de referência para o centro de custos. Tipo de dados: cadeia de caracteres
departamento	Detalhes sobre o departamento associado do usuário. Tipo de dados: objeto "department": { "display": "String", "value": "String", "$ref": "String" }
departamento.exibição	Nome do departamento. Tipo de dados: cadeia de caracteres
departamento.valor	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
departamento.$ref	URI de referência do departamento. Tipo de dados: cadeia de caracteres
employeeNumber	Número numérico ou alfanumérico do funcionário. Tipo de dados: cadeia de caracteres
gênero	Sexo do usuário, como masculino ou feminino. Tipo de dados: cadeia de caracteres
local	Detalhes sobre o local associado do usuário. Tipo de dados: objeto "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Nome do local. Tipo de dados: cadeia de caracteres
local.valor	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
location.$ref	URI de referência do local. Tipo de dados: cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: objeto "manager": { "display": "String", "value": "String", "$ref": "String" }
gerente.exibição	Nome do gerente. Tipo de dados: cadeia de caracteres
gerente.valor	Sys_id do registro do gerente. Tipo de dados: cadeia de caracteres
gerente.$ref	URI de referência do gerente. Tipo de dados: cadeia de caracteres

Solicitação cURL para atualizar informações do usuário usando PUT

Este exemplo mostra como atualizar as informações de um usuário existente usando o endpoint PUT.

curl -X PUT \
  https://instance-servicenow.com/api/now/scim/Users/cdfef423e0423010f8778ac6d674f5ae \
  -d '{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "123457",
  "userName": "john.Doe",
  "name": {
    "familyName": "Doe",
    "givenName": "John"
  },
  "title": "Sir",
  "preferredLanguage": "en",
  "timezone": "ET",
  "active": true,
  "emails": [
    {
      "value": "[e-mail]",
      "display": null,
      "type": "work",
      "primary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "9977553312",
      "type": "mobile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "gender": "Male",
    "employeeNumber" : "13453",
    "location" : {
      "value" : "0002c0a93790200044e0bfc8bcbe5df5"
    },
    "company" : {
      "value" : "81fd65ecac1d55eb42a426568fc87a63"
    },
    "costCenter" : {
      "value" : "7fb1cc99c0a80a6d30c04574d14c0acf"
    },
    "department" : {
      "value":"221db0edc611228401760aec06c9d929"
    }
  }
}'

Resposta

{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "b7c5015f778330102e8cc5179e5a9992",
  "externalId": "123457",
  "meta": {
    "resourceType": "User",
    "created": "2021-10-12T10:05:32Z",
    "lastModified": "2021-10-12T10:08:04Z",
    "location":
      "http://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992"
  },
  "userName": "john.doe",
  "name": {
    "familyName": "Doe",
    "givenName": "John"
  },
  "displayName": "John Doe",
  "title": "Sir",
  "preferredLanguage": "en",
  "timezone": "ET",
  "active": true,
  "emails": [
    {
      "value": "[e-mail]",
      "type": "work"
    }
  ],
  "phoneNumbers": [
    {
      "value": "9977553312",
      "type": "mobile"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "employeeNumber": "13453",
    "gender": "Male",
    "costCenter": {
      "value": "7fb1cc99c0a80a6d30c04574d14c0acf",
      "name": "Sales",
      "$ref":
       "http://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
    },
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref":
       "http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    },
    "department": {
      "value": "221db0edc611228401760aec06c9d929",
      "name": "Sales",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
    },
    "manager": {
      "value": "7027fda8773230102e8cc5179e5a99ea",
      "displayName": "Jack Sparrow",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Users/7027fda8773230102e8cc5179e5a99ea"
    },
    "location": {
      "value": "0002c0a93790200044e0bfc8bcbe5df5",
      "name": "2-10-1 Yurakucho, Chiyoda-ku, Tokyo",
      "$ref":
        "http://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5"
    }
  }
}

SCIM - GET /scim/ResourceTypes

Recupera informações sobre todos os tipos de recurso do sistema para gestão de identidade entre domínios (SCIM) compatíveis com a instância ServiceNow associada.

Este é um endpoint público e não requer funções para acessar.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/ResourceTypes

URL padrão: /api/now/scim/ResourceTypes

Parâmetros de solicitação compatíveis

Tabela 85. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 86. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 87. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 88. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 89. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 90. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de tipos de recursos disponíveis. Tipo de dados: matriz de objetos "Resources": [ { "description": "String", "endpoint": "String", "id": "String", "meta": {Object}, "name": "String", "schema": "String" "schemas": [Array], "schemaExtensions": [Array] } ]
Recursos.descrição	Breve descrição do tipo de recurso. Tipo de dados: cadeia de caracteres
Recursos.endpoint	Nome do endpoint endereçável por HTTP em relação ao URL base do provedor de serviços, por exemplo, "Usuários". Tipo de dados: cadeia de caracteres
Resources.id	Identificador exclusivo do recurso. Use este atributo ao chamar o endpoint GET /scim/ResourceType/{resource_id}. Tipo de dados: cadeia de caracteres
Recursos.meta	Informações que descrevem melhor o recurso associado. Tipo de dados: objeto "metadata": { "location": "String", "resourceType": "String" }
Recursos.meta.local	URI do tipo de recurso associado na instância ServiceNow associada. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	Sempre "ResourceType". Tipo de dados: cadeia de caracteres
Resources.name	Nome do tipo de recurso, como Usuário ou Grupo. Tipo de dados: cadeia de caracteres
Recursos.esquema	URI do esquema primário/base do tipo de recurso. Por exemplo: "urn:ietf:params:scim:schemas:core:2.0:User". Tipo de dados: cadeia de caracteres
Recursos.esquemas	Esquema usado para processar a solicitação /ResourceType. Por exemplo: "urn:ietf:params:scim:schemas:core:2.0:ResourceType". Tipo de dados: cadeia de caracteres
Recursos.esquemaExtensões	Lista de extensões de esquema que se aplicam ao tipo de recurso associado. Por exemplo: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Tipo de dados: matriz de objeto "schemaExtensions": { "required": Boolean, "schema": "String" }
Recursos.esquemaExtensões.necessário	Sinalizador que indica se a extensão do esquema é necessária para o tipo de recurso. Valores possíveis: verdadeiro: um recurso deste tipo deve incluir esta extensão de esquema e também incluir todos os atributos declarados como necessários nesta extensão de esquema. falso: um recurso deste tipo pode omitir esta extensão de esquema. Tipo de dados: booliano
Recursos.esquemaExtensões.esquema	URI de um esquema estendido. Por exemplo: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a resposta da lista à solicitação. Por exemplo: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Tipo de dados: cadeia de caracteres
startIndex	Índice baseado em um na tabela de recursos na qual os registros foram recuperados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL

O exemplo a seguir mostra como obter os tipos de recursos de SCIM compatíveis com uma instância ServiceNow.

curl "https://instance-servicenow.com/api/now/scim/ResourceTypes \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":6,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"User",
      "name":"User",
      "description":"User Account",
      "endpoint":"/Users",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:User",
      "schemaExtensions":[
        {
          "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
          "required":false
        },
        {
          "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
          "required":false
        }
      ],
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Group",
      "name":"Group",
      "description":"Group",
      "endpoint":"/Groups",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:Group",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.service-now.com/api/now/scim/ResourceTypes/Group"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Company",
      "name":"Company",
      "description":"Company",
      "endpoint":"/Companies",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Company"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Department",
      "name":"Department",
      "description":"Department",
      "endpoint":"/Departments",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Department"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"CostCenter",
      "name":"CostCenter",
      "description":"CostCenter",
      "endpoint":"/CostCenters",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/CostCenter"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Location",
      "name":"Location",
      "description":"Location",
      "endpoint":"/Locations",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Location"
      }
    }
  ],
  "startIndex":1,
  "itemsPerPage":6
}

SCIM - GET /scim/ResourceTypes/{ResourceName}

Recupera informações sobre o tipo de recurso especificado do sistema para gestão de identidade entre domínios (SCIM).

Este é um endpoint público e não requer funções para acessar.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/ResourceTypes/{ResourceName}

URL padrão: /api/now/scim/ResourceTypes/{ResourceName}

Parâmetros de solicitação compatíveis

Tabela 91. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
ResourceName	ID exclusivo do tipo de recurso a ser recuperado. Valores válidos: Empresa CostCenter Departamento Grupo Localização Usuário Tipo de dados: cadeia de caracteres

Tabela 92. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 93. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 94. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 95. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 96. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
description	Breve descrição do tipo de recurso. Tipo de dados: cadeia de caracteres
endpoint	Nome do endpoint endereçável por HTTP relativo ao URL base do provedor de serviços, por exemplo, "Empresas". Tipo de dados: cadeia de caracteres
id	Identificador exclusivo do recurso. Use este atributo ao chamar o endpoint GET /scim/ResourceType/{resource_id}. Tipo de dados: cadeia de caracteres
meta	Informações que descrevem melhor o recurso associado. Tipo de dados: objeto "metadata": { "location": "String", "resourceType": "String" }
meta.local	URI do tipo de recurso associado na instância ServiceNow associada. Tipo de dados: cadeia de caracteres
meta.resourceType	Sempre "ResourceType". Tipo de dados: cadeia de caracteres
nome	Nome do tipo de recurso, como Usuário ou Grupo. Tipo de dados: cadeia de caracteres
esquema	URI do esquema primário/base do tipo de recurso. Por exemplo: "urn:ietf:params:scim:schemas:core:2.0:User". Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a solicitação /ResourceType. Por exemplo: "urn:ietf:params:scim:schemas:core:2.0:ResourceType". Tipo de dados: cadeia de caracteres
esquemaExtensões	Lista de extensões de esquema que se aplicam ao tipo de recurso associado. Por exemplo: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Tipo de dados: matriz de objeto "schemaExtensions": { "required": Boolean, "schema": "String" }
SchemaExtensions.required	Sinalizador que indica se a extensão do esquema é necessária para o tipo de recurso. Valores possíveis: verdadeiro: um recurso deste tipo deve incluir esta extensão de esquema e também incluir todos os atributos declarados como necessários nesta extensão de esquema. falso: um recurso deste tipo pode omitir esta extensão de esquema. Tipo de dados: booliano
esquemaExtensões.esquema	URI de um esquema estendido. Por exemplo: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a resposta da lista à solicitação. Por exemplo: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo a seguir mostra como obter o tipo de recurso SCIM do usuário de uma instância ServiceNow.

curl "https://instance-servicenow.com/api/now/scim/ResourceTypes/"User" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
  ],
  "id":"User",
  "name":"User",
  "description":"User Account",
  "endpoint":"/Users",
  "schema":"urn:ietf:params:scim:schemas:core:2.0:User",
  "schemaExtensions":[
    {
      "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
      "required":false
    },
    {
      "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
      "required":false
    }
  ],
  "meta":{
    "resourceType":"ResourceType",
    "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User"
  }
}

SCIM - GET /scim/Schemas

Recupera informações sobre todos os esquemas de recursos do sistema para gestão de identidade entre domínios (SCIM) compatíveis com uma instância ServiceNow. Esses esquemas definem os atributos disponíveis para cada tipo de recurso.

Este é um endpoint público e não requer funções para acessar.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Schemas

URL padrão: /api/now/scim/Schemas

Parâmetros de solicitação compatíveis

Tabela 97. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 98. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 99. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 100. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 101. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 102. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
RFC7643 padrão retorna resultados	O método retorna resultados em conformidade com o padrão RFC7643. Para obter detalhes, consulte Definição de esquema na especificação RFC7643.

Solicitação de cURL

O exemplo a seguir mostra como obter os esquemas de SCIM compatíveis com uma instância ServiceNow.

curl "https://instance-servicenow.com/api/now/scim/Schemas \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":8,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
      ],
      "id":"urn:ietf:params:scim:schemas:core:2.0:User",
      "name":"User",
      "description":"User Account",
      "attributes":[
        {
          "name":"active",
          "type":"boolean",
          "multiValued":false,
          "description":"A Boolean value indicating the User's administrative status.",
          "required":false,
          "caseExact":true,
          "mutability":"readWrite",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"addresses",
          "type":"complex",
          "subAttributes":[
            {
              "name":"country",
              "type":"string",
              "multiValued":false,
              "description":"The country name component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"formatted",
              "type":"string",
              "multiValued":false,
              "description":"The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"locality",
              "type":"string",
              "multiValued":false,
              "description":"The city or locality component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"postalCode",
              "type":"string",
              "multiValued":false,
              "description":"The zipcode or postal code component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"primary",
              "type":"boolean",
              "multiValued":false,
              "description":"A Boolean value indicating the 'primary' or 
                preferred attribute value for this attribute, e.g., the preferred address. 
                The primary attribute value 'true' MUST appear no more than once.",
              "required":false,
              "caseExact":true,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"region",
              "type":"string",
              "multiValued":false,
              "description":"The state or region component.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"streetAddress",
              "type":"string",
              "multiValued":false,
              "description":"The full street address component, which may include house number, 
                street name, PO BOX, and multi-line extended street address information. This 
                attribute MAY contain newlines.",
              "required":false,
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            },
            {
              "name":"type",
              "type":"string",
              "multiValued":false,
              "description":"A label indicating the attribute's function; e.g., 'work' or 'home'.",
              "required":false,
              "canonicalValues":["other","work","home"],
              "caseExact":false,
              "mutability":"readWrite",
              "returned":"default",
              "uniqueness":"none"
            }
          ],
          "multiValued":true,
          "description":"Physical mailing addresses for this User.",
          "required":false,
          "caseExact":true,
          "mutability":"readWrite",
          "returned":"default",
          "uniqueness":"none"
        },
.
.
.
      {
        "schemas":[
          "urn:ietf:params:scim:schemas:core:2.0:Schema"
        ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department",
        "name":"Department",
        "description":"Department",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The name of the department.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":{
          "resourceType":"Schema",
          "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
        }
      },
      {
        "schemas":[
          "urn:ietf:params:scim:schemas:core:2.0:Schema"
        ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter",
        "name":"CostCenter",
        "description":"CostCenter",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The name of the cost center.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":
          {
            "resourceType":"Schema",
            "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
         }
        },
        {
          "schemas":[
            "urn:ietf:params:scim:schemas:core:2.0:Schema"
          ],
        "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location",
        "name":"Location",
        "description":"Location",
        "attributes":[
          {
            "name":"name",
            "type":"string",
            "multiValued":false,
            "description":"The location name.",
            "required":false,
            "caseExact":false,
            "mutability":"readOnly",
            "returned":"default",
            "uniqueness":"none"
          }
        ],
        "meta":{
          "resourceType":"Schema",
          "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"
        }
      }
    ],
    "startIndex":1,
  "itemsPerPage":8
}

SCIM - GET /scim/Schemas/{SchemaName}

Recupera informações sobre os esquemas de recursos especificados do sistema para gestão de identidade entre domínios (SCIM) compatíveis com uma instância ServiceNow. Esses esquemas definem os atributos disponíveis para cada tipo de recurso.

Este é um endpoint público e não requer funções para acessar.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Schemas/{SchemaName}

URL padrão: /api/now/scim/Schemas/{SchemaName}

Parâmetros de solicitação compatíveis

Tabela 103. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
SchemaName	URI do esquema de recursos a ser retornado. Valores válidos: urn:ietf:params:scim:schemas:core:2.0:User urn:ietf:params:scim:schemas:extension: Enterprise:2.0:User urn:ietf:params:scim:schemas:extension: servicenow:2.0:User urn:ietf:params:scim:schemas:core:2.0:Group urn:ietf:params:scim:schemas:custom: servicenow:2.0:Company urn:ietf:params:scim:schemas:custom: servicenow:2.0:Department urn:ietf:params:scim:schemas:custom: servicenow:2.0:CostCenter urn:ietf:params:scim:schemas:custom: servicenow:2.0:Location Tipo de dados: cadeia de caracteres

Tabela 104. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 105. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 106. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 107. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 108. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
RFC7643 padrão retorna resultados	O método retorna resultados em conformidade com o padrão RFC7643. Para obter detalhes, consulte Definição de esquema na especificação RFC7643.

Solicitação de cURL

O exemplo a seguir mostra como obter o esquema principal do SCIM de grupo de uma instância ServiceNow.

curl "https://instance-servicenow.com/api/now/scim/Schemas/"urn:ietf:params:scim:schemas:core:2.0:Group" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id":"urn:ietf:params:scim:schemas:core:2.0:Group",
  "name":"Group",
  "description":"Group",
  "attributes":[
    {
      "name":"displayName",
      "type":"string",
      "multiValued":false,
      "description":"A human-readable name for the Group.",
      "required":true,
      "caseExact":false,
      "mutability":"readWrite",
      "returned":"default",
      "uniqueness":"none"
    },
    {
      "name":"members",
      "type":"complex",
      "subAttributes":[
        {
          "name":"display",
          "type":"string",
          "multiValued":false,
          "description":"A human readable name, primarily used for display purposes.",
          "required":false,
          "caseExact":false,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"value",
          "type":"string",
          "multiValued":false,
          "description":"The identifier of a group member.",
          "required":true,
          "caseExact":false,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none"
        },
        {
          "name":"$ref",
          "type":"reference",
          "multiValued":false,
          "description":"The URI of the member resource.",
          "required":false,
          "caseExact":true,
          "mutability":"immutable",
          "returned":"default",
          "uniqueness":"none",
          "referenceTypes":["Group","User"]
        }
      ],
      "multiValued":true,
      "description":"A list of members of the Group.",
      "required":false,
      "caseExact":true,
      "mutability":"readWrite",
      "returned":"default",
      "uniqueness":"none"
    }
  ],
  "meta":{
    "resourceType":"Schema",
    "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
  }
}

SCIM - GET /scim/ServiceProviderConfig

Retorna os metadados de configuração a serem usados para obter informações sobre as capacidades de serviço, configurações, esquemas e tipos de recursos para os endpoints do sistema de gestão de identidade entre domínios (SCIM) disponíveis em uma instância ServiceNow.

Este é um endpoint público e não requer funções para acessar.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/ServiceProviderConfig

URL padrão: /api/now/scim/ServiceProviderConfig

Parâmetros de solicitação compatíveis

Tabela 109. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 110. Parâmetros de consulta

Nome	Descrição
Nenhum

Tabela 111. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 112. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 113. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 114. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
RFC7643 padrão retorna resultados	O método retorna resultados em conformidade com o padrão RFC7643. Para obter detalhes, consulte Esquema de configuração do provedor de serviços na especificação RFC7643.

Solicitação de cURL

O exemplo a seguir mostra como obter os metadados de configuração do SCIM para uma instância ServiceNow.

curl "https://instance-servicenow.com/api/now/scim/ServiceProviderConfig \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ],
  "patch": {
    "supported": true
  },
  "bulk": {
    "supported": false,
    "maxOperations": 0,
    "maxPayloadSize": 1000000
  },
  "filter": {
    "supported": true,
    "maxResults": 500
  },
  "changePassword": {
    "supported": false
  },
  "sort": {
    "supported": false
  },
  "etag": {
    "supported": false
  },
  "authenticationSchemes": [
    {
      "name": "OAuth 2.0 Bearer Token",
      "description": "The OAuth 2.0 Bearer Token Authentication scheme. OAuth
        enables clients to access protected resources by obtaining an access token, which is
        defined in RFC 6750 as \"a string representing an access authorization issued to the
        client\", rather than using the resource owner's credentials directly.",
      "specUri": "http://tools.ietf.org/html/rfc6750",
      "type": "oauthbearertoken",
      "primary": true
    }
  ]
}

SCIM - GET /scim/Empresas

Retorna um ou mais registros de empresa da tabela Empresa [core_company] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Companies

URL padrão: /api/now/scim/Empresas

Parâmetros de solicitação compatíveis

Tabela 115. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 116. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível com este método. Por exemplo, para filtrar todas as empresas cujo nome começa com "Acme", insira displayName SW "Acme". Para especificar mais de um filtro de campo, concatene os filtros usando o operando E. Por exemplo, para filtrar todas as empresas cujo nome começa com "Acme" e foram modificadas pela última vez antes de 3 de outubro de 2021, insira displayName SW "Acme" AND meta.lastModified lt "2021-10-03T00:00:00Z". Use a referência com pontos para especificar atributos aninhados. Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, exceto que externalId não é permitido. Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: sem classificação
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 117. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 118. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 119. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 120. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros de centro de custos retornados. Tipo de dados: objeto "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
Recursos.meta	Informações pertencentes ao registro da empresa. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Recursos.meta.criados	Data e hora em que o registro da empresa associada foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora em que o registro da empresa associada foi modificado pela última vez. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do registro da empresa associada. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	tipo de recurso de SCIM; sempre Empresa. Tipo de dados: cadeia de caracteres
Resources.name	Nome da empresa. Tipo de dados: cadeia de caracteres
Recursos.esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a resposta da lista à solicitação. Por exemplo: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Tipo de dados: cadeia de caracteres
startIndex	Índice baseado em um na tabela Empresa [core_company] na qual os registros foram retornados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL

Este exemplo mostra como recuperar os dois primeiros registros da empresa.

curl "https://instance-servicenow.com/api/now/scim/Companies?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":182,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
      ],
      "id":"0c43af40c6112275011a4bd4c0143fbf",
      "meta":{
        "resourceType":"Company",
        "created":"2005-05-24T01:14:19Z",
        "lastModified":"2013-05-06T23:44:48Z",
        "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf"
      },
      "name":"ABC Company"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
      ],
      "id":"0c43b088c6112275011a4bd46a4e6cc4",
      "meta":{
        "resourceType":"Company",
        "created":"2005-05-24T01:14:19Z",
        "lastModified":"2013-06-05T17:53:26Z",
        "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43b088c6112275011a4bd46a4e6cc4"
      },
      "name":"Acme Co"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM - GET /scim/Empresas/{company_id}

Retorna o registro da empresa especificado da tabela Empresa [core_company] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Companies/{company_id}

URL padrão: /api/now/scim/Groups/{company_id}

Parâmetros de solicitação compatíveis

Tabela 121. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
id_da_empresa	Sys_id do registro da empresa a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 122. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 123. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 124. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 125. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 126. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
id	Sys_id do registro da empresa. Tipo de dados: cadeia de caracteres
meta	Informações pertencentes ao registro da empresa. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.criado	Data e hora em que o registro da empresa associada foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora em que o registro da empresa associada foi modificado pela última vez. Tipo de dados: cadeia de caracteres
meta.local	URI do registro da empresa associada. Tipo de dados: cadeia de caracteres
meta.resourceType	tipo de recurso de SCIM; sempre Empresa. Tipo de dados: cadeia de caracteres
nome	Nome da empresa. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como recuperar um registro de empresa específico.

curl "https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company"
  ],
  "id":"0c43af40c6112275011a4bd4c0143fbf",
  "meta":{
    "resourceType":"Company",
    "created":"2005-05-24T01:14:19Z",
    "lastModified":"2013-05-06T23:44:48Z",
    "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf"
  },
  "name":"ABC Company"
}

SCIM - GET /scim/CostCenters

Retorna um ou mais registros de centro de custos da tabela Centro de custos [cmn_cost_center] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/CostCenters

URL padrão: /api/now/scim/CostCenters

Parâmetros de solicitação compatíveis

Tabela 127. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 128. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível com este método. Por exemplo, para filtrar todos os centros de custos cujo nome começa com "RH", insira SW "RH". Para especificar mais de um filtro de campo, concatene os filtros usando o operando E. Por exemplo, para filtrar todos os centros de custos cujo nome começa com "RH" e foram modificados pela última vez antes de 3 de outubro de 2021, insira displayName SW "HR" AND meta.lastModified lt "2021-10-03T00:00:00Z". Use a referência com pontos para especificar atributos aninhados. Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, exceto que externalId não é permitido. Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: sem classificação
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 129. Parâmetros do corpo da solicitação (SON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 130. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 131. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 132. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros de centro de custos retornados. Tipo de dados: objeto "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
Recursos.meta	Informações pertencentes ao registro do centro de custos. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Recursos.meta.criados	Data e hora em que o registro do centro de custos associado foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora em que o registro do centro de custos associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do registro do centro de custos associado. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	tipo de recurso de SCIM; sempre CostCenter. Tipo de dados: cadeia de caracteres
Resources.name	Nome do centro de custos. Tipo de dados: cadeia de caracteres
Recursos.esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a resposta da lista à solicitação. Por exemplo: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Tipo de dados: cadeia de caracteres
startIndex	Índice baseado em um na tabela Centro de custos [cmn_cost_center] na qual os registros foram retornados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL

Este exemplo mostra como recuperar os dois primeiros registros de centro de custos.

curl "https://instance-servicenow.com/api/now/scim/CostCenters?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":8,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
      ],
      "id":"7fb1cc99c0a80a6d30c04574d14c0acf",
      "meta":{
        "resourceType":"CostCenter",
        "created":"2012-01-19T21:02:39Z",
        "lastModified":"2012-02-25T23:06:36Z",
        "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
      },
      "name":"Sales"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
      ],
      "id":"91e8bbf43710200044e0bfc8bcbe5daa",
      "meta":{
        "resourceType":"CostCenter",
        "created":"2012-02-18T04:40:24Z",
        "lastModified":"2012-02-25T23:05:58Z",
        "location":"https://instance-servicenow.com/api/now/scim/CostCenters/91e8bbf43710200044e0bfc8bcbe5daa"
      },
      "name":"Customer Support"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM - GET /scim/CostCenters/{cost_center_id}

Retorna o registro do centro de custos especificado da tabela Centro de custos [cmn_cost_center] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/CostCenters/{cost_center_id}

URL padrão: /api/now/scim/CoostCenters/{cost_center_id}

Parâmetros de solicitação compatíveis

Tabela 133. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
id_do_centro_de_custo	Sys_id do registro do centro de custos a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 134. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 135. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 136. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 137. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 138. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
id	Sys_id do registro do centro de custos. Tipo de dados: cadeia de caracteres
meta	Informações pertencentes ao registro do centro de custos. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.criado	Data e hora em que o registro do centro de custos associado foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora em que o registro do centro de custos associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
meta.local	URI do registro do centro de custos associado. Tipo de dados: cadeia de caracteres
meta.resourceType	tipo de recurso de SCIM; sempre CostCenter. Tipo de dados: cadeia de caracteres
nome	Nome do centro de custos. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como recuperar um registro de centro de custos específico.

curl "https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter"
  ],
  "id":"7fb1cc99c0a80a6d30c04574d14c0acf",
  "meta":{
    "resourceType":"CostCenter",
    "created":"2012-01-19T21:02:39Z",
    "lastModified":"2012-02-25T23:06:36Z",
    "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf"
  },
  "name":"Sales"
}

SCIM - GET /scim/Departamentos

Retorna um ou mais registros de departamento da tabela Departamento [cmn_department] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Departments

URL padrão: /api/now/scim/Departments

Parâmetros de solicitação compatíveis

Tabela 139. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 140. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível com este método. Por exemplo, para filtrar todos os departamentos cujo nome começa com "Engenheiro", insira SW "Engenheiro". Para especificar mais de um filtro de campo, concatene os filtros usando o operando E. Por exemplo, para filtrar todos os departamentos cujo nome começa com "Engenheiro" e foram modificados pela última vez antes de 3 de outubro de 2021, insira displayName SW "Engineer" AND meta.lastModified lt "2021-10-03T00:00:00Z". Use a referência com pontos para especificar atributos aninhados. Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, exceto que externalId não é permitido. Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: sem classificação
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 141. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 142. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 143. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 144. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros de departamento retornados. Tipo de dados: objeto "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
Recursos.meta	Informações pertencentes ao registro do departamento. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Recursos.meta.criados	Data e hora em que o registro do departamento associado foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora em que o registro do departamento associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do registro do departamento associado. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	tipo de recurso de SCIM; sempre Departamento. Tipo de dados: cadeia de caracteres
Resources.name	Nome do departamento. Tipo de dados: cadeia de caracteres
Recursos.esquemas
esquemas
startIndex	Índice baseado em um na tabela Departamento [cmn_department] na qual os registros foram retornados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL

Este exemplo mostra como recuperar os dois primeiros registros de departamento.

curl "https://instance-servicenow.com/api/now/scim/Departments?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":7,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
      ],
      "id":"221db0edc611228401760aec06c9d929",
      "meta":{
        "resourceType":"Department",
        "created":"2006-01-31T20:18:24Z",
        "lastModified":"2012-02-18T07:01:40Z",
        "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
      },
      "name":"Sales"
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
      ],
      "id":"221f3db5c6112284009f4becd3039cc9",
      "meta":{
        "resourceType":"Department",
        "created":"2008-03-20T20:20:06Z",
        "lastModified":"2012-02-18T07:01:22Z",
        "location":"https://instance-servicenow.com/api/now/scim/Departments/221f3db5c6112284009f4becd3039cc9"
      },
      "name":"Development"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM - GET /scim/Departamentos/{deparment_id}

Retorna o registro do departamento especificado da tabela Departamento [cmn_department] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Departments/{department_id}

URL padrão: /api/now/scim/Departments/{department_id}

Parâmetros de solicitação compatíveis

Tabela 145. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
id_departamento	Sys_id do registro do departamento a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 146. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 147. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 148. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 149. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 150. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
id	Sys_id do registro do departamento. Tipo de dados: cadeia de caracteres
meta	Informações pertencentes ao registro do departamento. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.criado	Data e hora em que o registro do departamento associado foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora em que o registro do departamento associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
meta.local	URI do registro do departamento associado. Tipo de dados: cadeia de caracteres
meta.resourceType	tipo de recurso de SCIM; sempre Departamento. Tipo de dados: cadeia de caracteres
nome	Nome do departamento. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como recuperar um registro de departamento específico.

curl "https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" \
--request GET \
--header "Accept:application/scim+json" \

Resposta:

{
  "schemas":[
    "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department"
  ],
  "id":"221db0edc611228401760aec06c9d929",
  "meta":{
    "resourceType":"Department",
    "created":"2006-01-31T20:18:24Z",
    "lastModified":"2012-02-18T07:01:40Z",
    "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929"
  },
  "name":"Sales"
}

SCIM - GET /scim/Locais

Retorna um ou mais registros de local da tabela Location [cmn_location] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Nota:

Uma consulta que não retorna nenhuma correspondência retorna sucesso (código de status HTTP 200) com totalResults definido como 0.

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Locations

URL padrão: /api/now/scim/Locations

Parâmetros de solicitação compatíveis

Tabela 151. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres

Tabela 152. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
contagem	Número de registros a serem retornados. Um valor negativo é interpretado como zero. Tipo de dados: número Máximo: 500 - Um valor maior que este resulta em um erro de solicitação incorreta. Padrão: 10
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados retornados. Os filtros de campo são expressos como<field_name><operator> <"value">. Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: O operador NOT não é compatível com este método. Por exemplo, para filtrar todos os locais cujo nome começa com "Ch", insira displayName SW "Ch". Para especificar mais de um filtro de campo, concatene os filtros usando o operando E. Por exemplo, para filtrar todos os locais cujo nome começa com "Ch" e foram modificados pela última vez antes de 3 de outubro de 2021, insira displayName SW "Ch" AND meta.lastModified lt "2021-10-03T00:00:00Z". Use a referência com pontos para especificar atributos aninhados. Tipo de dados: cadeia de caracteres Padrão: sem filtragem
Classificar por	Deve ser especificado com o parâmetro sortOrder. Campo pelo qual classificar os resultados retornados. A classificação não faz distinção entre maiúsculas e minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para o parâmetro sortBy, exceto que externalId não é permitido. Para valores que são nulos: classificado em ordem crescente - os valores nulos são classificados na parte superior. classificado por decrescente - os valores nulos são classificados na parte inferior. Tipo de dados: cadeia de caracteres Padrão: sem classificação
sortOrder	Deve ser especificado com o parâmetro sortBy. Ordem na qual o parâmetro sortBy é aplicado aos resultados retornados. Valores válidos: crescente decrescente Tipo de dados: cadeia de caracteres Padrão: crescente
startIndex	Índice baseado em um na tabela na qual iniciar a recuperação de registros. Por exemplo, se você definir este parâmetro como 100 e o parâmetro count como 20, o endpoint retornará os registros de 100 a 119. Nota: Qualquer valor definido como menor que um é interpretado como um. Tipo de dados: cadeia de caracteres Padrão: 1

Tabela 153. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 154. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 155. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 156. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
itensPorPágina	Número de registros retornados nos resultados de retorno. Tipo de dados: número
Recursos	Lista de registros de local retornados. Tipo de dados: objeto "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
Recursos.meta	Informações pertencentes ao registro do local. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Recursos.meta.criados	Data e hora em que o registro de local associado foi criado. Tipo de dados: cadeia de caracteres
Recursos.meta.últimaModificada	Data e hora em que o registro do local associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
Recursos.meta.local	URI do registro de local associado. Tipo de dados: cadeia de caracteres
Resources.meta.resourceType	tipo de recurso de SCIM; sempre Localização. Tipo de dados: cadeia de caracteres
Resources.name	Nome do local. Tipo de dados: cadeia de caracteres
Recursos.esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado para processar a resposta da lista à solicitação. Por exemplo: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Tipo de dados: cadeia de caracteres
startIndex	Índice baseado em um na tabela Location [cmn_location] na qual os registros foram retornados. Tipo de dados: cadeia de caracteres
totalResults	Número total de registros que correspondem à solicitação. Tipo de dados: número

Solicitação de cURL

Este exemplo mostra como recuperar os dois primeiros registros da empresa.

curl "https://instance-servicenow.com/api/now/scim/Locations?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":426,
  "Resources":[
    {
      "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
      "id":"0002c0a93790200044e0bfc8bcbe5df5",
      "meta":{
        "resourceType":"Location",
        "created":"2012-02-19T18:39:00Z",
        "lastModified":"2012-02-19T18:39:00Z",
        "location":"https://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5"
      },
      "name":"2-10-1 Yurakucho, Chiyoda-ku, Tokyo"
    },
    {
      "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
      "id":"0594ed7437d0200044e0bfc8bcbe5df0",
      "meta":{
        "resourceType":"Location",
        "created":"2012-02-17T17:54:15Z",
        "lastModified":"2021-08-31T14:13:11Z",
        "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0"
      },
      "name":"Colombia"
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM - GET /scim/Locations/{location_id}

Retorna o registro de local especificado da tabela Location [cmn_location] em uma instância ServiceNow usando o protocolo SCIM (System for Cross-domain Identity Management).

Formato de URL

URL com controle de versões: /api/now/{api_version}/scim/Locations/{location_id}

URL padrão: /api/now/scim/Locations/{location_id}

Parâmetros de solicitação compatíveis

Tabela 157. Parâmetros de caminho

Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
location_id	Sys_id do registro do local a ser retornado. Tipo de dados: cadeia de caracteres

Tabela 158. Parâmetros de consulta

Nome	Descrição
atributos	Lista separada por vírgulas de campos a serem retornados na resposta. Nenhum outro campo é retornado. Não pode ser usado com o parâmetro excludedAttributes. Tipo de dados: cadeia de caracteres Padrão: retorna todos os campos, a menos que excludedAttributes seja especificado.
Atributosexcluídos	Lista separada por vírgulas de campos a serem excluídos dos registros retornados na resposta. Todos os outros campos são retornados. Não pode ser usado com o parâmetro attributes. Tipo de dados: cadeia de caracteres Padrão: não excluir nenhum campo.

Tabela 159. Parâmetros do corpo da solicitação (JSON)

Nome	Descrição
Nenhum

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 160. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/scim+json. Padrão: application/json

Tabela 161. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum

Códigos de status

Os códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

Tabela 162. Códigos de status

Código de status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Certifique-se de que os parâmetros de consulta attributes e excludedAttributes não tenham sido aprovados na solicitação. Certifique-se de que o parâmetro count não seja maior que 500. Certifique-se de que todos os parâmetros filter sejam válidos.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
id	Sys_id do registro do local. Tipo de dados: cadeia de caracteres
meta	Informações pertencentes ao registro do local. Tipo de dados: objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
meta.criado	Data e hora em que o registro de local associado foi criado. Tipo de dados: cadeia de caracteres
meta.lastModified	Data e hora em que o registro do local associado foi modificado pela última vez. Tipo de dados: cadeia de caracteres
meta.local	URI do registro de local associado. Tipo de dados: cadeia de caracteres
meta.resourceType	tipo de recurso de SCIM; sempre Localização. Tipo de dados: cadeia de caracteres
nome	Nome do local. Tipo de dados: cadeia de caracteres
esquemas	Esquema usado ao processar a solicitação. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Este exemplo mostra como recuperar um registro de local específico.

curl "https://instance-servicenow.com/api/now/scim/Locations/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

Resposta

{
  "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"],
  "id":"0594ed7437d0200044e0bfc8bcbe5df0",
  "meta":{
    "resourceType":"Location",
    "created":"2012-02-17T17:54:15Z",
    "lastModified":"2021-08-31T14:13:11Z",
    "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0"
  },
  "name":"Colombia"
}