Deploy CLI を設定する

Auth0 Deploy CLI を設定して、ニーズに合わせてツールをカスタマイズする方法を学びます。

Deploy CLI の設定は、Auth0 の認証情報を設定し、ツールの動作をニーズに合わせて調整するうえで重要です。Deploy CLI は、次の 2 つの方法で設定できます。

1. 設定ファイル (config.json) を使用します。
2. 環境変数を設定します。

​

設定ファイル

Deploy CLI の設定には、JSON ファイルを単体で使用できます。このファイルは通常、プロジェクトのルートディレクトリに配置し、config.json という名前にする必要があります。

​

例

{
  "AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN>",
  "AUTH0_CLIENT_ID": "{yourClientId}",
  "AUTH0_ALLOW_DELETE": false
}

認証情報をハードコードすることは推奨されません。このファイルを誤って公開バージョン管理システムにコミットすると、シークレットが漏えいするおそれがあります。このリスクを軽減するベストプラクティスとして、認証情報は環境変数として渡してください。

​

環境変数

デフォルトでは、Deploy CLI は環境変数を読み込みます。これにより、認証情報やその他の設定を config.json ファイルに記述しなくても、ツールに渡せます。環境変数は、プロジェクトの要件に応じて config.json ファイルを補完する目的でも、完全に置き換える目的でも使用できます。

AUTH0_KEYWORD_REPLACE_MAPPINGS や AUTH0_EXCLUDED などの非プリミティブな設定値も、それらの値が適切にシリアライズされた JSON であれば、環境変数経由で渡せます。

import または export コマンドで環境変数の読み込みを無効にするには、--env=false 引数を渡します。

​

例

​

config.json ファイルがない YAML 形式の設定をデプロイする

$ export AUTH0_DOMAIN={yourDomain}
$ export AUTH0_CLIENT_ID={yourClientId}
$ export AUTH0_CLIENT_SECRET={yourClientSecret}
$ a0deploy import --input_file=local/tenant.yaml

​

環境変数の読み込みを無効にする

$ a0deploy export -c=config.json --format=yaml --output_folder=local --env=false

​

プリミティブ型以外の設定値

$ export AUTH0_EXCLUDED='["actions","organizations"]'
$ export AUTH0_KEYWORD_REPLACE_MAPPINGS='{"ENVIRONMENT":"dev"}'
$ a0deploy export -c=config.json --format=yaml --output_folder=local

​

利用可能な設定プロパティ

​

AUTH0_DOMAIN

文字列。対象のAuth0テナントのドメイン。

​

AUTH0_CLIENT_ID

文字列。API リクエストの実行に使用される、指定の Auth0 アプリケーションの ID。

​

AUTH0_CLIENT_SECRET

文字列。API リクエストの実行に使用される、指定された Auth0 アプリケーションのシークレット。

​

AUTH0_ACCESS_TOKEN

文字列。指定された Auth0 アプリケーションから アクセストークン にアクセスするための、短期間有効な Management API です。クライアントID と クライアントシークレット の組み合わせの代わりに使用できます。

​

AUTH0_CLIENT_SIGNING_KEY_PATH

文字列。クライアントが Private Key JWT 認証を行う際に使用する秘密鍵のパスです。作業ディレクトリからの相対パスです。署名アルゴリズム を指定するには、AUTH0_CLIENT_SIGNING_ALGORITHM も参照してください。

​

AUTH0_CLIENT_SIGNING_ALGORITHM

文字列。Private Key JWT 認証を実行する際にクライアントが使用する JWT 署名アルゴリズムを指定します。AUTH0_CLIENT_SIGNING_KEY_PATHと組み合わせる場合にのみ使用します。

使用できる値: RS256, RS384, PS256.

​

AUTH0_ALLOW_DELETE

ブール値。有効にすると、ツールがリソースを削除できるようになります。デフォルト: false。

​

AUTH0_EXCLUDED

文字列の配列。リソースタイプ全体を双方向の管理対象から除外します。詳細は、リソースを管理対象から除外するを参照してください。

AUTH0_INCLUDED_ONLY と同時に使用することはできません。

指定可能な値: actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers。

​

例

{
  "AUTH0_EXCLUDED": ["organizations", "connections", "hooks"]
}

​

AUTH0_INCLUDED_ONLY

文字列の配列です。双方向で管理するリソースタイプを指定します。詳細は、管理対象からリソースを除外するを参照してください。

AUTH0_EXCLUDED と同時に使用することはできません。

指定可能な値: actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

例

{
  "AUTH0_INCLUDED_ONLY": ["clients", "connections", "tenant", "branding"]
}

​

AUTH0_KEYWORD_REPLACE_MAPPINGS

特定のキーワードの動的置換に使用するマッピングです。詳細については、Keyword Replacementを参照してください。

​

例

{
  "ENVIRONMENT": "DEV",
  "ALLOWED_ORIGINS": ["https://dev.test-site.com", "localhost"]
}

​

AUTH0_PRESERVE_KEYWORDS

ブール値。有効にすると、エクスポート時にローカルのリソースファイル内にあるキーワード置換マーカーの保持を試みます。無効の場合、リモートの値で手動配置したキーワードマーカーが上書きされます。

この設定を使用するには、ローカル設定ファイルが存在し、AUTH0_KEYWORD_REPLACE_MAPPINGS 設定プロパティでキーワード置換マッピングが定義されている必要があります。

関連情報: エクスポート時にキーワードを保持する。

​

AUTH0_EXPORT_IDENTIFIERS

ブール値。有効にすると、すべてのリソースの識別子を返します。シングルテナント環境での特定のデバッグや記録保持の用途で役立つ場合があります。既定値: false。

​

EXCLUDED_PROPS

管理の対象から不要なプロパティを除外できます。

​

例

{
  "connections": ["options.twilio_token"]
}

​

AUTH0_AUDIENCE

文字列。Management API のアクセストークンを取得する際に使用する、オーディエンス の値とは別の値です。既定の Management API エンドポイントが一般公開されていない場合に役立ちます。

​

AUTH0_EXCLUDED_RULES

文字列の配列です。ID で指定した特定の Rules を管理対象から除外します。注: この設定は、将来的に非推奨になる可能性があります。詳細については、管理対象からリソースを除外するを参照してください。

​

AUTH0_EXCLUDED_CLIENTS

文字列の配列です。ID で指定した特定のクライアントを管理対象から除外します。注: この設定は、将来的に非推奨となる可能性があります。詳細については、管理対象からリソースを除外するを参照してください。

​

AUTH0_EXCLUDED_DATABASES

文字列の配列です。ID で指定した特定のデータベースを管理対象から除外します。注: この設定は将来的に非推奨となる可能性があります。詳しくは、管理対象からリソースを除外するを参照してください。

​

AUTH0_EXCLUDED_CONNECTIONS

文字列の配列です。ID で特定の接続が管理対象にならないようにします。注: この設定は、今後非推奨となる可能性があります。詳しくは、管理対象からリソースを除外するを参照してください。

​

AUTH0_EXCLUDED_RESOURCE_SERVERS

文字列の配列です。ID で指定した特定の リソースサーバー の管理を除外します。注: この設定は、将来的に非推奨となる可能性があります。詳細については、管理対象からリソースを除外する を参照してください。