Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Bienvenue sur la page d'accueil d'OAuth sur Apigee Edge. Cette page de destination fournit des liens vers une documentation, des exemples et d'autres ressources en rapport avec l'utilisation du protocole OAuth sur Apigee Edge.
Framework OAuth 2.0
Sécurisez vos API avec OAuth 2.0. Cette section répertorie les ressources, les exemples de code, les vidéos et d'autres sujets pour vous aider à utiliser OAuth 2.0 sur Apigee Edge !
En savoir plus sur OAuth 2.0
Cet ensemble de ressources vous aidera à devenir rapidement opérationnel sur OAuth 2.0.
- Documentation Apigee :
- Présentation d'OAuth2.0 : couvre les concepts et les termes de base d'OAuth 2.0. Se concentre sur l'utilisation d'OAuth sur Apigee Edge.
- Formation et certifications Apigee :
- Apigee propose une formation en ligne pour les développeurs d'API, dont un cours sur la sécurité des API, qui inclut OAuth.
- Spécification IETF :
- Spécification IETF : Apigee vous recommande vivement de consulter cette spécification. Elle inclut une introduction de base et une présentation conceptuelle.
- E-book et vidéo Apigee :
- OAuth the Big Picture, un e-book Apigee gratuit.
- OAuth the Big Picture, un webcast Apigee gratuit.
Mettre en œuvre les flux de type d'attribution
Apigee fournit des exemples fonctionnels de chaque type d'attribution OAuth 2.0 pour vous aider à démarrer. Les exemples illustrent les bonnes pratiques et montrent comment mettre en œuvre des types d'attribution OAuth sur Apigee Edge.
Identifiants client
- Mise en œuvre du type d'attribution des identifiants client : présente le type d'attribution, en insistant sur les étapes que vous devez suivre pour mettre en œuvre ce type d'attribution sur Apigee Edge.
- Exemple de mise en œuvre : consultez cet exemple dans notre dépôt d'exemples d'API sur GitHub.
- Sécurité des API (inclut OAuth)
Code d'autorisation
- Mise en œuvre du type d'attribution des codes d'autorisation : présente le type d'attribution, en insistant sur les étapes que vous devez suivre pour mettre en œuvre ce type d'attribution sur Apigee Edge.
- Exemple de mise en œuvre : consultez cet exemple dans notre dépôt d'exemples d'API sur GitHub. Vous pouvez cloner l'exemple, le déployer et l'exécuter. Pour plus d'informations, consultez le fichier README. Celle-ci inclut une application de connexion robuste qui authentifie les utilisateurs et communique en toute sécurité avec le serveur d'autorisation.
Implicite
- Demander des jetons : type d'attribution implicite : indique comment demander des jetons avec le type d'attribution implicite.
Identifiants de mots de passe des propriétaires de ressources
- Mise en œuvre du type d'attribution de mots de passe : présente le type d'attribution, en insistant sur les étapes que vous devez suivre pour mettre en œuvre ce type d'attribution sur Apigee Edge.
Guides d'utilisation rapide
Les rubriques suivantes fournissent un contexte rapide et des étapes concises pour la gestion des tâches OAuth 2.0 courantes :
- Configurer un nouveau proxy d'API
- Enregistrer des applications clientes
- Récupérer des identifiants client
- Configurer des points de terminaison et des règles OAuth
- Demander des jetons et des codes d'authentification
- Personnaliser les jetons d'accès
- Approuver et révoquer les jetons d'accès
- Envoyer un jeton d'accès
- Valider des jetons d'accès
- Utiliser les champs d'application
- Sujets avancés
Documentation de référence des règles et des API
Ces articles fournissent des informations de référence détaillées sur les règles et les API compatibles directement avec OAuth 2.0 sur Edge.
- Stratégies OAuth V2 : ces stratégies vous permettent de mettre en œuvre et de personnaliser les quatre types d'autorisations OAuth 2.0 sur Apigee Edge :
- Règle OAuthV2 : cœur de l'implémentation d'Apigee Edge OAuth 2.0. Celle-ci vous permet de configurer des "opérations" OAuth 2.0 sur Apigee Edge qui génèrent des jetons d'accès et d'actualisation, des codes d'autorisation et des jetons de validation. Cette rubrique contient des exemples de code permettant d'en illustrer le fonctionnement.
- Règle GetOAuthV2Info : récupère les attributs des jetons et les met à la disposition des règles et du code s'exécutant dans un proxy d'API. Ce type de règle peut être utile lorsque vous devez configurer un comportement conditionnel dynamique en fonction d'une valeur figurant dans un jeton d'accès. Consultez également la section Personnaliser les jetons d'accès.
- Règle SetOAuthV2Info : met à jour le profil d'un jeton d'accès. Par exemple, vous pouvez intégrer un tag propre à votre entreprise. Consultez également Personnaliser les jetons d'accès.
- Codes d'erreur OAuth 2.0
- API OAuth 2.0 : Apigee fournit ces API pour l'utilisation des points de terminaison OAuth 2.0.
Framework OAuth 1.0a
OAuth 1.0a définit un protocole standard qui permet aux utilisateurs d'applications d'autoriser des applications à utiliser des API en leur nom, sans qu'ils aient besoin de communiquer leurs mots de passe à l'application lors du processus.
Référence des règles OAuth 1.0a
La documentation de référence sur les règles OAuth V1 explique comment configurer une instance OAuth v1.0a. Ce type de règle est chargé de générer des jetons de requête et des jetons d'accès, ainsi que de vérifier les jetons d'accès en fonction de la spécification OAuth 1.0a.
API OAuth 1.0a
Apigee fournit des API permettant d'utiliser les points de terminaison OAuth 1.0a.
Exemple OAuth 1.0a sur GitHub
Cet exemple de proxy d'API sur GitHub illustre une configuration à trois acteurs d'OAuth 1.0a. Vous pouvez télécharger et exécuter ce code.
| Nom | Description |
|---|---|
| oauth10a-3led | Montre la configuration à trois acteurs d'OAuth 1.0a. |