Você está lendo a documentação do Apigee Edge.
Acesse a documentação da
Apigee X. info
Bem-vindo à página inicial do OAuth no Apigee Edge. Esta página de destino apresenta links para documentação, amostras e outros recursos relacionados ao uso do OAuth no Apigee Edge.
O framework OAuth 2.0
Proteja suas APIs com o OAuth 2.0. Esta seção lista recursos, exemplos de código, vídeos e outros tópicos para ajudar você a usar o OAuth 2.0 no Apigee Edge.
Saiba mais sobre o OAuth 2.0
Essa coleção de recursos ajudará você a agilizar o OAuth 2.0.
-
Documentação da Apigee
- Introdução ao OAuth 2.0: abrange os conceitos e termos básicos do OAuth 2.0. Foca no uso do OAuth no Apigee Edge.
- Treinamento e certificações da Apigee:
- A Apigee oferece treinamento on-line para desenvolvedores de API, incluindo um curso sobre segurança de API, que contém o OAuth.
-
Especificação IETF:
- Especificação IETF: altamente recomendável que você revise essa especificação. Ele inclui uma boa introdução básica e visão geral conceitual.
-
E-book e vídeo da Apigee:
- OAuth: o panorama geral, um e-book sem custo financeiro da Apigee.
- OAuth: o panorama geral, um webcast sem custo financeiro da Apigee.
Implementar os fluxos de tipo de permissão de acesso
A Apigee oferece exemplos funcionais de cada tipo de permissão de acesso do OAuth 2.0 para ajudar você a começar. As amostras representam as práticas recomendadas e demonstram como implementar tipos de concessão do OAuth no Apigee Edge.
Credenciais do cliente
- Como implementar o tipo de permissão de acesso de credenciais do cliente: apresentação, com ênfase nas etapas necessárias para implementar esse tipo de permissão de acesso no Apigee Edge.
- Implementação de amostra: confira esta amostra no repositório de api-samples no GitHub.
- Segurança da API (inclui OAuth)
Código de autorização
- Implementação do tipo de concessão do código de autorização: apresentação, com ênfase nas etapas necessárias para implementar esse tipo de concessão no Apigee Edge.
- Exemplo de implementação: confira este exemplo avançado no repositório de api-samples no GitHub. Você pode clonar a amostra, implantá-la e executá-la. Para mais detalhes, consulte o arquivo README. Ele inclui um aplicativo de login robusto que autentica os usuários e se comunica de forma segura com o servidor de autorização.
Implícito
- Solicitação de tokens: tipo de permissão de acesso implícito: mostra como solicitar tokens com o tipo de permissão de acesso implícito.
Credenciais de senha do proprietário do recurso
- Como implementar o tipo de permissão de acesso de senha: apresentação, com ênfase nas etapas necessárias para implementar esse tipo de permissão de acesso no Apigee Edge.
Tópicos rápidos de instruções
Estes tópicos fornecem um contexto rápido e etapas concisas para lidar com tarefas comuns do OAuth 2.0:
- Como configurar um novo proxy de API
- Como registrar aplicativos clientes
- Como conseguir credenciais de cliente
- Como configurar endpoints e políticas do OAuth
- Como solicitar tokens e códigos de autenticação
- Como personalizar tokens de acesso
- Como aprovar e revogar tokens de acesso
- Como enviar um token de acesso
- Como verificar tokens de acesso
- Como trabalhar com escopos
- Tópicos avançados
Referências de políticas e APIs
Esses tópicos fornecem informações de referência detalhadas sobre as políticas e APIs que são diretamente compatíveis com o OAuth 2.0 no Edge.
-
Políticas do OAuthV2: com essas políticas, é possível implementar e personalizar
os quatro tipos de concessão do OAuth 2.0 no Apigee Edge:
- Política OAuthV2: o coração da implementação do Apigee Edge OAuth 2.0. Ela permite configurar "operações" do OAuth 2.0 no Apigee Edge que geram tokens de acesso e de atualização, emitem códigos de autorização e validam tokens. Este tópico inclui exemplos de código que ajudam a exemplificar como as coisas funcionam.
- Política GetOAuthV2Info: recebe atributos de tokens e os disponibiliza para políticas e código em execução em um proxy de API. Esse tipo de política pode ser útil quando você precisa configurar em um token de acesso o comportamento dinâmico e condicional com base em um valor. Consulte também Como personalizar tokens de acesso.
- Política SetOAuthV2Info: atualiza o perfil de um token de acesso. Por exemplo, você pode querer incorporar uma tag exclusiva para sua empresa. Consulte também Como personalizar tokens de acesso.
- Códigos de erro do OAuth 2.0
- APIs OAuth 2.0: a Apigee fornece essas APIs para trabalhar com endpoints OAuth 2.0.
O framework OAuth 1.0a
O OAuth 1.0a define um protocolo padrão que permite aos usuários autorizar aplicativos que consomem APIs em nome deles, sem exigir que usuários divulguem suas senhas para o aplicativo durante o processo.
Referência da política do OAuth 1.0a
O suporte ao OAuth 1.0a foi descontinuado. Para mais detalhes, consulte Recursos descontinuados. O tipo de política OAuthV1 é responsável por gerar tokens de solicitação, tokens de acesso e verificar tokens de acesso com base na especificação OAuth 1.0a.
APIs do OAuth 1.0a
A Apigee fornece APIs para trabalhar com endpoints OAuth 1.0a.
Amostra de OAuth 1.0a no GitHub
Este exemplo de proxy de API no GitHub ilustra uma configuração de três pernas OAuth 1.0. É possível fazer o download e executar este código.
| Nome | Descrição |
|---|---|
| oauth10a-3legg | Demonstra uma configuração de três pernas do OAuth 1.0a. |