ポータルコンポーネントライブラリリファレンス

Universal Portalsでサポートされているコンポーネントのリファレンスです。タイプ識別子、リソースサーバー、スコープ、設定の制限について説明します。

Universal PortalsはUniversal Componentsライブラリを使用するほか、Auth0 Formsや、コンテンツ・構造用のコンポーネントといった独自のコンポーネントも備えています。

各コンポーネントには、タイプ識別子があります。ポータルページにコンポーネントを追加するには、type (コンポーネントにオプションがある場合はconfigも) を指定したオブジェクトを、ページのcomponents配列に追加します。詳細については、「Universal Portalsを構成する」をお読みください。

​

コンポーネントの概要

コンポーネント	グループ	呼び出し先
ユーザーMFA管理	Universal Components	My Account API
パスキー管理	Universal Components	My Account API
Organization Details Edit	Universal Components	My Organization API
ドメインテーブル	Universal Components	My Organization API
Form	Auth0 Forms	Formsバックエンド

ポータルでは、コンテンツ・構造コンポーネントとして、見出し、リッチテキスト、画像、セクション、区切り線も利用できます。

​

Universal Components

Universal Componentsは、ユーザーに代わってリソースサーバーを呼び出します。ポータルアプリケーションには、リソースサーバーごとに、各コンポーネントに記載されたスコープを含むクライアントへの認可とリフレッシュトークンポリシーが必要です。詳細については、「アプリケーションを構成する」をお読みください。

​

ユーザーMFA管理

タイプ: page:component:auth0:my_account:mfa_management

呼び出し先	設定	スコープ
My Account API	なし	read:me:factors read:me:authentication_methods create:me:authentication_methods delete:me:authentication_methods

​

パスキー管理

タイプ: page:component:auth0:my_account:passkey_management

呼び出し先	設定	スコープ
My Account API	なし	read:me:authentication_methods create:me:authentication_methods delete:me:authentication_methods

​

Organization Details Edit

タイプ: page:component:auth0:my_organization:details_edit

呼び出し先	設定	スコープ
My Organization API	なし	read:my_org:details update:my_org:details read:my_org:configuration

​

ドメインテーブル

Type: page:component:auth0:my_organization:domain_table

呼び出し	設定	スコープ
My Organization API	なし	read:my_org:domains create:my_org:domains update:my_org:domains delete:my_org:domains read:my_org:identity_providers create:my_org:identity_providers_domains delete:my_org:identity_providers_domains

My Organizationコンポーネント (Organization Details Editとドメインテーブル) では、IDトークンに含まれるユーザーの権限に応じて、操作の表示・非表示が切り替わります。ポータルでは、書き込み権限のないユーザーに対してボタンは無効化されず、変更を送信した時点でエラーが表示されます。

​

Auth0 Forms

​

Form

タイプ: page:component:auth0:form

プロパティ	タイプ	必須	説明
form_id	文字列、1～50文字	はい	レンダリングするFormのID。
completion_message	文字列、1～200文字	はい	ユーザーがFormを送信した後に表示されるメッセージ。

​

Formsのコンテキスト変数

ポータル内のFormは、ポータルの読み込み時にユーザーのIDトークンからコンテキストを取得します。ログイン時にFormsが受け取る取引コンテキスト全体は利用できません。

常に利用可能なもの：

{{context.user.user_id}}

その他の{{context.user.*}}変数は、ユーザーのIDトークンに含まれるクレームによって決まります。これらのクレームは、サインイン時にリクエストされたスコープと、アクションで追加するクレームによって変わります。たとえば、openid、profile、emailスコープの標準クレームには次のようなものがあります。

{{context.user.name}}
{{context.user.given_name}}
{{context.user.family_name}}
{{context.user.nickname}}
{{context.user.email}}
{{context.user.email_verified}}
{{context.user.picture}}

ポータルはコンテキスト変数をサーバー側で設定するため、ブラウザーから変更することはできません。Formsでサポートされている変数の詳細については、「変数」をご覧ください。

​

コンテンツ・構造コンポーネント

コンテンツ・構造コンポーネントは、ポータル ページのレイアウトを決め、ブランディングの一貫性を維持します。

​

見出し

タイプ: page:component:auth0:typography:heading

プロパティ	型	必須	説明
title	文字列 (1～50文字)	はい	見出しのテキスト。
description	文字列 (1～200文字)	いいえ	見出しの下に表示されるテキスト。リンク、太字、斜体、下線を使用できます。

​

リッチテキスト

タイプ: page:component:auth0:typography:rich_text

プロパティ	型	必須	説明
content	文字列、1～10,000文字	はい	HTMLコンテンツ。見出し、太字、斜体、下線、リンク、テキストの配置、リストに対応しています。

​

セクション

型: page:component:auth0:structure:section

プロパティ	型	必須	説明
variant	card または none	はい	コンテナのスタイル。
children	最大20個のコンポーネントの配列	はい	セクション内に配置するコンポーネント。セクションの中に別のセクションを入れることはできません。
title	文字列 (1～50文字)	いいえ	セクションの上部に表示されるタイトル。
description	文字列 (1～200文字)	いいえ	タイトルの下に表示されるテキスト。

​

区切り線

タイプ: page:component:auth0:structure:separator

プロパティ	型	必須	説明
variant	solid、dashed、または none	いいえ	線のスタイルです。デフォルトは solid です。
text	文字列 (1～50文字)	いいえ	線の中央に表示するラベルです。variant が none の場合は無視されます。

​

画像

タイプ: page:component:auth0:media:image

プロパティ	型	必須	説明
src	URL (最大500文字)	はい	画像のURL。
position	left、center、または right	いいえ	水平方向の配置。
height	整数 (1～500)	いいえ	高さ (ピクセル単位) 。幅は縦横比を維持するように自動調整されます。

​

サイドバーコンポーネント

サイドバーコンポーネントは、ポータル のナビゲーションに表示するリンクを定義します。ページの components 配列ではなく、navigation.sidebar.components に追加してください。

タイプ	必須プロパティ	任意プロパティ
sidebar:component:auth0:internal_link:v2	label (1〜50 文字) 、page_slug (1〜50 文字)	icon
sidebar:component:auth0:external_link:v2	label (1〜50 文字) 、href (URL、最大 200 文字)	icon

icon には、Lucide アイコンの名前をケバブケースで指定します (最大 50 文字) 。

​

制限

Universal Portalsには以下の制限があります。

項目	制限
ポータルのname	1～150文字
ポータルおよびページのslug	英小文字、数字、ハイフンのみ使用可能。先頭は英字。最大100文字
ページのtitle	1～150文字
custom_code.head内のカスタムコード	1～10,000文字

​

次のステップ

Universal Portals を設定する

これらのコンポーネントをポータルのページやナビゲーションに追加しましょう。