コネクションでAWS Secrets Managerを使用する
動画ガイド: AWS Secrets Managerでコネクションを安全に設定
このガイドでは、Amazon Web Services (AWS) Secrets Managerボールトのシークレットを使用してWorkatoコネクションを設定する方法について説明します。
前提条件
このガイドの手順を完了するには、次の前提条件を満たしている必要があります:
Workatoで:
- 正常に確立されたAWS Secrets Managerのワークスペースレベルまたはプロジェクトレベルコネクション。
- 作成およびコネクションの編集権限を持つユーザーロール。
Amazon Web Services (AWS)で:
- 既存のJSONキー/値ペア形式のシークレット。 Workatoはプレーンテキストのシークレットをサポートしていません。 シークレットを作成する方法の詳細については、AWSドキュメントのシークレットの作成を参照してください。
- AWS Secrets Managerでシークレットを表示するための権限。
AWSからシークレットの詳細を取得する
AWSからシークレットの詳細を取得するには、次の手順を実行します:
AWS Management Consoleにサインインし、Secrets Managerコンソールを開きます。
ナビゲーションペインで、Secretsをクリックします。
Workatoで使用する予定のシークレットをクリックします。
Secret nameとSecret ARNをコピーし、安全に保存します。 これらの値は、Workatoで外部シークレットを設定するために必要です。
Workatoコネクションを設定する
AWS Secrets Managerを使用してWorkatoでコネクションを設定するには、次の手順を実行します:
Workatoアカウントで新しいコネクションを作成するか、既存のコネクションの設定ページを開きます。
外部シークレットが必要な入力フィールドをクリックするか、その上にカーソルを合わせてから、+ Add external secretをクリックします。
Add external secretダイアログにKey nameとSecret ARNを入力します。
外部シークレットの追加
完了をクリックします。 シークレットは、コネクションページの入力フィールドにマスクされたデータピルとして表示されます。
シークレットを編集するには、データピルを選択します。
接続をクリックし、このコネクションが機能することを確認します。
シークレットマスクを使用してシークレットを追加する場合は、Workatoコネクションの認証情報で使用されるシークレットについて、次の構文に従います:
{{workato:sm:<key name>:<secret ARN>}}<key name>シークレット名そのものではなく、シークレット内の特定のキー名を指します。 たとえば、
jiraという名前のシークレットには、prod.jira.secret.keyがキー名で、その値が実際の個人アクセストークンであるキー/値ペアが含まれている場合があります。<secret ARN>AWS Secrets Manager内のシークレットのAmazon Resource Name（ARN）。 例:
txt{{workato:sm:prod.jira.secret.key:arn:aws:secretsmanager:us-east-1:137149879143:secret:prod-jira-credentials-FsmeTs}}
この例では、prod.jira.secret.keyはjiraという名前のシークレット内のキー名であり、arn:aws:secretsmanager:us-east-1:137149879143:secret:prod-jira-credentials-FsmeTsはsecret ARNです。
コネクションの設定ページで、この値全体を適切なフィールドに貼り付けます。 次の画像は、JiraコネクションでCustom Service client secret値として使用されているシークレットを示しています:
コネクション設定を完了する
Connectを選択して認可し、コネクションの設定を完了します。
シークレットキャッシュの動作
WorkatoはAWS Secrets Managerから取得した認証情報を60分間キャッシュします。 この期間中は、シークレットを更新またはローテーションしても、レシピはキャッシュされた値を引き続き使用します。
キャッシュの有効期限が切れると、次回のレシピ実行時にAWS Secrets Managerから最新の値が取得されます。 変更をすぐに適用するには、Secrets managementキャッシュをクリアエンドポイントを呼び出します。 これにより、コネクションを切断して再接続しなくても、Workatoで最新の認証情報を強制的に取得できます。
Last updated: