copyright: years: 2020, 2025 lastupdated: "2025-04-22"
keywords: Secrets Manager のイベント通知、Secrets Manager のイベント通知統合、Secrets Manager のアラート
subcollection: secrets-manager
Secrets Managerのイベント通知を有効にしています
IBM Cloud® Secrets Managerの管理者は、電子メール、SMS、またはその他のサポートされる配信チャネルを使用して、Secrets Managerのイベントの通知を他のユーザーまたは人の宛先に送信することができます。 さらに、例えば、Webhookを使用したイベント・ドリブン・プログラミングを使用してロジックを作成するために、これらのイベント通知を他のアプリケーションに送信することもできます。 これは、Secrets ManagerとIBM Cloud® Event Notificationsの統合によって可能になります。
Event Notificationsに情報を送信するには、Secrets Managerサービス・インスタンスをEvent Notificationsに接続する必要があります。 Event Notificationsの操作について詳しくは、Event Notifications の使い始め方をご覧ください。
Secrets Manager サービス・インスタンスを削除する場合は、 Event Notifications サービス・インスタンス内のソースとしての Secrets Manager も削除してください。
Secrets Managerによるイベントの収集と送信方法
Secrets Managerインスタンスで着目するイベントが発生すると、Secrets Managerは接続された Event Notificationsインスタンスと通信して、通知を サポート対象宛先に転送します。
Secrets Managerは、保留中の通知のリストを、イベント・タイプ、シークレットのタイプ、および有効期限の詳細(該当する場合)ごとに集約します。 サービスは、1分から2分ごとに、接続中のEvent Notificationsサービスに対して保留中の通知があるかどうか確認してディスパッチします。 例えば、以下のようなメッセージの通知を受け取ることがあります。
- 1 日で有効期限が切れる任意のシークレットが 1 つあります。
- 10日で有効期限が切れる5つの公開証明書シークレットがあります。
- 30日で有効期限が切れる100個のインポートされた証明書シークレットがあります。
100は、一回のイベント通知で通知可能なシークレットの最大数です。
Secrets Managerのイベント
以下のテーブルに、イベントを生成するSecrets Managerアクションを一覧表示します。
サービスで使用しているシークレットのタイプによっては、Secrets Manager によってイベントが生成されない場合があります。 例えば、24 時間以内に証明書の有効期限が切れるように設定されている場合は、通知を受け取りません。 詳しくは、『シークレット・タイプ別のイベント』を参照してください。
イベント名 | イベント・タイプ | サブタイプ | 説明 | 重大度レベル |
---|---|---|---|---|
シークレットが作成されました | com.ibm.cloud.secrets-manager.secret_created |
シークレットがインスタンスに追加されると、イベントが送信されます。 | low |
|
シークレットの作成に失敗しました | com.ibm.cloud.secrets-manager.secret_creation_failed |
シークレット作成のリクエストに失敗すると、イベントが送信されます。 | low |
|
シークレットがローテーションされました | com.ibm.cloud.secrets-manager.secret_rotated |
シークレットがローテートされ、新しいバージョンが使用可能になると、イベントが送信されます。 | low |
|
シークレットのローテーションに失敗しました | com.ibm.cloud.secrets-manager.secret_rotation_failed |
シークレットのローテート・リクエストに失敗すると、イベントが送信されます。 | high |
|
シークレットは90日後に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_90_days |
シークレットの有効期限から90日経過後に、イベントが送信されます。 | high |
シークレットは60日後に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_60_days |
シークレットの有効期限から60日経過後に、イベントが送信されます。 | high |
シークレットは30日後に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_30_days |
シークレットの有効期限から30日経過後に、イベントが送信されます。 | high |
シークレットは10日後に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_10_days |
シークレットの有効期限から10日経過後に、イベントが送信されます。 | high |
シークレットは1日後に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_1_day |
シークレットの有効期限から1日経過後に、イベントが送信されます。 | high |
シークレットは1日以内に期限切れになります | com.ibm.cloud.secrets-manager.secret_about_to_expire |
in_0_days |
シークレットの有効期限が1日未満になると、イベントが送信されます。 | high |
シークレットの期限切れ | com.ibm.cloud.secrets-manager.secret_expired |
シークレットが有効期限になると、イベントが送信されます。 | high |
|
シークレットの取り消し | com.ibm.cloud.secrets-manager.secret_revoked |
シークレットのバージョンが期限切れになる前に取り消されると、イベントが送信されます。 | low |
|
シークレットは削除されました | com.ibm.cloud.secrets-manager.secret_deleted |
シークレットが Secrets Manager インスタンスから削除されると、イベントが送信されます。 | low |
|
秘密の削除に失敗しました | com.ibm.cloud.secrets-manager.secret_deletion_failed |
シークレットを削除するリクエストに失敗すると、イベントが送られる。 | high |
|
秘密の削除がブロックされました | com.ibm.cloud.secrets-manager.secret_deletion_blocked |
シークレットがロックされているためにシークレットを削除できないと、イベントが送信されます。 | low |
|
シークレットの失効をブロック | com.ibm.cloud.secrets-manager.secret_revocation_blocked |
シークレットがロックされているためにそのシークレットを取り消すことができないと、イベントが送信されます。 | low |
|
秘密ローテーションのブロック | com.ibm.cloud.secrets-manager.secret_rotation_blocked |
シークレットがロックされているためにローテートできない場合、イベントが送信されます。 | low |
|
シークレット有効期限のブロック | com.ibm.cloud.secrets-manager.secret_expiration_blocked |
シークレットがロックされているためにシークレットの有効期限が切れない場合、イベントが送信されます。 | high |
|
秘密データが削除されました | com.ibm.cloud.secrets-manager.secret_data_removed |
シークレットのデータが削除されると、イベントが送信されます。 | low |
|
秘密バージョン・データが削除されました | com.ibm.cloud.secrets-manager.secret_version_data_deleted |
シークレット・バージョンのデータが削除されると、イベントが送信されます。 | low |
|
シークレット・タスク作成 | com.ibm.cloud.secrets-manager.secret_task_created |
シークレットのタスクが作成されると、イベントが送信されます。 | low |
|
シークレット・タスク成功 | com.ibm.cloud.secrets-manager.secret_task_succeeded |
タスクが正常に完了すると、イベントが送信される。 | low |
|
シークレット・タスク失敗 | com.ibm.cloud.secrets-manager.secret_task_failed |
タスクが失敗するとイベントが送られる。 | high |
|
シークレット・タスク削除 | com.ibm.cloud.secrets-manager.secret_task_deleted |
タスクが削除されるとイベントが送られる。 | low |
|
テスト・イベント | com.ibm.cloud.secrets-manager.test_event |
テスト通知がEvent Notificationsに転送されると、イベントが送信されます。 | low |
secret_about_to_expire
イベントは、指定された日に 1 回だけ送信されます。 つまり、シークレットの有効期限を10日と指定した場合、シークレットが残り10日になったときに1回だけ通知を受け取ることになる。 それ以外のとき、たとえばシークレットが残り9日になったときに通知が届くことはありません。
サポート対象シークレット・タイプ
以下の表には、サービスでサポートされるシークレット・タイプに基づいて生成できる Secrets Manager イベントが示されています。
イベント名 | イベント・タイプ | オカレンス | 任意 | IAM 資格情報 | キー値 | ユーザー資格情報 | インポートされたた証明書 | プライベート証明書 | パブリック証明書 | サービス資格情報 | カスタム資格情報 |
---|---|---|---|---|---|---|---|---|---|---|---|
シークレットが作成されました | com.ibm.cloud.secrets-manager.secret_created |
ワン・タイム | |||||||||
シークレットの作成に失敗しました | com.ibm.cloud.secrets-manager.secret_creation_failed |
ワン・タイム | |||||||||
シークレットがローテーションされました | com.ibm.cloud.secrets-manager.secret_rotated |
ワン・タイム | |||||||||
シークレットのローテーションに失敗しました | com.ibm.cloud.secrets-manager.secret_rotation_failed |
ワン・タイム | |||||||||
期限切れになるシークレット | com.ibm.cloud.secrets-manager.secret_about_to_expire |
シークレットの有効期限が切れる 90 日前、60 日前、30 日前、10 日前、1 日前、0 日前 | 適用外[1] | ||||||||
シークレットの期限切れ | com.ibm.cloud.secrets-manager.secret_expired |
毎日 | 適用外[2] | ||||||||
シークレットの取り消し | com.ibm.cloud.secrets-manager.secret_revoked |
ワン・タイム | 適用外[3] | 適用外[4] | 適用外[5] | 適用外[6] | 適用外[7] | 適用外[8] | 適用外[9] | 適用外[10] | |
シークレットは削除されました | com.ibm.cloud.secrets-manager.secret_deleted |
ワン・タイム | |||||||||
秘密の削除がブロックされました | com.ibm.cloud.secrets-manager.secret_deletion_blocked |
ワン・タイム | |||||||||
秘密ローテーションのブロック | com.ibm.cloud.secrets-manager.secret_rotation_blocked |
1 回[11] 毎日 [12] |
|||||||||
シークレットの失効をブロック | com.ibm.cloud.secrets-manager.secret_revocation_blocked |
ワン・タイム | 適用外[13] | 適用外[14] | 適用外[15] | 適用外[16] | 適用外[17] | 適用外[18] | 適用外[19] | 適用外[20] | |
シークレット有効期限のブロック | com.ibm.cloud.secrets-manager.secret_expiration_blocked |
1 回のみ 毎日 |
適用外[21] | 適用外[22] | 適用外[23] | 適用外[24] | |||||
秘密バージョン・データが削除されました | com.ibm.cloud.secrets-manager.secret_data_removed |
ワン・タイム | |||||||||
シークレット・タスク作成 | com.ibm.cloud.secrets-manager.secret_task_created |
ワン・タイム | |||||||||
シークレット・タスク成功 | com.ibm.cloud.secrets-manager.secret_task_created |
ワン・タイム | |||||||||
シークレット・タスク失敗 | com.ibm.cloud.secrets-manager.secret_task_created |
ワン・タイム | |||||||||
シークレット・タスク削除 | com.ibm.cloud.secrets-manager.secret_task_created |
ワン・タイム |
通知を有効にしています
Secrets Managerサービスのインスタンスによって生成されたイベントは、同じアカウントで使用可能なEvent Notificationsサービス・インスタンスに転送できます。 1つのEvent Notificationsサービス・インスタンスに対して、1つのSecrets Managerインスタンスのみ構成可能です。 開始するには、以下のものが必要です。
- Secrets Manager サービス上の責任者サービス・アクセス。
- Event Notifications サービス上の責任者サービス・アクセス。 アカウント内の既存の Event Notifications サービス・インスタンスを表示するには、ビューアー 権限以上のプラットフォーム・アクセス権限も必要です。
UIでEvent Notificationsに接続しています
Secrets Manager の通知を有効にする前に、 Secrets Manager インスタンスと同じアカウントに Event Notifications サービスインスタンスがあることを確認してください。 その後、 Secrets Manager UIの Settings > Event Notifications セクションを使用してサービスを接続することができます。
-
コンソールで、**「メニュー」**アイコン
**>「リソース・リスト」**をクリックします。
-
サービスのリストから、Secrets Manager のインスタンスを選択します。
-
Secrets Manager ナビゲーションで、**「設定」**をクリックします。
-
Event Notifications セクションで、**「接続」**をクリックします。
-
サイド・パネルで、接続のソースの詳細を確認します。 オプションで、説明を入力します。
-
接続するリソース・グループとEvent Notificationsサービス・インスタンスを選択します。
Secrets ManagerとEvent Notificationsの間のIAM許可がアカウントに存在しない場合は、ダイアログが表示されます。 プロンプトに従って、サービス間のアクセス権限を付与します。
- Secrets Manager と Event Notifications の間のアクセス権限を付与するには、**「許可」**をクリックします。
- サイド・パネルで、ターゲット・サービスとして Event Notifications を選択します。
- インスタンスのリストから、許可したいEvent Notificationsサービス・インスタンスを選択します。
- **「イベント・ソース・マネージャー」**ロールを選択します。
- **「レビュー」**をクリックします。
- 割り当て をクリックします。
-
接続を確認するには、**「接続」**をクリックします。
Secrets ManagerがEvent Notificationsに接続されたことを示す成功メッセージが表示されます。 後で Event Notifications から切断する必要が生じた場合は、「オプション」メニュー
**>「切断」**を使用して、Event Notifications インスタンス内のソース・サービスとしての Secrets Manager を削除できます。
Event Notificationsを切断する場合は、Secrets ManagerとEvent Notificationsの間のIAM許可を削除しないでください。Secrets Managerは、既存の許可を使用してEvent Notificationsから登録を解除します。 Event Notificationsインスタンスが削除されると、サービスとSecrets Managerの間に存在するすべての許可もIAMによって削除されます。
APIでEvent Notificationsに接続しています
Secrets Manager の通知を有効にする前に、 Secrets Manager インスタンスと同じアカウントに Event Notifications サービスインスタンスがあることを確認してください。 次に、Secrets ManagerAPIを呼び出すことで、プログラマチックにEvent Notificationsに接続できます。
以下の例は、Secrets Managerソース詳細をEvent Notificationsに登録するために使用できるクエリを示しています。 API を呼び出す場合は、ID 変数と IAM トークンを、ご使用の Secrets Manager インスタンス固有の値で置き換えます。
コンソールでevent_notifications_instance_crn
値を確認するには、「リソース」リストに移動し、Event Notificationsインスタンス行をクリックします。
curl -X POST
--H "Authorization: Bearer {iam_token}" \
--H "Accept: application/json" \
--H "Content-Type: application/json" \
--d'{
"event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::",
"event_notifications_source_description": "Optional description of this source in an Event Notifications instance.",
"event_notifications_source_name": "My Secrets Manager"
}' \
"https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/notifications/registration"
リクエストに成功すると、接続されているEvent Notificationsサービス・インスタンスのCRN値が返されます。 必須およびオプションのリクエスト・パラメーターについて詳しくは、APIドキュメントをご覧ください。
Terraform を使用した Event Notifications への接続
次の例は、 Event Notifications に Secrets Manager ソースの詳細を登録するために使用できる設定を示しています。
resource "ibm_sm_en_registration" "en_registration" {
instance_id = local.instance_id
region = local.region
name = "test-root-ca"
event_notifications_instance_crn = var.en_instance_crn
event_notifications_source_description = "My event notification source"
event_notifications_source_name = "my_en_source"
}
UIでEvent Notificationsにテスト・イベントを送信しています
Secrets Managerの通知を有効にしたら、接続をテストして、Secrets Managerによって生成されたイベントがEvent Notificationsに転送されていることを確認します。
テストSecrets Managerイベントを送信する前に、Event Notificationsインスタンスでトピック、宛先、サブスクリプションを作成しておく必要があります。 **「イベントのテスト」**イベント・タイプ (com.ibm.cloud.secrets-manager.test_event
)
が条件として Event Notifications トピックに含まれていることを確認します。
-
Secrets Manager UI で、**「設定」**をクリックします。
-
「Event Notifications」セクションで、**「テスト・イベントの送信」**をクリックします。
テスト・イベントが正常にEvent Notificationsに転送されたことを示す成功メッセージが表示されます。
APIでEvent Notificationsにテスト・イベントを送信しています
Secrets Managerの通知を有効にしたら、接続をテストして、Secrets Managerによって生成されたイベントがEvent Notificationsに転送されていることを確認します。
テストSecrets Managerイベントを送信する前に、Event Notificationsインスタンスでトピック、宛先、サブスクリプションを作成しておく必要があります。 **「イベントのテスト」**イベント・タイプ (com.ibm.cloud.secrets-manager.test_event
)
が条件として Event Notifications トピックに含まれていることを確認します。
以下の例は、Secrets ManagerからEvent Notificationsにテスト・イベントを送信するために使用できるクエリを示しています。 API を呼び出す場合は、ID 変数と IAM トークンを、ご使用の Secrets Manager インスタンス固有の値で置き換えます。
curl -X GET
--H "Authorization: Bearer {iam_token}" \
"https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/notifications/registration/test"
リクエストに成功すると、接続中のEvent Notificationsサービス・インスタンスにテスト・イベントが正常に転送されたことを示すHTTP200 OK
応答が返されます。 詳しくは、API資料をご覧ください。
選択した宛先に通知を配信しています
Secrets Managerの通知を有効にしたら、Event Notificationsでトピックとサブスクリプションを作成して、選択した宛先にアラートを転送および配信できるようにします。
サポートされる宛先の完全なリストについては、Event Notificationsドキュメントをご覧ください。
E メール通知
Secrets Managerイベント通知の配信チャネルとしてIBM Cloudメール・サービスを使用できます。 既存のトピックとIBM Cloudメール・サービスの間に、Event Notificationsサブスクリプションを作成して、アラートをメールでさまざまな受信者に転送します。
Secrets Managerイベントに関する情報を含む IBM Cloudからのメールは、以下の例のような内容になっています。
Subject: Your 2 public certificate secrets expire in 10 days
Body: You have 2 public certificate secrets that expire in 10 days: my-certificate-1, my-certificate-2. You can view and manage your existing secrets by accessing Secrets Manager in the console, or by using the CLI or APIs. For more information, check out the docs.
E メール内のイベント通知に関する詳細情報を受信するには、Event Notifications サブスクリプションの作成時に**「通知ペイロードの追加」** オプションを選択します。 イベントに関連付けられた「通知ペイロードの詳細」が E メールに表示されます。
Webhook
着信通知をアプリまたはサービスによってプログラマチックにコンシュームするため、Webhookの配信先を構成できます。 Webhookのセットアップについて詳しくは、Event Notificationsドキュメントを確認してください。
通知ペイロードの詳細
Secrets Managerによって生成される成功イベントには、イベントのソースと詳細を識別するのに役立つさまざまなフィールドが含まれています。
Secrets Managerからのイベント通知には、リソースの名前や識別子などのメタデータ・プロパティーのみが含まれます。 APIキーやパスワードなどの機密データは、生成されるイベントには含まれません。
Event Notificationsに送信されるプロパティーは、イベント・タイプとシークレットのタイプによって異なります。 例えば、1つ以上のpublic_cert
シークレットのインスタンスでsecret_about_to_expire:in_10_days
イベントが発生した場合、Secrets Managerは、以下の例のような通知ペイロードをEvent Notificationsに送信します。
{
"event_sub_type": "in_10_days",
"event_type": "secret_about_to_expire",
"secret_type": "public_cert",
"secrets": [
{
"domains": "domain1.com",
"event_time": "2022-01-04T00:00:00Z",
"event_triggered_by": "SecretsManager",
"secret_expiration": "2022-01-14T00:00:00Z",
"secret_group_id": "default",
"secret_id": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>:secret:<secret_id>",
"secret_name": "my-certificate-1",
"serial_number": "1:2:3:4"
},
{
"domains": "domain2.com, domain3.com",
"event_time": "2022-01-04T00:00:00Z",
"event_triggered_by": "SecretsManager",
"secret_expiration": "2022-01-14T00:00:00Z",
"secret_group_id": "default",
"secret_id": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>:secret:<secret_id>",
"secret_name": "my-certificate-2",
"serial_number": "1:2:3:4"
},
],
"source_instance_api_private_url": "https://<instance_id>.private.<region>.secrets-manager.appdomain.cloud/api",
"source_instance_api_public_url": "https://<instance_id>.<region>.secrets-manager.appdomain.cloud/api",
"source_instance_crn": "crn:v1:bluemix:public:secrets-manager:<region>:a/<account_id>:<instance_id>::",
"source_instance_dashboard_url": "https://cloud.ibm.com/services/secrets-manager/crn%3Av1%3Abluemix%3Apublic%3Asecrets-manager%3A<region>%3Aa%2Fa6cc9f5f21f34323a4175c1117638b40%3A<instance_id>%3A%3A",
"source_service": "SecretsManager"
}
イベント通知プロパティーについて詳しくは、以下のテーブルをご覧ください。
プロパティー | 説明 |
---|---|
event_sub_type |
通知のトリガーとなったイベントのタイプに対応するサブタイプ。 |
event_type |
通知のトリガーとなったイベントのタイプ。 |
secret_type |
イベントに関連付けられているシークレットのタイプ。
指定可能な値は、imported_cert、private_cert、public_cert |
secrets[] |
イベントに関連するシークレットのメタデータ・プロパティーを含むオブジェクトのリスト。 リストされるプロパティーは、シークレット・タイプによって異なります。 すべてのシークレット・タイプについて送信されるプロパティーには、以下のものがあります。
失敗イベントには、以下も含まれる可能性があります。
|
tasks[] |
イベントに関連付けられたシークレットタスクのメタデータプロパティを含むオブジェクトのリスト。 すべてのシークレット・タイプについて送信されるプロパティーには、以下のものがあります。
失敗イベントには、以下も含まれる可能性があります。
|
source_instance_api_private_url |
Secrets Managerサービス・インスタンスに割り当てられているプライベート・エンドポイントURL。 |
source_instance_api_public_url |
Secrets Managerサービス・インスタンスに割り当てられているパブリック・エンドポイントURL。 |
source_instance_crn |
Secrets Manager サービス・インスタンスを一意的に識別するクラウド・リソース名 (CRN)。 |
source_instance_dashboard_url |
コンソールのSecrets Managerサービス・ダッシュボードのURL。 |
source_service |
イベント通知を送信したサービスの表示名。 |
-
このシークレットタイプにはTTL(time-to-live)の制限がないため、イベントは適用されない。 ↩︎
-
このシークレットタイプにはTTL(time-to-live)の制限がないため、イベントは適用されない。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
手動ローテーションが成功しなかったことを通知する通知を受け取ります。 ↩︎
-
自動ローテーションが失敗すると、成功するまで毎日通知されます。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
この通知タイプはプライベート証明書にのみ適用されるため、イベントは適用されません。 ↩︎
-
このシークレットタイプにはTTL(time-to-live)の制限がないため、イベントは適用されない。 ↩︎
-
このシークレットタイプでは有効期限をブロックできないため、イベントは適用されません。 ↩︎
-
このシークレットタイプでは有効期限をブロックできないため、イベントは適用されません。 ↩︎
-
このシークレットタイプでは有効期限をブロックできないため、イベントは適用されません。 ↩︎