メインコンテンツへスキップ
ConsentMembers
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleAccept = async () => {
 try {
   await consentManager.accept();
   console.log('同意が正常に承認されました。');
 } catch (err) {
   console.error('同意の承認中にエラーが発生しました:', err);
 }
};

コンストラクター

Consent 画面マネージャーのインスタンスを生成します。 このコンストラクターは BaseContext を初期化し、同意画面向けに調整された ScreenOverride のインスタンスで screen プロパティを設定します。

例外

Universal Login コンテキストが利用できない場合、または コンテキスト内の現在の画面名が Consent.screenIdentifier と一致しない場合にスローされます。

プロパティ

branding
client
organization
prompt
screen
ScreenOverride によって処理される、同意画面に固有の画面データとプロパティを保持します。これには、リクエストされている scopes のリストと、hideScopes フラグが含まれます。
tenant
transaction
untrustedData
user
screenIdentifier
string

メソッド

accept
Promise<void>
要求された権限を承認(付与)するというユーザーの決定を送信します。 このメソッドは、/u/consent?state=<transaction_state> エンドポイントに対して action: "accept" を指定したフォームデータを準備して送信します。 トランザクションの state は、URL のクエリパラメーターとフォームボディの両方に自動的に含まれます。フォーム送信が開始されると解決される Promise です。 通常、送信が成功するとサーバー側でリダイレクトが行われます。

例外

送信中に FormHandler が回復不能な問題 (例: ネットワークエラー)に遭遇した場合にエラーをスローします。 Auth0 からのサーバー側バリデーションエラー(“invalid_request” など)は JavaScript のエラーとしてスローされるのではなく、処理後に this.transaction.errors で参照できるようになります。
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleAccept = async () => {
 try {
   await consentManager.accept();
   console.log('Consent accepted successfully.');
 } catch (err) {
   console.error('Error accepting consent:', err);
 }
};
deny
Promise<void>
要求された権限を拒否するというユーザーの決定を送信します。 このメソッドは、/u/consent?state=<transaction_state> エンドポイントに対して action: "deny" を指定したフォームデータを準備して送信します。 トランザクションの state は、URL のクエリパラメーターとフォームボディの両方に自動的に含まれます。フォーム送信が開始されると解決される Promise です。 送信が成功すると、通常サーバー側でリダイレクトが行われます。

例外

FormHandler で問題(例: ネットワークエラー)が発生した場合にエラーをスローします。 サーバー側バリデーションエラーは this.transaction.errors に反映されます。
Example
import Consent from '@auth0/auth0-acul-js/consent';
const consentManager = new Consent();
const handleDeny = async () => {
 try {
   await consentManager.deny();
   console.log('Form denied successfully.');
 } catch (err) {
   console.error('Failed to deny form:', error);
 }
};

getErrors
コンテキストからトランザクションエラーの配列を取得します。存在しない場合は空の配列を返します。トランザクションコンテキストから取得されるエラーオブジェクトの配列です。