認証の管理

Vonage CLI は柔軟な設定システムを使用して API クレデンシャルを管理します。ローカルまたはグローバル設定ファイルと、これらの値を上書きするためのコマンドライン・フラグをサポートしており、プロジェクトのニーズや個人的な好みに基づいて設定を調整することができます。

構成

CLIは以下の順序でコンフィグレーションをロードする：

  1. コマンドライン・フラグ --api-key, --api-secret, --private-keyそして --app-id.
  2. 現在の作業ディレクトリにあるローカル・コンフィギュレーション・ファイル .vonagerc.
  3. のグローバル・コンフィギュレーション・ファイル。 .vonage ホームディレクトリの $HOME/.vonage/config.json.

注： CLIだけがこれらの値を .vonagerc.Vonage SDKは、独自の認証情報で個別に初期化する必要があります。

注:秘密鍵の内容は設定ファイル内に保存される。これは、新しい鍵が生成されたときに鍵が上書きされないようにするための設計です。

フラッグ

フラッグ 説明 タイプ
--app-id 使用するアプリケーションのID。これはダッシュボードの "Applications "セクションに記載されています。 vonage apps. ストリング
--privateKey 秘密鍵のパスまたは内容。秘密鍵にアクセスできるのは、アプリケーションを作成するときか、ダッシュボードで鍵を再生成するときだけです。 ストリング
--apiKey ダッシュボードの「API設定」セクションにあるAPIキー。 ストリング
--apiSecret ダッシュボードの「API設定」セクションにあるAPIシークレット。 ストリング

認証の設定

CLIは設定しなくても使用できるが、コマンドを実行する際にフラグを渡す必要がある。

を使用している。 vonage auth set コマンドを実行するたびに入力する手間を省くために、このコマンドを推奨する。

フラッグ

これは、上記の 構成.

例

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

注:ランニング vonage auth set を使用しても、現在の値は削除されません。そのため、API Key/Secretのみ、またはApp ID/PrivateKeyのみを個別に設定することも可能です。ただし、APIキーとシークレットが設定されていない状態で、アプリIDとプライベートキーを設定することはできない。これは、コマンドが認証情報の有効性をチェックする方法によるものだ。

注:このコマンドは、コミットする前に認証情報が正しいかどうかもチェックする。

認証チェック

認証の詳細が有効であることをVerifyする。デフォルトでは、グローバル設定ファイルを使用する。認証情報の確認は以下のように動作する：

  1. APIキーとシークレットは、アプリケーションをリストアップするために アプリケーションAPI.
  2. Applications IDと秘密鍵の検証は、アプリケーション情報を取得し、公開鍵と秘密鍵が正しくペアになっていることを確認することで行われる。

注：このコマンドはコマンドライン引数を使用しません。コンフィギュレーション・ファイルのみをチェックします。

フラッグ

フラッグ 説明
--local ローカル・コンフィギュレーション・ファイル(.vonagerc)

例

グローバル・コンフィギュレーションを確認する：

vonage auth check 

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

ローカル・コンフィギュレーションをチェックする：

vonage auth check --local

Global credentials found at: .vonagerc

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

認証を表示する

現在の認証設定を表示する。これは、前述の設定ロードに従います。 上記 で、CLIがどの設定ファイルを使用しているかを知ることができる。

注:このコマンドは、認証情報が正しいかどうかもチェックする。

フラッグ

フラッグ 説明
--show-all Redactされていない秘密鍵とAPIシークレットを表示する。
--yaml YAML形式で出力する。
--json JSON形式で出力する。

例

vonage auth show

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key