Cenário: aplicativo nativo chamando API Web

  • Artigo

Aplica-se a: Windows Server 2022, Windows Server 2019, AD FS 2019 e posterior

Saiba como criar um aplicativo nativo conectando usuários autenticados pelo AD FS 2019 e adquirindo tokens usando a biblioteca MSAL para chamar APIs Web.

Antes de ler este artigo, é necessário estar familiarizado com os Conceitos do AD FS e o Fluxo de concessão de código de autorização

Visão geral

Overview

Neste fluxo, você adiciona autenticação ao aplicativo nativo (cliente público), que poderá, portanto, conectar os usuários e chamar uma API Web. Para chamar uma API Web de um aplicativo nativo que conecta usuários, você poderá usar o método de aquisição de token AcquireTokenInteractive da MSAL. Para permitir essa interação, a MSAL aproveita um navegador da Web.

Para reconhecer melhor como configurar um aplicativo nativo no AD FS para adquirir o token de acesso de forma interativa, usaremos um exemplo disponível aqui e percorreremos as etapas de registro de aplicativo e configuração de código.

Pré-requisitos

  • Ferramentas de cliente do GitHub
  • AD FS 2019 ou posterior configurado e em execução
  • Visual Studio 2013 ou posterior.

Registro de aplicativo no AD FS

Esta seção mostra como registrar o aplicativo nativo como um cliente público e a API da Web como uma RP (terceira parte confiável) no AD FS

  1. No Gerenciamento do AD FS, clique com o botão direito do mouse em Grupos de Aplicativos e selecione Adicionar Grupo de Aplicativos.

  2. No Assistente para Adicionar Grupo de Aplicativos, para o Nome insira NativeAppToWebApi e, em Aplicativos cliente-servidor, selecione o modelo Aplicativo nativo acessando uma API Web. Clique em Próximo.

    Screenshot of the Welcome page of the Add Application Group Wizard showing the Native application accessing a Web API template highlighted.

  3. Copiar o valor do Identificador do Cliente. Ele será usado posteriormente como o valor de ClientId no arquivo App.config do aplicativo. Insira o seguinte para o URI de Redirecionamento:https://ToDoListClient. Clique em Adicionar. Clique em Avançar.

    Screenshot of the Native application page of the Add Application Group Wizard showing the redirect U R I.

  4. Na tela Configurar API Web, insira o Identificador:https://localhost:44321/. Clique em Adicionar. Clique em Próximo. Esse valor será usado posteriormente nos arquivos App.config e Web.config do aplicativo.

    Screenshot of the Configure Web API page of the Add Application Group Wizard showing the correct identifier.

  5. Na tela Aplicar Política de Controle de Acesso, selecione Permitir todos e clique em Avançar.

    Screenshot of the Choose Access Control Policy page of the Add Application Group Wizard showing the Permit everyone option highlighted.

  6. Na tela Configurar Permissões de Aplicativo, verifique se openid está selecionado e clique em Avançar.

    Screenshot of the Configure Application Permissions page of the Add Application Group Wizard showing open I D selected.

  7. Na tela Resumo, clique em Avançar.

  8. Na tela Concluído, clique em Fechar.

  9. No Gerenciamento do AD FS, clique em Grupos de Aplicativos e selecione o grupo de aplicativos NativeAppToWebApi. Clique com o botão direito do mouse e selecione Propriedades.

    Screenshot of the A D F S Management dialog box showing the NativeAppToWebApi group highlighted and the Properties option in the dropdown list.

  10. Na tela de propriedades de NativeAppToWebApi, selecione NativeAppToWebApi – API Web em API Web e clique em Editar…

    Screenshot of the NativeAppToWebApi Properties dialog box showing the NativeAppToWebApi - Web A P I application highlighted.

  11. Na tela NativeAppToWebApi – Propriedades de API Web, selecione a guia Regras de Transformação de Emissão e clique em Adicionar Regra...

    Screenshot of the NativeAppToWebApi - Web A P I Properties dialog box showing the Issuance Transform Rules tab.

  12. Em Assistente para Adicionar Regra de Declaração de Transformação, selecione Transformar uma Declaração de Entrada no menu suspenso Modelo de regra de declaração: e clique em Avançar.

    Screenshot of the Select Rule Template page of the Add Transform Claim Rule Wizard showing the Transform an Incoming Claim option selected.

  13. Insira NameID no campo Nome da regra de declaração:. Selecione Nome para Tipo de declaração de entrada:, ID do Nome para Tipo de declaração de saída: e Nome comum para Formato de ID do nome de saída:. clique em Concluir.

    Screenshot of the Configure Rule page of the Add Transform Claim Rule Wizard showing the configuration explained above.

  14. Clique em OK na tela NativeAppToWebApi – Propriedades de API Web e, em seguida, na tela Propriedades de NativeAppToWebApi.

Configuração de código

Esta seção mostra como configurar um aplicativo nativo para fazer logon do usuário e recuperar o token para chamar a API Web

  1. Baixe o exemplo aqui

  2. Abrir o exemplo usando o Visual Studio

  3. Abra o arquivo App.config. Modifique o seguinte:

    • ida:Authority – insira https://[your AD FS hostname]/adfs

    • ida:ClientId – insira o valor do Identificador do Cliente de nº 3 em Registro de Aplicativo na seção do AD FS acima.

    • ida:RedirectUri – insira o valor do URI de Redirecionamento de nº 3 em Registro de Aplicativo na seção do AD FS acima.

    • todo:TodoListResourceId – insira o valor do Identificador de nº 4 no Registro de Aplicativo na seção do AD FS acima.

    • ida: todo:TodoListBaseAddress – insira o valor do Identificador de nº 4 em Registro de Aplicativo na seção do AD FS acima.

      Screenshot of the App config file showing the modified values.

  4. Abra o arquivo Web.config. Modifique o seguinte:

    • ida:Audience – insira o valor do Identificador do nº 4 na seção Registro de Aplicativo no AD FS acima

    • ida: AdfsMetadataEndpoint – insira https://[your AD FS hostname]/federationmetadata/2007-06/federationmetadata.xml

      Screenshot of the web config file showing the modified values.

O exemplo de teste

Esta seção mostra como testar o exemplo configurado acima.

  1. Após as alterações de código, recompile a solução

  2. No Visual Studio, clique com o botão direito do mouse na solução e selecione Definir Projetos de Inicialização...

    Screenshot of the list that appears when you right-click the solution with the Set Start Up Projects option highlighted.

  3. Nas páginas Propriedades, verifique se Ação está definida como Iniciar para cada um dos Projetos

    Screenshot of the Solution Property Pages dialog box showing the Multiple startup project option selected and all of the projects' actions set to Start.

  4. Na parte superior do Visual Studio, clique na seta verde.

    Screenshot of the Visual Studio UI with the Start option called out.

  5. Na tela principal do Aplicativo Nativo, clique em Entrar.

    Screenshot of the To Do List Client dialog box.

Se você não visualizar a tela do aplicativo nativo, pesquise e remova os arquivos *msalcache.bin da pasta em que o repositório do projeto está salvo no sistema.

  1. Você será redirecionado para a página de entrada do AD FS. Vá em frente e entre.

    Screenshot of the Sign In page.

  2. Após entrar, insira o texto Compilar um aplicativo nativo para API Web em Criar um item de Tarefa Pendente. Clique em Adicionar Item. Isso chamará o Serviço de Lista de Tarefas Pendentes (API Web) e adicionará o item no cache.

    Screenshot of the To Do List Client dialog box with the new to do item populating the To Do Items section.

Próximas etapas

Fluxos e cenários de aplicativo do AD FS OpenID Connect/OAuth