Parâmetros de solicitação da API do OAuth

Saiba mais sobre os parâmetros de solicitação da API do OAuth que acessam as solicitações de token.

Nota:

O tipo de conteúdo da API do OAuth deve ser aplicação/x-www-form-urlencoded. Um tipo de conteúdo de aplicação/json resulta em um erro não especificado.

Tabela 1. Parâmetros de solicitação de token de acesso

Parâmetro da solicitação	Descrição
grant_type	[Obrigatório] O tipo de credenciais que autorizam a solicitação de um token de acesso. Este parâmetro deve ter um dos seguintes valores: password: um conjunto de credenciais do usuário para autorizar a solicitação de token de acesso. Especifique as credenciais do usuário nos parâmetros de nome de usuário e senha. refresh_token: um token de atualização existente autoriza a solicitação de token de acesso. Especifique o token de atualização no parâmetro refresh_token.
client_id	[Obrigatório] ID exclusivo gerado automaticamente da aplicação cliente que solicita o token de acesso.
client_secret	[Obrigatório] A cadeia de caracteres do segredo compartilhado que a instância e a aplicação OAuth usam para autorizar as comunicações entre si.
username	Nome da conta do usuário que autoriza a solicitação de token de acesso. Este parâmetro é obrigatório para solicitações de token de acesso com um grant_type de password.
password	Senha para a conta de usuário que autoriza a solicitação de token de acesso. Este parâmetro é obrigatório para solicitações de token de acesso com um grant_type de password.
refresh_token	Token de atualização existente que autoriza a solicitação de token de acesso. Este parâmetro é obrigatório para solicitações de token de acesso com um grant_type de refresh_token.

Solicitações usando credenciais de usuário

A instância exige que os clientes forneçam credenciais de login do usuário ao autorizar o cliente pela primeira vez ou ao autorizar a criação de um novo token de atualização. Este tipo de solicitação sempre retorna dois tokens:

• Um token de acesso
• Um token de atualização

A instância verifica se o usuário está ativo, não está bloqueado no momento e tem uma sessão interativa. Se alguma dessas condições for falsa, a instância não produzirá um token de acesso. As solicitações de acesso feitas dentro do tempo de expiração do token de acesso sempre retornam o token de acesso atual.

Nota:

Este tipo de concessão de autorização depende da criptografia TLS para proteger as credenciais do usuário durante a transmissão.

O exemplo a seguir ilustra a solicitação de um token de acesso com um conjunto de credenciais do usuário (espaços foram adicionados para melhorar a leitura).

$ curl -d"grant_type=password&client_id=be3aeb583ace210011c15b24a43e25d8
&client_secret=client_password
&username=admin&password=admin" 
https://instancename.service-now.com/oauth_token.do

Solicitações usando um token de atualização

A instância pode usar um token de atualização existente para criar um novo token de acesso. Este tipo de solicitação retorna apenas um token de acesso. A instância confirma que o token de atualização não expirou antes de gerar um novo token de acesso. As solicitações de acesso feitas dentro do tempo de expiração do token de atualização sempre retornam o token de atualização atual. Transmitir tokens de atualização geralmente é mais seguro do que transmitir credenciais de usuário. O exemplo a seguir ilustra a solicitação de um token de acesso com um token de atualização existente (espaços foram adicionados para melhorar a leitura).

$ curl -d"grant_type=refresh_token&client_id=be3aeb583ace210011c15b24a43e25d8
&client_secret=client_password
&refresh_token=w599voG89897rGVDmdp12WA681r9E5948c1CJTPi8g4HGc4NWaz62k6k1K0FMxHW40H8yOO3Hoe" 
https://instancename.service-now.com/oauth_token.do