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

String. APIリクエストの送信に使用する、指定されたAuth0 applicationのIDです。

​

AUTH0_CLIENT_SECRET

String。APIリクエストの送信に使用する、指定されたAuth0 applicationのシークレットです。

​

AUTH0_ACCESS_TOKEN

String. 指定されたAuth0 applicationからaccess tokenとしてManagement APIにアクセスするための短期間有効なトークンです。client IDとclient secretの組み合わせの代わりに使用できます。

​

AUTH0_CLIENT_SIGNING_KEY_PATH

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

​

AUTH0_CLIENT_SIGNING_ALGORITHM

String型。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

特定のキーワードを動的に置換するためのマッピングです。詳しくは、キーワード置換をご覧ください。

​

例

{
  "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

String。Management API のアクセストークンを取得する際に、audience の値とは別の値を指定します。デフォルトの Management API endpoint が公開されていない場合に便利です。

​

AUTH0_EXCLUDED_RULES

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

​

AUTH0_EXCLUDED_CLIENTS

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

​

AUTH0_EXCLUDED_DATABASES

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

​

AUTH0_EXCLUDED_CONNECTIONS

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

​

AUTH0_EXCLUDED_RESOURCE_SERVERS

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