リソース固有のドキュメント

Auth0 Deploy CLIのリソースドキュメントの詳細について説明します。

一般に、Deploy CLI リソース構成ファイルはAuth0 Management APIのペイロードスキーマとほぼ一致しますが、特に注意すべき微妙な違いがいくつかあります。

​

クライアントの許可

Deploy CLIの独自のクライアントの許可は、意図的にエクスポートされることも、それ自体で構成可能でもありません。これは、破壊的変更を防ぐために行われます。そうしない場合、ツールがアクセスを取り消すか、インポート中にクラッシュする可能性があります。複数テナントにまたがった複数の環境では、はじめにでも説明したように、Deploy CLI用にすでに確立された指定のクライアントが新しいクライアントで使用されることが想定されます。

​

プロンプト

多言語のカスタムテキストプロンプトは特定の階層に従います。ルートレベルのプロンプトでは、リソースプロパティはカスタムテキスト翻訳を他のプロンプト設定にバンドルするのに使用される固有のcustomTextプロパティです。customTextの下にあるのが2文字言語コードです。三番目がプロンプトIDで、その後に画面IDとテキストIDが順に続きます。

​

階層

prompts:
  customText:
    <LANGUAGE>: # two character language code
      <PROMPT_ID>: # prompt ID
        <SCREEN_ID>: # prompt screen ID
          <TEXT_ID>: 'Some text'

​

例

prompts:
  identifier_first: true
  universal_login_experience: classic
  customText:
    en:
      login:
        login:
          description: Login description in english
          buttonText: Button text
      mfa:
        mfa-detect-browser-capabilities:
          pickAuthenticatorText: 'Try another method'
          reloadButtonText: 'Reload'
          noJSErrorTitle: 'JavaScript Required'
        mfa-login-options:
          pageTitle: 'Log in to ${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"
    }
  }
}

​

ユニバーサルログイン

​

ページ

ユニバーサルログインをカスタムHTMLで上書きする場合、エラー、ログイン、多要素認証、およびパスワードリセットが特定の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"
}