Escopo de autenticação da REST API

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 1 min. de leitura

    • Suporte ao escopo de autenticação para REST API.

    Anteriormente, cada token de acesso ou token OIDC era vinculado ao escopo useraccount que tinha acesso total às REST APIs do usuário. A partir da versão Yokohama, para fornecer acesso somente às REST APIs específicas, o escopo de autenticação da REST API foi introduzido.

    Depois de criar o registro de escopo de autenticação da REST API, para acessar essa REST API, você deve associar o mesmo escopo de autenticação à entidade OAuth que deve ter acesso a essa REST API. Para uma nova entidade OAuth, o escopo de autenticação padrão está vazio.

    Nota:
    A menos que você tenha o registro Escopo de autenticação da REST API, a REST API pode ser acessada por qualquer entidade OAuth válida.

    Você deve vincular manualmente o escopo de autenticação na entidade OAuth. O useraccount é um escopo especial. Se estiver associado a uma entidade OAuth, ele poderá acessar qualquer API, mesmo se você tiver criado um registro de escopo de autenticação de REST API com um escopo de autenticação diferente.

    Nota:
    • Depois que o escopo de autenticação da REST API for habilitado e adicionado ao escopo de autenticação da REST API, todos os tokens OAuth existentes não poderão mais acessar esta API, a menos que o administrador adicione este escopo de autenticação à entidade OAuth correspondente
    • O administrador é responsável por garantir que oauth_entity tenha o escopo de autenticação correto após vincular o escopo de autenticação à REST API.
    • Os tokens de acesso OAuth emitidos pela ServiceNow são compatíveis com o escopo de autenticação.
    • O token OIDC que não é emitido pela ServiceNow é validado pela ServiceNow.
    • O token OIDC tem seu escopo do IDP quando você precisa de um token de ID. Aqui, o escopo de autenticação é para ServiceNow em vez de terceiros (IdP).

    Configurações do escopo da REST API

    Para configurar o escopo da REST API, execute as seguintes tarefas:
    • Crie um escopo de autenticação
    • Vincule o escopo de autenticação com a REST API
    • Vincule o escopo de autenticação à entidade OAuth
    • Execute o fluxo OAuth para obter o token de acesso OAuth
    • Use o token de acesso OAuth para fazer a chamada de API