Parâmetros de resposta da API do OAuth

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 1 min. de leitura
  • A API do OAuth 2.0 produz uma resposta JSON contendo os seguintes parâmetros como nome: pares de valor.

    Tabela 1. Parâmetros de resposta do token de acesso
    Parâmetro de resposta Descrição
    escopo Quantidade de acessos concedido pelo token de acesso. O escopo é sempre useraccount, o que significa que o token de acesso tem os mesmos direitos que a conta do usuário que autorizou o token. Por exemplo, se Abel Tuter autorizar uma aplicação fornecendo credenciais de login, o token de acesso resultante concederá ao portador do token os mesmos privilégios de acesso que Abel Tuter.
    token_type Tipo de token emitido pela solicitação, conforme definido no OAuth RFC. O tipo de token é sempre Portador, o que significa que qualquer pessoa que tenha o token de acesso pode acessar um recurso protegido sem fornecer uma chave criptográfica. Consulte RFC6750 para obter mais informações sobre como o OAuth 2.0 usa tokens de portador.
    expires_in Tempo de vida do token de acesso em segundos.
    refresh_token Valor da cadeia de caracteres do token de atualização.
    access_token Valor da cadeia de caracteres do 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.
    formato [Opcional] Formato de saída da resposta. Este valor é sempre JSON.
    Nota:
    Se algum provedor OAuth enviar o corpo da resposta como "tipo de conteúdo" em vez de "Tipo de Conteúdo", o cliente HTTP OAuth poderá não analisar a resposta corretamente. Para corrigir esse problema, crie uma propriedade do sistema usando esses parâmetros.
    Campo Valor
    Nome glide.oauth.inhouse.httpclient.enabled
    Tipo verdadeiro|falso
    Valor falso

    Para obter detalhes sobre como criar propriedades do sistema, consulte Adicionar uma propriedade do sistema.

    O exemplo a seguir ilustra a cadeia de caracteres JSON retornada por uma solicitação de token de acesso. (Espaços foram adicionados para melhorar a leitura.)

    
    {"scope":"useraccount","token_type":"Bearer","expires_in":1800,
    "refresh_token":"w599voG89897rGVDmdp12WA681r9E5948c1CJTPi8g4HGc4NWaz62k6k1K0FMxHW40H8yOO3Hoe",
    "access_token":"F0jh9korTyzd9kaZqZ0SzjKZuS3ut0i4P46Lc52m2JYHiLIcqzFAumpyxshU9mMQ13gJHtxD2fy"}