API do System for Cross-domain Identity Management (SCIM)

. Sistema para Gestão de identidade entre domínios (SCIM) A API 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 HTTP [ RFC7230 ] padrão. Use esta API para provisionar e gerenciar dados de identidade, como usuários e grupos, na Web e em ambientes entre domínios, como provedores de serviço 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 um existente ServiceNow tabela. As tabelas a seguir definem esses mapeamentos. Atributos que não correspondem aos campos em existentes ServiceNow As tabelas são mapeadas 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 do SCIM tem esquemas principais (schema: 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 do esquema de extensão e núcleo do usuário é mapeada para a tabela Usuário [sys_user].

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

Nome do atributo de SCIM	Nome do campo do usuário
ativo	ativo
addresses.country	país
addresses.default.country	país
addresses.home.country	país
addresses.localidade	cidade
addresses.default.locality	cidade
addresses.home.locality	cidade
Endereços.PostalCode	zip
addresses.default.postalCode	zip
Addresses.home.PostalCode	zip
addresses.region	estado
addresses.default.region	estado
addresses.home.region	estado
Addresses.streetAddress	rua
addresses.default.streetAddress	rua
Addresses.home.streetAddress	rua
displayName	nome
e-mails.valor	e-mail
emails.default.value	e-mail
valor.trabalho.e-mails	e-mail
id	sys_id
meta.criado	sys_created_on
meta.LastModificado	sys_updated_on
Nome.FamilyName	last_name
Nome.givenName	first_name
Name.honorificPrefix	introdução
name.middleName	middle_name
PhoneNumbers.value	telefone
PhoneNumbers.home.value	home_phone
PhoneNumbers.mobile.value	mobile_phone
PhoneNumbers.work.value	telefone
Idioma preferencial	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 Sys SCIM [sys_scim_user]

Nome do atributo de SCIM	Nome do campo Usuário do SCIM do sistema
externalId	external_id

O esquema estendido do usuário do SCIM (urn:ietf:params:scim:schemas:extension:serviceNow:2,0:User) é mapeado para a tabela Usuário [sys_user].

Tabela 3. Mapeamento de tabela de recurso estendido do usuário para Usuário [sys_user]

Nome do atributo de SCIM	Nome do campo do usuário
company.name	company.name
valor.empresa	sys_id.company
costCenter.name	cost_center.name
Costcenter.Valor	cost_center.sys_id
department.name	department.name
valor.departamento	department.sys_id
EmployeeNumber	employee_number
sexo	sexo
location.name	location.name
valor.local	sys_id.location
manager.displayName	manager.name
manager.value	manager.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. Mapeamento da tabela Recurso do grupo para Grupo [sys_user_group]

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

O parâmetro externalId do grupo de SCIM é mapeado para a tabela Grupo de SCIM do sistema [sys_scim_group].

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

Nome do atributo de SCIM	Nome do campo Grupo de SCIM do sistema
externalId	external_id

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

Tabela 6. Mapeamento da tabela Recurso do grupo para Grupo [sys_user_group]

Nome do atributo de SCIM	Nome do campo do grupo
valor.empresa	sys_id.company
company.name	company.name

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. Mapeamento da tabela Empresa [core_company]

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

O esquema de recursos do Centro de custos do SCIM (urn:ietf:params:scim:schemas:custom:serviceNow:2,0:Costcenter) é mapeado para a tabela Centro de custos [cmn_cost_center].

Tabela 8. Mapeamento da tabela Centro de custos para Centro de custos [cmn_cost_center]

Nome do atributo de SCIM	Nome do campo do Centro de custos
id	sys_id
meta.criado	sys_created_on
meta.LastModificado	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 do departamento para departamento [cmn_department]

Nome do atributo de SCIM	Nome do campo do departamento
id	sys_id
meta.criado	sys_created_on
meta.LastModificado	sys_updated_on
nome	nome

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

Tabela 10. Mapeamento da tabela de recurso de local para Local [cmn_location]

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

Tabelas específicas do SCIM

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

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

Nome do campo	Descrição
Criação em	Data e hora em que o registro associado foi criado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Criada por	Nome da entidade que criou o registro. Tipo de dados: Cadeia de caracteres Comprimento 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 Comprimento máximo: 255
SYS ID	Identificador exclusivo do registro em um ServiceNow instância. Tipo de dados: Cadeia de caracteres Comprimento máximo: 32
Atualização em	Data e hora em que o registro associado foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Atualização de	Nome da entidade que atualizou o registro associado pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Atualizações	Número de vezes que o registro foi atualizado. Tipo de dados: Número (inteiro) Comprimento máximo: 40
Usuário	Referência ao usuário associado a este registro Tabela de usuário [sys_user] Comprimento máximo: 32
Tipo de usuário	Tipo de registro de usuário. Este valor é usado para identificar o relacionamento entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Externo Estagiário Temporário Desconhecido Tipo de dados: Cadeia de caracteres Comprimento máximo: 40

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

Nome do campo	Descrição
Criação em	Data e hora em que o registro associado foi criado. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Criada por	Nome da entidade que criou o registro. Tipo de dados: Cadeia de caracteres Comprimento 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 Comprimento máximo: 255
Grupo	Referência ao grupo associado a este registro. Tabela Grupo [sys_user_group] Comprimento máximo: 32
SYS ID	Identificador exclusivo do registro em um ServiceNow instância. Tipo de dados: Cadeia de caracteres Comprimento máximo: 32
Atualização em	Data e hora em que o registro associado foi atualizado pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Atualização de	Nome da entidade que atualizou o registro associado pela última vez. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40
Atualizações	Número de vezes que o registro foi atualizado. Tipo de dados: Número (inteiro) Comprimento 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 Usuário de SCIM do sistema [sys_scim_user] e a tabela Grupo de SCIM do sistema [sys_scim_group] que permitem criar, excluir, ler e gravar. Essas ACLs são mapeadas somente para a função scim_admin.

SCIM - EXCLUA /scim/groups/

Exclui o registro de grupo especificado da tabela Grupo [sys_user_group] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/groups/(group_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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: Grupo [sys_user_group]

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 18. Códigos de status

Código do 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.status	Código de status HTTP para a resposta de erro. Tipo de dados: Cadeia de caracteres

Solicitação do 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 - OBTER /scim/groups

Retorna um ou mais registros de grupo da tabela Grupo [sys_user_group] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/groups

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador não é compatível com este método. Por exemplo, para filtrar todos os grupos cujo nome começa com "RH", insira Displayname SW "RH" . Para especificar mais de um filtro de campo, concatene os filtros usando E. operando. Por exemplo, para filtrar todos os grupos cujo nome começa com "RH" e foram modificados pela última vez antes de 3 de outubro de 2021, insira Displayname SW "RH" E meta.LastModified lt "2021-10-33T00:00:00Z" . Use a referência com pontos para especificar atributos aninhados. Somente os seguintes campos de grupo de SCIM estão disponíveis para uso em filtros: displayName ExternalId: Oferece suporte somente a EQ operador. id meta.criado meta.LastModificado Tipo de dados: Cadeia de caracteres Padrão: Sem filtragem
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtrar para sortByparâmetro, exceto esse externalIdnão é permitido. Para valores nulos: Classificado por crescente: Valores nulos são classificados para o topo. Classificado por decrescente: Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Sem classificação
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de um é interpretado como um. Tipo de dados: Cadeia de caracteres Padrão: 1

Tabela 21. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 24. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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
ItemPerPage	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] } ]
Resources.company	Detalhes sobre a empresa ou organização do grupo. Tipo de dados: Objeto "company": { "display": "String", "$ref": "String", "value": "String" }
Resources.company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
Resources.company.$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
Resources.company.value	Sys_id da empresa associada. Tipo de dados: Cadeia de caracteres
Resources.displayName	Nome legível do grupo, como Equipe de RH. Tipo de dados: Cadeia de caracteres
ExternalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. Tipo de dados: Cadeia de caracteres
Resources.id	Sys_id do grupo. Tipo de dados: Cadeia de caracteres
Resources.meta	Metadados pertencentes ao grupo. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.resources.criado	Data e hora em que o registro do grupo foi criado. Tipo de dados: Cadeia de caracteres
Metadados.LastModified	Data e hora em que o registro do grupo foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
Meta.location.resources.meta.location	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
Resources.members	Lista de usuários e grupos associados ao grupo. Tipo de dados: Matriz de objetos "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Resources.members.display	Nome do membro do grupo associado. Tipo de dados: Cadeia de caracteres
Resources.members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
Resources.members	URI do membro do grupo associado. Tipo de dados: Cadeia de caracteres
Resources.schemas	Lista de URIs dos esquemas do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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 do CURL para vários grupos

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

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 do CURL para vários grupos usando excludedAttributes

Este exemplo mostra como solicitar vários grupos (quatro, neste caso), usando counte 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 - OBTER /scim/groups/

Retorna o registro de grupo especificado da tabela Grupo [sys_user_group] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/groups/(group_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 27. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 29. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 30. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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.LastModificado	Data e hora em que o registro do grupo foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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" } ]
members.display	Nome do membro do grupo associado. Tipo de dados: Cadeia de caracteres
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
ref	URI do membro do grupo associado. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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/groups/

Permite adicionar, atualizar e excluir campos especificados em um registro de grupo na tabela Grupo [sys_user_group] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Para obter informações adicionais, consulte Modificando com PATCH RFC 7644.

Formato de URL

URL com controle de versão: /api/now//scim/groups/(group_id)

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

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Grupo [sys_user_group]

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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 33. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Operações	Obrigatório. Lista de objetos de operação para aplicar patch ao registro do grupo especificado. Tipo de dados: Matriz de objetos "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	Obrigatório. Operação a ser executada. Valores válidos: Adicionar: Adicione o campo e o valor especificados ao registro do grupo. Remover: Remove o valor do campo especificado. Substituído pelo tipo de dados "nulo". Substituir: Substitua o valor do campo especificado. Tipo de dados: Cadeia de caracteres
Operations.path	Necessário para remover operações, opcionais para outros. Nome/caminho do campo a ser modificado. . patho parâmetro 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 como um recurso.
Operations.Value	Valor do campo especificado em Operations.pathparâmetro. O formato desse 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 valueo campo é 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 um pathparâmetros, como: "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] A seguir, é mostrado como adicionar um membro ao grupo: { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } Se o campo que está sendo atualizado não estiver no esquema de base, você deverá incluir 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
Valor.tipo.Operações	Nome do campo a ser atualizado. Tipo de dados: Cadeia de caracteres
Valor.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/jsonou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/scim+json. Padrão: application/json

Tabela 35. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 36. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
204	Bem-sucedido. Nenhum conteúdo (aplicável somente à API de patch de grupo de SCIM) - Este status 204 depende do estado da propriedade de IU do SCIM, Habilitar resposta da API de patch de grupo sem conteúdo E estão sujeitos ao parâmetro de atributo passado de acordo com RFC: https://www.rfc-editor.org/rfc/rfc7644#page-35 . Valor da propriedade padrão: Falso . Habilitar resposta da API de patch de grupo sem conteúdo a propriedade 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Verificar se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. O sys_id de usuário ou grupo inválido foi fornecido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação ou a solicitação não excede o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	O grupo já existe. . displayNameo parâmetro 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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" } ]
members.display	Nome do membro do grupo associado. Tipo de dados: Cadeia de caracteres
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
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.LastModificado	Data e hora em que o registro do grupo foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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 do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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 - PUBLICAR /scim/groups

Cria um registro de grupo na tabela Grupo [sys_user_group] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

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ão: /api/now//scim/groups

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 39. Solicitar parâmetros do corpo (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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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 este tamanho máximo atualizando a propriedade do sistema com.snc.interation.scim2.max.member.count.
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
esquemas	Obrigatório. Lista de URIs dos esquemas do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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/jsonou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/scim+json. Padrão: application/json

Tabela 41. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 42. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Verificar se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. O sys_id de usuário ou grupo inválido foi fornecido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação ou a solicitação não excede o número máximo de membros.
409	O grupo já existe. . displayNameo parâmetro 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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.LastModificado	Data e hora em que o registro do grupo foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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" } ]
members.display	Nome do membro do grupo associado. Tipo de dados: Cadeia de caracteres
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
ref	URI do membro do grupo associado. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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 PUBLICAR um novo grupo e adicionar membro

Este exemplo cria o group51 e adiciona o usuário Abel Tutor como 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 - COLOQUE /scim/groups/

Atualiza o registro de grupo especificado na tabela Grupo [sys_user_group] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

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 do tipo de matriz, como members.

Formato de URL

URL com controle de versão: /api/now//scim/groups/(group_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Grupo [sys_user_group]

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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 45. Solicitar parâmetros do corpo (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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. Tipo de dados: Cadeia de caracteres
membros	Lista de usuários pela qual substituir a lista atual de membros. Tipo de dados: Matriz de objetos "members:" [ { "value": "String" } ] Tamanho máximo: 100 - Você pode modificar este tamanho máximo atualizando a propriedade do sistema com.snc.interation.scim2.max.member.count.
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
esquemas	Obrigatório. Lista de URIs dos esquemas do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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/jsonou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/scim+json. Padrão: application/json

Tabela 47. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 48. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Verificar se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. O sys_id de usuário ou grupo inválido foi fornecido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação ou a solicitação não excede o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	O grupo já existe. . displayNameo parâmetro 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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
valor.empresa	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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.status	Código de status HTTP para a resposta de erro. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo atribuído ao grupo pela entidade que o está provisionando. 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" } ]
members.display	Nome do membro do grupo associado. Tipo de dados: Cadeia de caracteres
members.value	Sys_id do registro de usuário ou grupo associado. Tipo de dados: Cadeia de caracteres
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.LastModificado	Data e hora em que o registro do grupo foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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 do 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 Sistema de força de trabalho de engenharia da Internet para Gestão de identidade entre domínios: Documento Esquema principal ( 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 uma 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

Atualização de membros do grupo do CURL usando PUT

O exemplo a seguir muda o membro associado ao grupo para Abraham Lincoln 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 - EXCLUA /scim/users/(user_id)

Exclui o registro de usuário especificado da tabela Usuário [sys_user] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/users/(user_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]

Tabela 50. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 51. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 53. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 54. Códigos de status

Código do 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.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 - OBTER /scim/users

Retorna um ou mais registros de usuário da tabela Usuário [sys_user] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/users

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador não é compatível. Por exemplo, para filtrar todos os usuários cujo nome começa com "Jo", insira SW de nome de usuário "jo" (não diferencia maiúsculas de minúsculas). Para especificar mais de um filtro de campo, concatene os filtros usando E. operando. Por exemplo, para filtrar todos os usuários cujo nome começa com "Jo" e cujo sobrenome contém "smi", insira SW de nome de usuário "john" E 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, conforme observado, são compatíveis somente com o formato fixo: ativo Formatos - Somente formato fixo, como: [Type eq "home" e streeAddress eq "xxxx"] [type eq "home" e localidade eq "xxxx"] [type eq "home" e eq da região "xxxx"] [Type eq "home" e PostalCode eq "xxxx"] [digite eq "casa" e país eq "xxxx"] displayName E-mails - Somente formato fixo, como: [Type eq "work" e value eq "emailValue"] ExternalId - Somente EQ o operador é compatível. id meta.criado meta.LastModificado Nome.FamilyName Nome.givenName name.middleName Idioma preferencial PhoneNumbers - Somente formato fixo, como: [type eq "work" e value eq "xxxx"] [type eq "mobile" e value eq "xxxx"] [type eq "home" e 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
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtragem para sortByparâmetro, com exceção de externalId, o que não é permitido. Somente os seguintes parâmetros com referência com pontos são compatíveis: addressess - Somente os seguintes valores são permitidos: addresses.streetAddress - Mapas para endereço residencial. addresses.home.streetAddress addresses.locality - Mapas para a localidade de origem. addresses.home.locality addresses.region - Mapas para a região de origem. addresses.home.region addresses.postalCode - Mapas para 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 - Mapeia para o tipo de e-mail Trabalho. emails.work.value phoneNumbers - Somente os seguintes valores são permitidos: phoneNumbers.value - Mapas para o tipo de número de telefone Work. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Para valores nulos: Classificado por crescente - Os valores nulos são classificados para o topo. Classificado por decrescente - Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Nenhuma classificação realizada
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de um é interpretado como um. Não é válido com idparâmetro de caminho. Tipo de dados: Cadeia de caracteres Padrão: 1

Tabela 57. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 59. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 60. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são válidos.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ItemPerPage	Número de registros retornados nos resultados de retorno. Tipo de dados: Número
Recursos	Lista de registros de 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" } ]
Resources.active	Sinalizador que indica se o usuário associado está ativo em ServiceNow instância. 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
Resources.addresses.Localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.Recursos.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
Resources.addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Resources.addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
Resources.addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
Resources.displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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" } ]
E-mails.resources.email.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte ao tipo de "trabalho". Tipo de dados: Cadeia de caracteres
E-mails.Resources.Value	Endereço de e-mail do usuário. Esta é uma chave exclusiva para o usuário associado. Tipo de dados: Cadeia de caracteres
ExternalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. Tipo de dados: Cadeia de caracteres
Resources.groups	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" } ]
Resources.groups.display	Nome do grupo associado. Tipo de dados: Cadeia de caracteres
Resources.groups.type	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: Cadeia de caracteres
Resources.groups.value	Sys_id de um registro de grupo associado. Tipo de dados: Cadeia de caracteres
Resources.groups.ref	URI do grupo associado. Tipo de dados: Cadeia de caracteres
Resources.id	Sys_id do registro de usuário associado. Tipo de dados: Cadeia de caracteres
Resources.meta	Metadados pertencentes ao usuário. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.resources.criado	Data e hora em que o registro do usuário foi criado. Tipo de dados: Cadeia de caracteres
Metadados.LastModified	Data e hora em que o registro do usuário foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
Meta.location.resources.meta.location	URI do usuário que está sendo recuperado. Tipo de dados: Cadeia de caracteres
Resources.meta.resourceType	Tipo de recurso dos usuários do 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 família do usuário. Tipo de dados: Cadeia de caracteres
Resources.name.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Resources.name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
Resources.name.middle	Nome do meio do usuário. Tipo de dados: Cadeia de caracteres
Resources.phoneNumbers	Lista de números de telefone associados ao usuário. Tipo de dados: Matriz de objetos "phoneNumbers": [ { "type": "String", "value": "String" } ]
Resources.phoneNumbers.type	Tipo de número de telefone. Valores possíveis: página inicial móvel trabalho Tipo de dados: Cadeia de caracteres
Resources.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
Resources.schemas	Lista de URIs dos esquemas de usuário do SCIM usados para processar a solicitação. Tipo de dados: Matriz de cadeias de caracteres
Resources.timezone	Fuso horário do usuário. Tipo de dados: Cadeia de caracteres
Resources.title	Cargo do usuário, como CEO ou Presidente. Tipo de dados: Cadeia de caracteres
Resources.userName	Nome de usuário exclusivo para o usuário associado. Tipo de dados: Cadeia de caracteres
Resources.userType	Tipo de usuário. Este valor é usado para identificar o relacionamento entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
valor.empresa	Sys_id do registro da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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" }
Costcenter.display	Nome do centro de custos. Tipo de dados: Cadeia de caracteres
Costcenter.Valor	Sys_id do registro do centro de custos. Tipo de dados: Cadeia de caracteres
Referência de custos	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" }
department.display	Nome do departamento. Tipo de dados: Cadeia de caracteres
valor.departamento	Sys_id do registro do departamento. Tipo de dados: Cadeia de caracteres
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
sexo	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" }
local.exibição	Nome do local. Tipo de dados: Cadeia de caracteres
valor.local	Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
referência	URI de referência para o 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" }
manager.display	Nome do gerente. Tipo de dados: Cadeia de caracteres
manager.value	Sys_id do registro do gerente. Tipo de dados: Cadeia de caracteres
ref	URI de referência para o gerente. Tipo de dados: Cadeia de caracteres

Solicitação de 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. filterparâmetro 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 - OBTER /scim/users/

Retorna o registro de usuário especificado da tabela Usuário [sys_user] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/users/(user_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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: Usuário [sys_user]

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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 63. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 65. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 66. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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 em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" } ]
groups.display	Nome do grupo associado. Tipo de dados: Cadeia de caracteres
groups.type	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: Cadeia de caracteres
groups.value	Sys_id de um registro de grupo associado. Tipo de dados: Cadeia de caracteres
referência	URI do grupo associado. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de 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.LastModificado	Data e hora em que o registro do usuário foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do usuário que está sendo recuperado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso dos usuários do 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	Idioma falado e escrito preferencial do usuário. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas de usuário do 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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
valor.empresa	Sys_id do registro da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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" }
Costcenter.display	Nome do centro de custos. Tipo de dados: Cadeia de caracteres
Costcenter.Valor	Sys_id do registro do centro de custos. Tipo de dados: Cadeia de caracteres
Referência de custos	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" }
department.display	Nome do departamento. Tipo de dados: Cadeia de caracteres
valor.departamento	Sys_id do registro do departamento. Tipo de dados: Cadeia de caracteres
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
sexo	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" }
local.exibição	Nome do local. Tipo de dados: Cadeia de caracteres
valor.local	Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
referência	URI de referência para o 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" }
manager.display	Nome do gerente. Tipo de dados: Cadeia de caracteres
manager.value	Sys_id do registro do gerente. Tipo de dados: Cadeia de caracteres
ref	URI de referência para o gerente. Tipo de dados: Cadeia de caracteres

Solicitação de curl usando o sys_id do usuário

O exemplo a seguir mostra como obter um registro de usuário específico passando o 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/users/

Permite adicionar, substituir e remover campos especificados em um registro de usuário na tabela Usuário [sys_user] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/users/(user_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]

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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 69. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Operações	Obrigatório. Lista de objetos de operação para corrigir o registro de usuário especificado. Tipo de dados: Matriz "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	Obrigatório. Operação a ser executada. Valores válidos: Adicionar: Adicione o campo e o valor especificados ao registro do usuário. Remover: Remove o valor do campo especificado. Substituir: Substitua o valor do campo especificado. Tipo de dados: Cadeia de caracteres
Operations.path	Necessário para remover operações. Nome/caminho do campo a ser modificado. . patho parâmetro pode ter um dos seguintes formatos: Um campo direto, como título Campos aninhados, como Nome.givenName Em caso de matriz complexa, ele 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 como um recurso do usuário.
Operations.Value	Valor do campo especificado em Operations.pathparâmetro. O formato desse 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 valueo campo é 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 valueou pathparâmetros, 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 para adicionar ao registro do usuário e seus valores associados, o. valueo campo é 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 em Operations.path: { "op": "replace", "path": "name.givenName", "value": "Jennifer" } Se o campo que está sendo atualizado não estiver no esquema de base, você deverá incluir 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
Valor.tipo.Operações	Nome do campo a ser atualizado. Tipo de dados: Cadeia de caracteres
Valor.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 70. Cabeçalhos da solicitação

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

Tabela 71. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 72. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Verificar se há valores inválidos: Corpo da solicitação malformado. O campo obrigatório não foi fornecido ou está vazio. O sys_id de usuário ou grupo inválido foi fornecido. Verifique se um campo somente leitura ou imutável está tentando ser modificado. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação ou a solicitação não excede o número máximo de membros.
404	Não encontrado. O item solicitado não foi encontrado.
409	Usuário já existente. . userNameo parâmetro 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 em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.status	Código de status HTTP para a resposta de erro. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" } ]
groups.display	Nome do grupo associado. Tipo de dados: Cadeia de caracteres
groups.type	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: Cadeia de caracteres
groups.value	Sys_id de um registro de grupo associado. Tipo de dados: Cadeia de caracteres
referência	URI do grupo associado. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de 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.LastModificado	Data e hora em que o registro do usuário foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do usuário que está sendo recuperado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso dos usuários do 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	Idioma falado e escrito preferencial do usuário. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas de usuário do 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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
valor.empresa	Sys_id do registro da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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" }
Costcenter.display	Nome do centro de custos. Tipo de dados: Cadeia de caracteres
Costcenter.Valor	Sys_id do registro do centro de custos. Tipo de dados: Cadeia de caracteres
Referência de custos	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" }
department.display	Nome do departamento. Tipo de dados: Cadeia de caracteres
valor.departamento	Sys_id do registro do departamento. Tipo de dados: Cadeia de caracteres
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
sexo	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" }
local.exibição	Nome do local. Tipo de dados: Cadeia de caracteres
valor.local	Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
referência	URI de referência para o 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" }
manager.display	Nome do gerente. Tipo de dados: Cadeia de caracteres
manager.value	Sys_id do registro do gerente. Tipo de dados: Cadeia de caracteres
ref	URI de referência para o 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 - PUBLICAR /scim/users

Cria um registro de usuário na tabela Usuário [sys_user] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

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ão: /api/now//scim/users

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 75. Solicitar parâmetros do corpo (XML ou JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
valor.empresa	Necessário se a empresa estiver incluída no POST. 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" }
Costcenter.Valor	Necessário se o Centro de custos estiver incluído no POST. 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" }
valor.departamento	Necessário se o departamento estiver incluído no POST. 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
sexo	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" }
valor.local	Necessário se o local estiver incluído no POST. Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: Objeto "manager": { "value": "String" }
manager.value	Necessário se o gerente estiver incluído no POST. 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/jsonou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/scim+json. Padrão: application/json

Tabela 77. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 78. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
409	Usuário já existente. . userNameo parâmetro 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 em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.status	Código de status HTTP para a resposta de erro. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" } ]
groups.display	Nome do grupo associado. Tipo de dados: Cadeia de caracteres
groups.type	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: Cadeia de caracteres
groups.value	Sys_id de um registro de grupo associado. Tipo de dados: Cadeia de caracteres
referência	URI do grupo associado. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de 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.LastModificado	Data e hora em que o registro do usuário foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do usuário que está sendo recuperado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso dos usuários do 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	Idioma falado e escrito preferencial do usuário. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas de usuário do 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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário Externo Desconhecido Tipo de dados: Cadeia de caracteres

Solicitação de curl para PUBLICAR usuário

Este exemplo mostra como PUBLICAR o usuário Jack Sparrow na 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 - COLOQUE /scim/users/

Atualiza o registro de usuário especificado na tabela Usuário [sys_user] de um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/users/(user_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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. Tipo de dados: Cadeia de caracteres Tabela: Usuário [sys_user]

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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 81. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
ativo	Sinalizador que indica se o usuário associado está ativo em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
valor.empresa	Necessário se a empresa estiver incluída no POST. 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" }
Costcenter.Valor	Necessário se o Centro de custos estiver incluído no POST. 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" }
valor.departamento	Necessário se o departamento estiver incluído no POST. 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
sexo	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" }
valor.local	Necessário se o local estiver incluído no POST. Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
gerente	Detalhes sobre o gerente associado do usuário. Tipo de dados: Objeto "manager": { "value": "String" }
manager.value	Necessário se o gerente estiver incluído no POST. 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/jsonou application/scim+json. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/scim+json. Padrão: application/json

Tabela 83. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 84. Códigos de status

Código do 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	Usuário já existente. . userNameo parâmetro 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 em ServiceNow instância. 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" }
addresses.country	Nome do país. Tipo de dados: Cadeia de caracteres
addresses.localidade	Nome da cidade ou localidade. Tipo de dados: Cadeia de caracteres
Endereços.PostalCode	CEP ou CEP. Tipo de dados: Cadeia de caracteres
addresses.region	Estado ou região. Tipo de dados: Cadeia de caracteres
Addresses.streetAddress	Endereço completo. Isso pode incluir o número da casa, o nome da rua, a caixa postal e as informações de endereço estendido de várias linhas. Tipo de dados: Cadeia de caracteres
addresses.type	Tipo de endereço. Atualmente, oferece suporte somente a página inicial . Tipo de dados: Cadeia de caracteres
displayName	Nome de exibição do usuário. Este valor é gerado automaticamente concatenando o. namecampos. 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.type	Tipo de e-mail do usuário. Atualmente, só oferece suporte 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" }
errors.detail	Mensagem de erro detalhada sobre o motivo da falha na solicitação. Tipo de dados: Cadeia de caracteres
ScmType.scmType	Palavra-chave de detalhe do erro de SCIM. Tipo de dados: Cadeia de caracteres
errors.schemas	URI dos esquemas de SCIM usados para processar a resposta de erro. Tipo de dados: Matriz de cadeias de caracteres
errors.status	Código de status HTTP para a resposta de erro. Tipo de dados: Cadeia de caracteres
externalId	Identificador exclusivo atribuído ao usuário pela entidade que o provisionou. 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" } ]
groups.display	Nome do grupo associado. Tipo de dados: Cadeia de caracteres
groups.type	Tipo de associação de grupo, como direta ou indireta. Tipo de dados: Cadeia de caracteres
groups.value	Sys_id de um registro de grupo associado. Tipo de dados: Cadeia de caracteres
referência	URI do grupo associado. Tipo de dados: Cadeia de caracteres
id	Sys_id do registro de 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.LastModificado	Data e hora em que o registro do usuário foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do usuário que está sendo recuperado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso dos usuários do 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" }
Nome.FamilyName	Sobrenome ou família do usuário. Tipo de dados: Cadeia de caracteres
Nome.givenName	Nome ou nome do usuário. Tipo de dados: Cadeia de caracteres
Name.honorificPrefix	Nome ou título honorífico do usuário, como Dr., Bispo ou Barão. Tipo de dados: Cadeia de caracteres
name.middle	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
Idioma preferencial	Idioma falado e escrito preferencial do usuário. Tipo de dados: Cadeia de caracteres
esquemas	Lista de URIs dos esquemas de usuário do 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 CEO ou Presidente. 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 entre a organização e o usuário. Qualquer valor, mas os valores típicos podem incluir: Prestador de serviço Funcionário Estagiário Temporário 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" }
company.display	Nome da empresa. Tipo de dados: Cadeia de caracteres
valor.empresa	Sys_id do registro da empresa. Tipo de dados: Cadeia de caracteres
referência da empresa	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" }
Costcenter.display	Nome do centro de custos. Tipo de dados: Cadeia de caracteres
Costcenter.Valor	Sys_id do registro do centro de custos. Tipo de dados: Cadeia de caracteres
Referência de custos	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" }
department.display	Nome do departamento. Tipo de dados: Cadeia de caracteres
valor.departamento	Sys_id do registro do departamento. Tipo de dados: Cadeia de caracteres
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
sexo	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" }
local.exibição	Nome do local. Tipo de dados: Cadeia de caracteres
valor.local	Sys_id do registro de local. Tipo de dados: Cadeia de caracteres
referência	URI de referência para o 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" }
manager.display	Nome do gerente. Tipo de dados: Cadeia de caracteres
manager.value	Sys_id do registro do gerente. Tipo de dados: Cadeia de caracteres
ref	URI de referência para o gerente. Tipo de dados: Cadeia de caracteres

Solicitação do curl para atualizar as 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 - OBTER /scim/ResourceTypes

Recupera informações sobre todos os tipos de recursos do System for Cross-domain Identity Management (SCIM) compatíveis com o associado ServiceNow instância.

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

Formato de URL

URL com controle de versão: /api/now//scim/ResourceTypes

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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(a)

Tabela 87. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 89. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 90. Códigos de status

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

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
ItemPerPage	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] } ]
Resources.description	Breve descrição do tipo de recurso. Tipo de dados: Cadeia de caracteres
Endpoint.resources	Nome do endpoint endereçável HTTP relativo ao URL de 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/ Tipo de dados: Cadeia de caracteres
Resources.meta	Informações que descrevem melhor o recurso associado. Tipo de dados: Objeto "metadata": { "location": "String", "resourceType": "String" }
Meta.location.resources.meta.location	URI do tipo de recurso associado no associado ServiceNow instância. 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
Resources.schema	URI de 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
Resources.schemas	Esquema usado para processar o. /ResourceType solicitação. Por exemplo: "Urn:ietf:params:scim:schemas:core:2,0:ResourceType" . Tipo de dados: Cadeia de caracteres
Resources.schemaExtensions	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" }
Resources.schemaExtensions.Obrigató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ário nesta extensão de esquema. Falso: Um recurso deste tipo pode omitir esta extensão de esquema. Tipo de dados: Booliano
Resources.schemaExtensions.schema	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 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 recurso SCIM compatíveis com um ServiceNow instância.

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 - OBTER /scim/ResourceTypes/

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

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

Formato de URL

URL com controle de versão: /api/now//scim/ResourceTypes/

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 Local Usuário Tipo de dados: Cadeia de caracteres

Tabela 92. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 93. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 95. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 96. Códigos de status

Código do 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
descrição	Breve descrição do tipo de recurso. Tipo de dados: Cadeia de caracteres
endpoint	Nome do endpoint endereçável HTTP relativo ao URL de 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/ 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.location	URI do tipo de recurso associado no associado ServiceNow instância. 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 de 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 o. /ResourceType solicitação. Por exemplo: "Urn:ietf:params:scim:schemas:core:2,0:ResourceType" . Tipo de dados: Cadeia de caracteres
Extensões de esquema	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.Obrigató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ário nesta extensão de esquema. Falso: Um recurso deste tipo pode omitir esta extensão de esquema. Tipo de dados: Booliano
SchemaExtensions.schema	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 um ServiceNow instância.

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 - OBTER /scim/esquemas

Recupera informações sobre todos os esquemas de recursos do System for Cross-domain Identity Management (SCIM) compatíveis com um ServiceNow instância. 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ão: /api/now//scim/Schemas

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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(a)

Tabela 99. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 101. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 102. Códigos de status

Código do 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 um ServiceNow instância.

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 - OBTER /scim/Schemas/

Recupera informações sobre os esquemas de recursos do System for Cross-domain Identity Management (SCIM) especificados compatíveis com um ServiceNow instância. 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ão: /api/now//scim/Schemas/

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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
Nome do esquema	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:Empresa 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(a)

Tabela 105. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 107. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 108. Códigos de status

Código do 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 de SCIM do grupo principal de um ServiceNow instância.

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 - OBTER /scim/ServiceProviderConfig

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

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

Formato de URL

URL com controle de versão: /api/now//scim/ServiceProviderConfig

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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(a)

Tabela 111. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 113. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 114. Códigos de status

Código do 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 um ServiceNow instância.

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 - OBTER /scim/companies

Retorna um ou mais registros da empresa da tabela Empresa [core_company] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/companies

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador 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 E. operando. 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" E 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
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtrar para sortByparâmetro, exceto esse externalIdnão é permitido. Para valores nulos: Classificado por crescente: Valores nulos são classificados para o topo. Classificado por decrescente: Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Sem classificação
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de um é interpretado como um. Tipo de dados: Cadeia de caracteres Padrão: 1

Tabela 117. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 119. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 120. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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
ItemPerPage	Número de registros retornados nos resultados de retorno. Tipo de dados: Número
Recursos	Lista de registros do 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
Resources.meta	Informações pertencentes ao registro da empresa. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.resources.criado	Data e hora em que o registro da empresa associada foi criado. Tipo de dados: Cadeia de caracteres
Metadados.LastModified	Data e hora em que o registro da empresa associada foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
Meta.location.resources.meta.location	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
Resources.schemas	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 - OBTER /scim/companies/

Retorna o registro da empresa especificado da tabela Empresa [core_company] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/companies/(company_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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
company_id	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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 123. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 125. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 126. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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.LastModificado	Data e hora em que o registro da empresa associada foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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 específico da empresa.

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 - OBTER /scim/CostCenters

Retorna um ou mais registros de centro de custos da tabela Centro de custos [cmn_cost_center] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/CostCenters

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador não é compatível com este método. Por exemplo, para filtrar todos os centros de custos cujo nome comece com "RH", insira Displayname SW "RH" . Para especificar mais de um filtro de campo, concatene os filtros usando E. operando. 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 "RH" E 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
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtrar para sortByparâmetro, exceto esse externalIdnão é permitido. Para valores nulos: Classificado por crescente: Valores nulos são classificados para o topo. Classificado por decrescente: Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Sem classificação
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de 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(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 131. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 132. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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
ItemPerPage	Número de registros retornados nos resultados de retorno. Tipo de dados: Número
Recursos	Lista de registros do 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
Resources.meta	Informações pertencentes ao registro do centro de custos. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.resources.criado	Data e hora em que o registro do centro de custos associado foi criado. Tipo de dados: Cadeia de caracteres
Metadados.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.location.resources.meta.location	URI do registro do centro de custos associado. Tipo de dados: Cadeia de caracteres
Resources.meta.resourceType	Tipo de recurso de SCIM; Sempre Centro de custos. Tipo de dados: Cadeia de caracteres
Resources.name	Nome do centro de custos. Tipo de dados: Cadeia de caracteres
Resources.schemas	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 do 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 - OBTER /scim/CostCenters/

Retorna o registro do centro de custos especificado da tabela Centro de custos [cmn_cost_center] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/CostCenters/

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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
cost_center_id	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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 135. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 137. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 138. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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.LastModificado	Data e hora em que o registro do centro de custos associado foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do registro do centro de custos associado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso de SCIM; Sempre Centro de custos. 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 - OBTER /scim/departments

Retorna um ou mais registros de departamento da tabela Departamento [cmn_department] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/departments

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador não é compatível com este método. Por exemplo, para filtrar todos os departamentos cujo nome começa com "Engenheiro", insira Displayname SW "Engenheiro" . Para especificar mais de um filtro de campo, concatene os filtros usando E. operando. 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 "Engenheiro" E 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
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtrar para sortByparâmetro, exceto esse externalIdnão é permitido. Para valores nulos: Classificado por crescente: Valores nulos são classificados para o topo. Classificado por decrescente: Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Sem classificação
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de um é interpretado como um. Tipo de dados: Cadeia de caracteres Padrão: 1

Tabela 141. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 143. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 144. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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
ItemPerPage	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
Resources.meta	Informações pertencentes ao registro do departamento. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.resources.criado	Data e hora em que o registro do departamento associado foi criado. Tipo de dados: Cadeia de caracteres
Metadados.LastModified	Data e hora em que o registro do departamento associado foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
Meta.location.resources.meta.location	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
Resources.schemas
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 - OBTER /scim/departments/

Retorna o registro de departamento especificado da tabela Departamento [cmn_department] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/departments/(department_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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
department_id	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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 147. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 149. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 150. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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.LastModificado	Data e hora em que o registro do departamento associado foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	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 - OBTER /scim/locations

Retorna um ou mais registros de local da tabela Local [cmn_location] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Nota:

Uma consulta que não retorna correspondências retorna sucesso (código de status HTTP 200) com totalResultsdefinido como 0.

Formato de URL

URL com controle de versão: /api/now//scim/locations

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
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
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.
filtros	Expressão de filtro a ser aplicada aos resultados de retorno. Os filtros de campo são expressos como "valor"> de <field_name> <operator> . Consulte RFC7644 para obter uma lista dos operadores válidos. Nota: . NÃO o operador 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 E. operando. 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" E 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
sortBy	Deve ser especificado com sortOrderparâmetro. Campo pelo qual classificar os resultados retornados. A classificação não diferencia maiúsculas de minúsculas. Você só pode usar os parâmetros disponíveis para filtrar para sortByparâmetro, exceto esse externalIdnão é permitido. Para valores nulos: Classificado por crescente: Valores nulos são classificados para o topo. Classificado por decrescente: Os valores nulos são classificados para a parte inferior. Tipo de dados: Cadeia de caracteres Padrão: Sem classificação
sortOrder	Deve ser especificado com sortByparâmetro. Ordem na qual sortByo parâmetro é aplicado aos resultados de retorno. 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 countparâmetro para 20, o endpoint retorna registros de 100 a 119. Nota: Qualquer valor definido como menos de um é interpretado como um. Tipo de dados: Cadeia de caracteres Padrão: 1

Tabela 153. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 155. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 156. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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
ItemPerPage	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 de local. Tipo de dados: Cadeia de caracteres
Resources.meta	Informações pertencentes ao registro de local. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Meta.resources.criado	Data e hora em que o registro do local associado foi criado. Tipo de dados: Cadeia de caracteres
Metadados.LastModified	Data e hora em que o registro do local associado foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
Meta.location.resources.meta.location	URI do registro de local associado. Tipo de dados: Cadeia de caracteres
Resources.meta.resourceType	Tipo de recurso de SCIM; sempre Local. Tipo de dados: Cadeia de caracteres
Resources.name	Nome do local. Tipo de dados: Cadeia de caracteres
Resources.schemas	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 Local [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 um dos 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 - OBTER /scim/locations/

Retorna o registro de local especificado da tabela Local [cmn_location] em um ServiceNow Instância que usa o protocolo Sistema para Gestão de identidade entre domínios (SCIM).

Formato de URL

URL com controle de versão: /api/now//scim/locations/(location_id)

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

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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 acessado. 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 de 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 excludedAttributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Retorna todos os campos, a menos que excludedAttributesespecificado.
ExcluirdedAtributos	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 attributesparâmetro. Tipo de dados: Cadeia de caracteres Padrão: Não exclua nenhum campo.

Tabela 159. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

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/jsonou application/scim+json. Padrão: application/json

Tabela 161. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

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

Tabela 162. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. Certifique-se de que ambos attributese. excludedAttributesos parâmetros de consulta não foram passados na solicitação. Certifique-se de que counto parâmetro não é maior que 500. Certifique-se de que todos filteros parâmetros são 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 de local. Tipo de dados: Cadeia de caracteres
meta	Informações pertencentes ao registro de local. Tipo de dados: Objeto "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
meta.criado	Data e hora em que o registro do local associado foi criado. Tipo de dados: Cadeia de caracteres
meta.LastModificado	Data e hora em que o registro do local associado foi modificado pela última vez. Tipo de dados: Cadeia de caracteres
meta.location	URI do registro de local associado. Tipo de dados: Cadeia de caracteres
meta.resourceType	Tipo de recurso de SCIM; sempre Local. 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"
}