リソース別ドキュメント

Auth0 Deploy CLI のリソース別ドキュメントの詳細を説明します。

一般に、Deploy CLI のリソース設定ファイルは Auth0 Management API のペイロードスキーマにほぼ対応していますが、いくつか注意すべき重要な違いがあります。

​

クライアントグラント

Deploy CLI 自身のクライアントグラントは、意図的にエクスポートされず、このクライアントグラント自体を設定することもできません。これは破壊的な変更を防ぐためです。そうしないと、このツールがインポートの途中でアクセスを取り消したり、クラッシュしたりするおそれがあります。マルチテナントかつ複数環境のコンテキストでは、Getting Started で説明されているように、新しいテナントには Deploy CLI 用の専用クライアントがあらかじめ作成されていることが想定されています。

​

プロンプト

多言語のカスタムテキストプロンプトは、特定の階層構造に従います。ルートレベルの prompts リソースプロパティの配下には、カスタムテキストの翻訳を他のプロンプト設定とまとめて保持するための独自の customText プロパティがあります。customText の下には、2 文字の言語コード があります。次にプロンプト ID、その次に画面 ID、最後にテキスト ID が続きます。

​

階層

prompts:
  customText:
    <LANGUAGE>: # 2文字の言語コード
      <PROMPT_ID>: # プロンプトID
        <SCREEN_ID>: # プロンプト画面ID
          <TEXT_ID>: 'Some text'

​

例

prompts:
  identifier_first: true
  universal_login_experience: classic
  customText:
    en:
      login:
        login:
          description: 英語でのログインの説明
          buttonText: ボタンのテキスト
      mfa:
        mfa-detect-browser-capabilities:
          pickAuthenticatorText: '別の方法を試す'
          reloadButtonText: '再読み込み'
          noJSErrorTitle: 'JavaScriptが必要です'
        mfa-login-options:
          pageTitle: '${clientName}にログイン'
          authenticatorNamesSMS: 'SMS'

​

データベース

データベース接続を管理する場合、options.customScripts の値は、出力フォルダーのパスからの相対パスで指定された特定の JavaScript ファイルを参照します。その他の点では、ペイロードは Auth0 Management API のものとほぼ一致します。

​

YAML の例

YAML モードでのフォルダー構成:

./databases/
    /Username-Password-Authentication
        /change_password.js   
        /create.js   
        /delete.js   
        /get_user.js   
        /login.js   
        /verify.js   
./tenant.yaml

 tenant.yaml の内容:

databases:
  - name: Username-Password-Authentication
    # ...
    options:
      # ...
      customScripts:
        change_password: ./databases/Username-Password-Authentication/change_password.js
        create: ./databases/Username-Password-Authentication/create.js
        delete: ./databases/Username-Password-Authentication/delete.js
        get_user: ./databases/Username-Password-Authentication/get_user.js
        login: ./databases/Username-Password-Authentication/login.js
        verify: ./databases/Username-Password-Authentication/verify.js

​

ディレクトリ モードの例

ディレクトリ モード時のフォルダー構造:

./database-connections/
    ./Username-Password-Authentication/
        ./change_password.js
        ./create.js
        ./database.json
        ./delete.js
        ./get_user.js
        ./login.js
        ./verify.js

database.json の内容:

{
  "options": {
    "customScripts": {
      "change_password": "./change_password.js",
      "create": "./create.js",
      "delete": "./delete.js",
      "get_user": "./get_user.js",
      "login": "./login.js",
      "verify": "./verify.js"
    }
  }
}

​

Universal Login

​

ページ

カスタムHTMLでUniversal Loginをオーバーライドする場合、エラー、ログイン、多要素認証、およびパスワードリセットの内容は、それぞれ特定のHTMLページに分かれています。

​

YAML の例

YAML モードでのフォルダー構成:

./pages/
    /error_page.html
    /guardian_multifactor.html
    /login.html
    /password_reset.html
./tenant.yaml

tenant.yaml の内容:

pages:
  - name: error_page
    html: ./pages/error_page.html
    show_log_link: false
    url: https://mycompany.org/error
  - name: guardian_multifactor
    enabled: true
    html: ./pages/guardian_multifactor.html
  - name: login
    enabled: false
    html: ./pages/login.html
  - name: password_reset
    enabled: true
    html: ./pages/password_reset.html

​

ディレクトリの例

ディレクトリモードの場合のフォルダー構成:

./pages/
    ./error_page.html
    ./error_page.json
    ./guardian_multifactor.html
    ./guardian_multifactor.json
    ./login.html
    ./login.json
    ./password_reset.html
    ./password_reset.json

login.json の内容:

{
  "name": "login",
  "enabled": false,
  "html": "./login.html"
}

error_page.json の内容:

{
  "html": "./error_page.html",
  "show_log_link": false,
  "url": "https://mycompany.org/error",
  "name": "error_page"
}

guardian_multifactor.json の内容:

{
  "enabled": true,
  "html": "./guardian_multifactor.html",
  "name": "guardian_multifactor"
}

password_reset.json の内容:

{
  "enabled": true,
  "html": "./password_reset.html",
  "name": "password_reset"
}