認証設定の管理
認証設定では、Webhook エンドポイントに通知を送信するときに NTT CPaaS が認証する方法を定義します。これらのセキュリティ設定は、NTT CPaaSのみがシステムに通知を配信できるようにすることで、Webhookを保護します。認証設定の作成、再利用、削除は、 NTT CPaaS Webインターフェース または サブスクリプションAPIから行うことができます。
認証により、要求ペイロードが保護されます。相互TLSによるトランスポートレベルのセキュリティについては、「証明書の管理」を参照してください。両方を一緒に使用して、階層化されたセキュリティを実現できます。
前提条件 [#prerequisites]
認証設定を作成するには、次のものが必要です。
- 認証方法: Webhook に必要な方法 (Basic、HMAC、または OAuth) に関する知識。
- 資格情報: 認証資格情報の準備ができました (以下の認証方法を参照)。
- 通知プロファイル: プロファイルの準備ができているか、認証の設定後に作成する予定です。通知プロファイルの管理を参照してください。
認証方法(Basic、HMAC、OAuth 2.0)、リクエスト署名、検証の詳細については、 サブスクリプションコンポーネントを参照してください。
認証設定の作成 [#create]
通知プロファイルを設定するときに認証設定を作成するか、複数のプロファイルで再利用するためのスタンドアロン設定を作成します。
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[認証設定] タブを開きます。
-
[認証設定の作成] を選択します。
-
セキュリティ設定名 は、文字、数字、ダッシュ、またはアンダースコアのみを使用して入力します。
-
認証タイプを選択し、必要な資格情報を入力します。
作り方 必須フィールド オプションのフィールド ベーシック ユーザー名、パスワード — HMACの 秘密鍵、HMACアルゴリズム — OAuth 2.0 トークン URL、付与タイプ クライアント ID、クライアント シークレット、クライアント スコープ、リソース、ヘッダー -
[保存] を選択して、認証設定を作成します。
セキュリティ設定の作成 API エンドポイントを使用します。サポートされているタイプ: BASIC、HMAC、および OAUTH。
authIdは作成後に変更できません。
認証設定の表示または編集 [#view-edit]
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[認証設定] タブを開き、検索バーを使用して設定を検索します。
-
設定の横にある 3 つのドットのメニューを選択し、次を選択します。
- 表示: 認証構成の概要を表示する
- 編集: 資格情報、秘密鍵、または OAuth パラメーターの変更
-
変更を行い、更新 を選択します。
サブスクリプション API を使用して、次のことを行います。
- ページネーションですべての認証設定を取得する
- 認証IDで特定の設定を取得する
- 資格情報を更新するか、認証の種類を変更する
認証設定の削除 [#delete]
-
NTT CPaaS Web インターフェイスにログインし、開発者ツール > サブスクリプション管理 に移動します。
-
[認証設定] タブを開き、検索バーを使用して設定を検索します。
-
設定の横にある 3 つのドットのメニューを選択し、[削除] を選択します。
セキュリティ設定の削除 API エンドポイントを使用します。要求パスで認証 ID を指定します。
アクティブな通知プロファイルにリンクされている認証設定は、直接削除できません。最初に通知プロファイルから認証設定参照を削除します。詳細は、サブスクリプション階層と削除ルールを参照してください。
通知プロファイルの管理
通知配信を設定し、認証を適用します。
証明書の管理
相互TLSを有効にして、エンドポイントセキュリティを強化します。
Webhook サブスクリプションの管理
サブスクリプションを作成および管理します。
サブスクリプションの階層と削除ルール
コンポーネントの関係と削除の依存関係。