Consent

Universal Login の consent 画面をカスタマイズするために利用できる、すべてのプロパティとメソッドについて説明します。

Consent クラスは、consent 画面の機能を提供します。この画面では、要求された権限がユーザーに表示され、アクセスを許可するか拒否するかを選択できます。

​

コンストラクター

同意画面マネージャーのインスタンスを作成します:

Example

import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.accept();

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、ブランディング関連の構成を提供します。

client · ClientMembers

consent 画面向けに、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

ユーザーの組織に関する情報 (id や name など) を提供します。

prompt · PromptMembers

認証フロー内の現在の prompt に関するデータを含みます。

screen · ScreenMembersOnConsent

要求されている scopes の一覧や hideScopes フラグなど、consent 画面固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関連するデータを含みます。

transaction · TransactionMembers

アクティブな識別子やフローの状態など、consent 画面向けのトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

consent フロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細が含まれます。

​

メソッド

accept · Promise<void>

このメソッドは、要求された権限を受け入れる (グラントする) というユーザーの決定を送信します。

Example

import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.accept();

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
consentManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例：'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語がセッション中維持されます。

deny · Promise<void>

このメソッドは、要求された権限を拒否するというユーザーの決定を送信します。

Example

import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
await consentManager.deny();

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーが存在しない場合は空の配列を返します。