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": "<YOUR_CLIENT_ID>",
  "AUTH0_ALLOW_DELETE": false
}

デフォルトでは、Deploy CLIは環境変数を取り込み、config.jsonファイルに公開しなくても資格情報やその他の構成をツールに渡すことができます。環境変数は、プロジェクトのニーズに応じてconfig.jsonファイルを拡張するために使用することも、同ファイルを完全に置き換えるために使用することもできます。

AUTH0_KEYWORD_REPLACE_MAPPINGSやAUTH0_EXCLUDEDのような非プリミティブ構成値も、これらの値が適切にシリアル化されたJSONである限り、環境変数を介して渡すことができます。

importまたはexportコマンドのいずれかで環境変数の使用を無効にするには、--env=false引数を渡します。

$ export AUTH0_DOMAIN=<YOUR_AUTH0_DOMAIN>
$ export AUTH0_CLIENT_ID=<YOUR_CLIENT_ID>
$ export AUTH0_CLIENT_SECRET=<YOUR_CLIENT_SECRET>
$ 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テナントのドメイン。

文字列。API要求を行うために使用される、指定されたAuth0アプリケーションのID。

文字列。API要求を行うために使用される、指定されたAuth0アプリケーションのシークレット。

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

文字列。秘密鍵JWT認証を促進する際にクライアントが使用するプライベートキーへのパス。作業ディレクトリからの相対パス。署名アルゴリズムを指定するには、AUTH0_CLIENT_SIGNING_ALGORITHMも指定してください。

文字列。秘密鍵JWT認証を促進する際にクライアントが使用するJWT署名アルゴリズムを指定します。AUTH0_CLIENT_SIGNING_KEY_PATHとの組み合わせでのみ使用されます。

受け入れられる値：RS256、RS384、PS256

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

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

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"]
}

文字列の配列。双方向で管理するリソースの種類を指定します。詳細については、Managementからリソースを除外するをお読みください。

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"]
}

特定のキーワードを施設の動的な置換にマッピングします。詳細については、キーワードの置換をお読みください。

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

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

この構成では、ローカル構成ファイルの存在と、AUTH0_KEYWORD_REPLACE_MAPPINGS構成プロパティを介して定義されたキーワード置換マッピングが必要です。

次の記事も参照してください：エクスポート時にキーワードを保持する

ブール値。有効にすると、すべてのリソースの識別子が返されます。単一テナントの場合に、特定のデバッグや記録管理で役立つ可能性があります。デフォルト：false

管理対象から不要なプロパティを除外する機能を提供します。

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

文字列。Management APIのアクセストークンを取得する際に、値をオーディエンスの値から分離します。デフォルトのManagement APIエンドポイントが一般に公開されていない場合に役立ちます。

文字列の配列。IDによる特定のルールの管理を除外します。注意：この構成は将来廃止される可能性があります。詳細については、Managementからリソースを除外するをお読みください。

文字列の配列。IDによる特定のクライアントの管理を除外します。注意：この構成は将来廃止される可能性があります。詳細については、Managementからリソースを除外するをお読みください。

文字列の配列。IDによる特定のデータベースの管理を除外します。注意：この構成は将来廃止される可能性があります。詳細については、Managementからリソースを除外するをお読みください。

文字列の配列。IDによる特定の接続の管理を除外します。注意：この構成は将来廃止される可能性があります。詳細については、Managementからリソースを除外するをお読みください。

文字列の配列。IDによる特定のリソースサーバーの管理を除外します。注意：この構成は将来廃止される可能性があります。詳細については、Managementからリソースを除外するをお読みください。