Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Twilio Clé d'API
Champs de valeurs secrets
Les champs suivants doivent figurer dans le secret du Gestionnaire de Secrets :
{
"accountSid": "AC followed by 32 hexadecimal characters",
"apiKeySid": "SK followed by 32 hexadecimal characters",
"apiKeySecret": "API key secret",
"validationUrl": "https://api.twilio.com/2010-04-01/Accounts/ACxxxx/Messages.json?PageSize=1"
}
- ID du compte
-
Le SID du Twilio compte ou du sous-compte qui possède la clé API.
- api KeySid
-
Le SID de la clé d'API actuelle. Les touches standard et restreintes sont prises en charge.
- api KeySecret
-
Le secret associé au SID de la clé d'API actuelle. Secrets Manager fait pivoter ce champ avec
apiKeySid. - URL de validation
-
(Facultatif) URL d'TwilioAPI en lecture seule que Secrets Manager appelle pour confirmer que la nouvelle clé fonctionne. L'URL doit utiliser le protocole HTTPS et un
twilio.comhôte.Ce champ est obligatoire pour une clé restreinte. Une clé restreinte ne peut appeler que les points de terminaison autorisés par sa politique. Fournissez donc un point de terminaison dont vous savez que la politique l'autorise. Pour une clé standard, Secrets Manager déduit un point de terminaison par défaut.
Champs de métadonnées secrets
Les champs de métadonnées de la clé Twilio API sont les suivants :
{ "adminSecretArn": "arn:aws:secretsmanager:us-east-1:111122223333:secret:TwilioMainApiKey", "retainPreviousKey": "false", "friendlyNamePrefix": "aws-sm-api-key" }
- administrateur SecretArn
-
Le nom de ressource Amazon (ARN) du secret contenant les informations d'identification de l'administrateur. Utilisez un secret de type TwilioMainApiKey ou un secret de type TwilioAuthToken.
- conserver PreviousKey
-
(Facultatif) Si la clé précédente reste active après la promotion. Par défaut : false, ce qui supprime immédiatement la clé précédente. Définissez ce champ sur true pour que la clé précédente reste utilisable pendant un cycle de rotation, afin que les applications puissent actualiser les informations d'identification mises en cache.
- amical NamePrefix
-
(Facultatif) Le préfixe du nom convivial de chaque clé de remplacement. Valeur par défaut :
aws-sm-api-key.
Flux d'utilisation
Cette rotation utilise une architecture à deux secrets. Une clé d'TwilioAPI ne peut pas effectuer de rotation d'elle-même, car les points de terminaison de gestion des Twilio clés rejettent l'authentification par clé d'API. Un secret d'administrateur fournit donc les informations d'identification qui créent et suppriment les clés.
Vous pouvez créer votre secret à l'aide de l'CreateSecretappel avec la valeur secrète contenant les champs mentionnés ci-dessus et le type de secret as TwilioApiKey. Les configurations de rotation peuvent être définies à l'aide d'un RotateSecretappel. Vous devez fournir les métadonnées adminSecretArn dans les métadonnées de rotation. Vous devez également fournir un ARN de rôle dans l'RotateSecretappel qui accorde au service les autorisations requises pour faire pivoter le secret. Pour un exemple de politique d'autorisations, voir Sécurité et autorisations.
Le type de secret administrateur (TwilioMainApiKeyouTwilioAuthToken) est différent du type de secret utilisateur (TwilioApiKey). En raison de cette différence, la politique de rotation des rôles définie par défaut n'secretsmanager:resource/Typeautorise pas l'accès au secret de l'administrateur. Vous devez explicitement fournir au rôle de rotation l'accès au secret d'administrateur. Vous pouvez le faire en ajoutant une instruction dont la portée est limitée au type de secret administrateur. Vous pouvez également spécifier le secret de l'administrateur ARN directement dans la politique de rôle.
Pendant la rotation, Secrets Manager lit le type et la politique de la clé actuelle. Il crée une clé de remplacement portant le même type et la même politique, et stocke la clé de remplacement sous le nom AWSPENDING. Cela confirme que la nouvelle clé s'authentifie auprès du point de terminaison de validation. Il supprime ensuite la clé précédente et fait passer AWSPENDING à AWSCURRENT. Si vous définissez retainPreviousKey ce paramètre sur true, Secrets Manager conserve la clé précédente et la supprime lors de la prochaine rotation.
Chaque clé de remplacement hérite du type et de la politique de la clé qu'elle remplace, de sorte qu'une clé restreinte reste restreinte avec les mêmes autorisations. La rotation échoue au lieu de créer une clé avec des privilèges différents lorsque Secrets Manager ne peut pas lire le type ou la politique de la clé actuelle.