Le composant d'authentification par clé API valide les requêtes entrantes en extrayant une clé API de la requête HTTP et en la comparant à une liste d'identifiants de confiance. Configurez le composant pour lire la clé depuis un paramètre d'URL, un en-tête de requête ou un cookie.
Catégorie de fonctionnalité : Authentification et autorisation
Description des champs
ComponentConfig
| Paramètre |
Type |
Obligatoire |
Valeur par défaut |
Description |
| Config |
ApiKeyConfig |
Oui |
- |
Configuration de l'authentification par clé API. |
ApiKeyConfig
| Paramètre |
Type |
Obligatoire |
Valeur par défaut |
Description |
| ApiKeySources |
ApiKeySourcesConfig |
Oui |
- |
Source d'extraction de la clé API. Une seule source est prise en charge. |
| ApiKeyCredentials |
ApiKeyCredential[] |
Oui |
- |
Liste des identifiants de clé API de confiance utilisés pour la validation. |
ApiKeySourcesConfig
Spécifiez exactement l'un des champs suivants. Le composant lit la clé API à partir de la source configurée.
| Paramètre |
Type |
Obligatoire |
Valeur par défaut |
Description |
| Headers |
String[] |
Non |
- |
En-têtes de requête contenant la clé API. |
| Params |
String[] |
Non |
- |
Paramètres d'URL contenant la clé API. |
| Cookies |
String[] |
Non |
- |
Cookies contenant la clé API. |
ApiKeyCredential
| Paramètre |
Type |
Obligatoire |
Valeur par défaut |
Description |
| Provider |
ApiKeyCredentialProvider |
Oui |
System |
Type d'identifiant. Valeurs valides : System, Custom. |
| Credential |
String |
Conditionnel |
- |
Chaîne de caractères de la clé API. Obligatoire lorsque Provider est défini sur Custom. Longueur : 8 à 512 caractères. |
ApiKeyCredentialProvider
| Valeur |
Description |
| System |
Identifiant généré par le système. |
| Custom |
Identifiant chargé par l'utilisateur. |
Codes d'erreur
| Code d'état HTTP |
Message d'erreur |
Cause |
| 401 |
Client authentication failed. |
Échec de la vérification de la clé API. La clé API est invalide ou manquante. |