Authentification ibm-cloud-authentication
Utilisez la stratégie IBM Cloud Authentication pour vous authentifier auprès de IBM Cloud et obtenir une clé d'API qui peut être utilisée lors de l'envoi de demandes à watsonx.ai.
Prise en charge des passerelles
| Passerelle | Version de la stratégie |
|---|---|
| DataPower® API Gateway | 1.0.0 |
Cette rubrique décrit comment configurer la stratégie dans votre source OpenAPI . Pour plus de détails sur la configuration de la stratégie dans l'interface utilisateur de l'assemblage, voir AuthentificationIBM Cloud.
A propos de
La règle ibm-cloud-authentication fournit une clé d'API à IBM Access Manager et, si l'authentification aboutit, renvoie un jeton bearer à utiliser par toutes les demandes d'opération watsonx.ai suivantes. Le jeton bearer est mis en cache et sera valide pendant environ 60 minutes. Un nouveau jeton est extrait lorsqu'une réponse pour la clé d'API n'a pas été mise en cache. ou arrivé à expiration.
Propriétés
Le tableau suivant répertorie les propriétés des stratégies, indique si une propriété est nécessaire, définit les valeurs d'entrée et par défaut valides et précise le type de données des valeurs.
| Libellé de la propriété | Obligatoire | Descriptif | Type de données |
|---|---|---|---|
| version | Oui | Numéro de version de la stratégie. Vous devez spécifier une version pour la règle compatible avec la passerelle que vous utilisez. Lorsque l'API est publiée, si la version est incompatible avec la passerelle, une erreur de validation indiquant les versions disponibles est émise. | chaîne |
| title | Non | Titre de la règle ; la valeur par défaut est ibm-cloud-authentication. Le titre s'affiche dans l'éditeur d'assemblage d'API de l'interface utilisateur. |
chaîne |
| description | Non | Description de la stratégie. | chaîne |
| apikey | Oui | Clé d'API ou référence de variable à la variable qui contient une clé d'API. La clé d'API est utilisée pour authentifier les demandes watsonx.ai suivantes. | chaîne |
Exemple
- ibm-cloud-authentication:
version: 2.0.0
title: ibm-cloud-authentication
apikey: $(watsonx-ai-apikey)