アクションのトリガー：ログイン後

Post-Login アクショントリガーの API オブジェクトには以下が含まれます。

`api.access`

ログイン試行の拒否などでユーザーのログインアクセスを修正します。

`api.access.deny(reason)`

現在のログイン試行を「拒否」としてマークします。これによりエンドユーザーがログインフローを完了できなくなります。ただし、このアクションから要求されたユーザー関連の他の副次的な影響（メタデータの変更など）はキャンセルしません。このアクションの完了後、ログインフローはすぐに停止し、以降のアクションは実行されません。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`reason`	文字列。ログインを拒否するための、人間が理解できる説明。これは`error_description`として要求を開始したアプリケーションに送信されます。

`api.accessToken`

発行されたアクセストークンを変更する要求。

`api.accessToken.setCustomClaim(name, value)`

ログインフローの完了に発行されるアクセストークンへのカスタムクレームを設定します。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`name`	文字列。クレームの名前（これは完全修飾URLが必要な場合があります）。
`value`	すべての値。クレームの値。

`api.accessToken.addScope(scope)`

ログインフローの完了に発行されるアクセストークンへのスコープを追加します。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`scope`	文字列追加するスコープ。

`api.accessToken.removeScope(scope)`

ログインフローの完了に発行されるアクセストークンへのスコープを削除します。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`scope`	文字列削除するスコープ。

`api.authentication`

現在のユーザーセッションの認証状態の変更を要求します。

`api.authentication.recordMethod(provider_url)`

現在のセッションで完了したカスタム認証メソッドを示します。このメソッドは、後続のログインのevent.authentication.methods配列で可能になります。重要：この API はPostLoginActions のonContinuePostLogin 機能でのみ可能です。言い換えると、これはapi.redirect.sendUserTo()を介してユーザーをリダイレクトした後、カスタム認証メソッドの完了を記録するために使用できます。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`provider_url`	文字列。完了したカスタム認証方法の IDを示すURL。

`api.authentication.challengeWith(factor, options)`

1 つ以上の指定された多要素認証の要素でユーザーチャレンジを行います。このメソッドは、まずデフォルトのオプションでチャレンジし、追加の要素が提供された場合にはユーザーが異なるオプションを選択できるようにします。ユーザーが、提供されたどの要素でも登録していない場合（デフォルトと追加要素の両方を含む）、コマンドは失敗します。注意：このメソッドは、テナント内で MFA を有効または無効にする既存のポリシーやルールを上書きします。

パラメーター説明

パラメーター	説明
`factor`	オブジェクト。`type`フィールドを含むオブジェクト。`type`は、デフォルトのMFA要素またはユーザーチャレンジに使用される要素を指定するために使用される文字列です。対応する値には次のものが含まれます： `otp` `recovery-code` `email` `push-notification` otpFallback``falseに設定されている場合、ユーザーはプッシュ通知ファクターのOTPフォールバックオプションを使用できません。 `phone` `preferredMethod: voice` `preferredMethod: sms` `preferredMethod: both` `webauthn-platform` `webauthn-roaming` 例 api.authentication.challengeWith({ type: 'phone', options: { preferredMethod: 'both'} });`
`options`	任意のオブジェクト。任意の`additionalFactors`フィールドを含むオブジェクト。 `additionalFactors` は、MFAチャレンジを完了する際にユーザーが選択できる他のファクターを指定するために使用される配列です。`type`フィールドと同じ値をサポートします。例 api.authentication.challengeWith({ type: 'otp' }, { additionalFactors: [{ type: 'push-notification' }, { type: 'phone' }] })`

factor

オブジェクト。typeフィールドを含むオブジェクト。typeは、デフォルトのMFA要素またはユーザーチャレンジに使用される要素を指定するために使用される文字列です。

対応する値には次のものが含まれます：

otp
recovery-code
email
push-notification

otpFallback``falseに設定されている場合、ユーザーはプッシュ通知ファクターのOTPフォールバックオプションを使用できません。

phone

preferredMethod: voice
preferredMethod: sms
preferredMethod: both

webauthn-platform
webauthn-roaming

例

api.authentication.challengeWith({ 
    type: 'phone', 
    options: { preferredMethod: 'both'} 
  });`

options

任意のオブジェクト。任意のadditionalFactorsフィールドを含むオブジェクト。

additionalFactors は、MFAチャレンジを完了する際にユーザーが選択できる他のファクターを指定するために使用される配列です。typeフィールドと同じ値をサポートします。

例

api.authentication.challengeWith({
    type: 'otp'
  }, {  
    additionalFactors: [{
      type: 'push-notification'
    }, {
      type: 'phone'
    }]
  })`

`api.authentication.challengeWithAny(factors)`

MFA チャレンジをトリガーし、ユーザーに提供されたリストから好みのファクターを選択させます。このメソッドは、次の条件に従って、ユーザーに特定のチャレンジではなく、ファクターピッカーを提示します：

複数のファクターが指定された場合、ファクターピッカーはユーザーに表示されます。
ユーザーが指定ファクターの 1 つでのみに登録されている場合（またはファクターが 1 つだけ指定されている場合）、ファクターピッカーはスキップされます。
ユーザーがどの指定ファクターでも登録していない場合、チャレンジコマンドは失敗します。

注意：このメソッドは、テナント内で MFA を有効または無効にする既存のポリシーやルールを上書きします。

パラメーター説明

パラメーター	説明
`factors`	配列。`type`フィールドを含むオブジェクトの配列。`type`はチャレンジされた際、MFAファクターを指定するために使用される文字列です。対応する値には次のものが含まれます： `otp` `recovery-code` `email` `push-notification` otpFallback``trueに設定されている場合、ユーザーはプッシュ通知ファクターのOTPフォールバックオプションを使用できません。 `phone` `preferredMethod: voice` `preferredMethod: sms` `preferredMethod: both` `webauthn-platform` `webauthn-roaming`

factors

配列。typeフィールドを含むオブジェクトの配列。typeはチャレンジされた際、MFAファクターを指定するために使用される文字列です。

対応する値には次のものが含まれます：

otp
recovery-code
email
push-notification

otpFallback``trueに設定されている場合、ユーザーはプッシュ通知ファクターのOTPフォールバックオプションを使用できません。

phone

preferredMethod: voice
preferredMethod: sms
preferredMethod: both

webauthn-platform
webauthn-roaming

`api.authentication.enrollWith(factor, options)`

ユーザーが特定の MFA ファクターで登録するようにします。このメソッドは、ユーザーがデフォルトのファクターで登録するように最初は促しますが、追加の要素が提供された場合にはユーザーが異なるオプションを任意で選択できるようにします。ユーザーが提供されたすべてのファクター（デフォルトの値と追加要素の両方を含む）で登録済みの場合には、コマンドは失敗します。注意：このメソッドは、テナント内で MFA を有効または無効にする既存のポリシーやルールを上書きします。

パラメーター説明

パラメーター	説明
`factor`	オブジェクト。`type`フィールドを含むオブジェクト。`type`は、ユーザーが登録の際に指示されるデフォルトのMFA要素を指定するために使用される文字列です。対応する値には次のものが含まれます： `otp` `recovery-code` `push-notification` `phone` `preferredMethod: voice` `preferredMethod: sms` `preferredMethod: both` `webauthn-platform` `webauthn-roaming`
`options`	任意のオブジェクト。任意の`additionalFactors`フィールドを含むオブジェクト。 `additionalFactors`は、ユーザーが登録の際に選択できる他のファクターを指定するために使用される配列です。`type`フィールドと同じ値をサポートします。例 api.authentication.enrollWith({ type: 'otp' }, { additionalFactors: [{ type: 'push-notification' }, { type: 'phone' }] })` 例 api.authentication.enrollWith({ type: 'otp' }, { additionalFactors: [{ type: 'push-notification' }, { type: 'phone' }] })`

factor

オブジェクト。typeフィールドを含むオブジェクト。typeは、ユーザーが登録の際に指示されるデフォルトのMFA要素を指定するために使用される文字列です。

対応する値には次のものが含まれます：

otp
recovery-code
push-notification
phone

preferredMethod: voice
preferredMethod: sms
preferredMethod: both

webauthn-platform
webauthn-roaming

options

任意のオブジェクト。任意のadditionalFactorsフィールドを含むオブジェクト。

additionalFactorsは、ユーザーが登録の際に選択できる他のファクターを指定するために使用される配列です。typeフィールドと同じ値をサポートします。

例

api.authentication.enrollWith({
    type: 'otp'
  }, {
    additionalFactors: [{
      type: 'push-notification'
    }, {
      type: 'phone'
    }]
  })`

例

api.authentication.enrollWith({
    type: 'otp'
  }, {
    additionalFactors: [{
      type: 'push-notification'
    }, {
      type: 'phone'
    }]
  })`

`api.authentication.enrollWithAny(factors)`

ユーザーに提示リストから登録に使う MFA ファクターを選択させます。このメソッドは、次の条件に従って、ユーザーにデフォルトのファクタープロンプトではなく、ファクターピッカーを提示します：

複数のファクターが指定された場合、ファクターピッカーがユーザーに表示されます。
ユーザーが 1 つを除く他のすべての提示ファクターで登録済みの場合は、ファクターピッカーはスキップされ、ユーザーは残りのファクターで登録するように促されます。
ユーザーが提供されたすべてのファクターで登録済みの場合には、コマンドは失敗します。

注意：このメソッドは、テナント内で MFA を有効または無効にする既存のポリシーやルールを上書きします。

パラメーター説明

パラメーター	説明
`factors`	配列。`type`フィールドを含むオブジェクトの配列。`type`は、ユーザーが登録の際に指示されるデフォルトのMFA要素を指定するために使用される文字列です。対応する値には次のものが含まれます： `otp` `recovery-code` `push-notification` `phone` `preferredMethod: voice` `preferredMethod: sms` `preferredMethod: both` `webauthn-platform` `webauthn-roaming`

factors

配列。typeフィールドを含むオブジェクトの配列。typeは、ユーザーが登録の際に指示されるデフォルトのMFA要素を指定するために使用される文字列です。

対応する値には次のものが含まれます：

otp
recovery-code
push-notification
phone

preferredMethod: voice
preferredMethod: sms
preferredMethod: both

webauthn-platform
webauthn-roaming

`api.authentication.setPrimaryUser(primary_user_id)`

ログイントランザクションのプライマリユーザーを変更します。ユーザー連携を必要とするシナリオでは、ログインを始めるために使用するユーザー ID は、もはや個別のユーザーとして存在しないことがあります。そのような ID は既存ユーザーのセカンダリアイデンティティーになります。そのような状況では、setPrimaryUser()関数を使用して、ログインの対象を変更することができます。重要：

セキュリティの脆弱性をもたらすことなくアカウントをリンクすることで、悪意のあるアクターが正当なユーザーアカウントにアクセスできるようになる可能性があります。したがって、テナントはリンクが行われる前に両方のアカウントの認証を要求すべきです。
ログインの認証に使用される ID は、primary_user_idで参照されるユーザーのセカンダリ ID の中に含まれている必要があります。ログインは失敗し、その結果トークンは発行されません。

パラメーター	説明
`primary_user_id`	文字列。トークンが発行される（`sub`クレーム）べきユーザーのユーザーID。

`api.cache`

実行間で維持されるデータの保管と取得を行います。

`api.cache.delete(key)`

提供された key にキャッシュ済みの値が存在する場合は、それを記述したレコードを削除します。値がキャッシュから削除されると、CacheWriteResultオブジェクトにtype: "success"を含めて返します。操作に失敗すると、type: "error"を返します。エラーの場合には、返すオブジェクトにcodeプロパティを含めて、失敗の詳細を示します。

パラメーター	説明
`key`	文字列。キャッシュに保管されているレコードのキー。

`api.cache.get(key)`

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを取得します。レコードが見つかった場合には、返されたオブジェクトのvalueプロパティにキャッシュ済みの値があります。提供されたkeyにキャッシュ済みの項目が存在する場合は、それを記述したレコードを返します。キャッシュレコードは、キャッシュされた値のあるvalueプロパティと、レコードの最大有効期限を UNIX エポックからのミリ秒単位で示すexpires_atプロパティを含むオブジェクトです。 重要： このキャッシュは、短命で一時的なデータ向けに設計されています。項目が所定のライフタイム内であったとしても、後のトランザクションでは利用できないかもしれません。

パラメーター	説明
`key`	文字列。キャッシュに保管されているレコードのキー。

`api.cache.set(key, value, [options])`

指定された key のキャッシュに文字列値を保管または更新します。このキャッシュに保管された値は、それを設定するトリガーにスコープが限定されます。これはアクションのキャッシュ制限の対象になります。このように保管された値には、指定されたttlまたはexpires_at値までのライフタイムがあります。ライフタイムが指定されない場合には、デフォルトのライフタイムである 15 分が使用されます。ライフタイムはアクションのキャッシュ制限が定める最大値を超過してはいけません。値の保存に成功すると、CacheWriteSuccessを返します。成功しなかった場合はCacheWriteErrorを受け取ります。

パラメーター	説明
`key`	文字列。キャッシュに保管されているレコードのキー。
`value`	文字列。保管するレコードの値。
`options`	任意のオブジェクト。キャッシュの動作を調整するためのオプション。
`options.expires_at`	任意の数値。UNIXエポックからのミリ秒単位で指定した絶対有効期限です。キャッシュ済みのレコードは早期に削除されることはあっても、`expires_at`で指定された時点を過ぎて存続することはありません。注意：この値が`ttl`で指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。
`options.ttl`	任意の数値。このキャッシュエントリーのミリ秒単位で指定した存続時間。キャッシュ済みのレコードは早期に削除されることはあっても、`ttl`で指定された時点を過ぎて存続することはありません。注意：この値が`expires_at`で指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。

`api.idToken`

発行された ID トークンを変更する要求。

`api.idToken.setCustomClaim(name, value)`

ログインフローの完了時に発行される ID トークンへのカスタムクレームを設定します。 apiオブジェクトへの参照を返します。

パラメーター	説明
`name`	文字列。クレームの名前（これは完全修飾URLが必要な場合があります）。
`value`	任意の値。クレームの値。

`api.multifactor`

ログイン試行でも多要素認証のための要件を設定します。

`api.multifactor.enable(provider, options)`

このログインフローの多要素認証を有効にします。有効にした場合、ユーザーは設定された多要素認証チャレンジを完了する必要があります。実際の多要素認証チャレンジは、ログインフローの終了時に延期されます。 apiオブジェクトにリファレンスを返します。

パラメーター	説明
`provider`	文字列。使用する多要素認証プロバイダーの名前、または`any`の値を使用して、構成されたプロバイダーのいずれかを使用します。次の値に対応しています。 `any`任意の設定されたチャレンジを使用します。 `duo`Duo多要素認証プロバイダーを使用します。 `google-authenticator`Google Authenticatorプロバイダーを使用します。 `guardian`Guardianプロバイダーを使用します。 `none`MFAフローのトリガーを防ぐために設定されたチャレンジを使用しません。
`options`	任意のオブジェクト。多要素認証チャレンジを有効にする追加のオプション。
`options.allowRememberBrowser`	任意のブール値。プロバイダーが`google-authenticator`または`duo`に設定されている場合、ユーザーは30日ごとにMFAを促されます。プロバイダーが`guardian`に設定されている場合、MFAプロンプトが登録チェックボックスを表示して、ユーザーに登録するかしないかを選択させます。デフォルトは`false`です。詳細はこちらをご覧ください：多要素認証ページをカスタマイズする
`options.providerOptions`	任意のオブジェクト。チャレンジを設定する追加オプションで、`duo`プロバイダーに使用可能です。対応オプションは次の通りです： `host` 文字列。これはDuoアカウントのAPIホスト名の値です。 `ikey` 文字列。これはDuoアカウントからのクライアントID（旧Integration key（統合キー））値です。 `skey` 文字列。これはDuoアカウントからのクライアントID（旧Secret key（シークレットキー））です。 `username` 任意の文字列。DuoSecurityのユーザー名として、いくつかのプロファイル属性を使用します。またこれは、Duoに登録されたユーザーを持っている場合に便利です。

`api.user`

ログインしているユーザーのメタデータに対してアプリケーション固有の変更を行います。注意： これらのメソッドを呼び出しても、即座にメタデータのアップデートは行われません 。同じフローの複数アクションから複数回呼び出すことができます。またエンジンは変更を集約し、 フローが完了する前にメタデータを一度に更新します 。

`api.user.setAppMetadata(name, value)`

ログインしているユーザーに対してアプリケーションメタデータを設定します。app_metadata に保存されたデータは、ユーザーが編集することはできません。注意：このトリガーは Management API を呼び出し、Management API レート制限を消費します。この要求がレート制限に達し、タイムアウト制限時間内に再試行できなかった場合は、Deadline Exceededエラーを受け取ります。 apiオブジェクトへの参照を返します。

パラメーター	説明
`name`	文字列。メタデータプロパティの名前。
`value`	任意の値。メタデータプロパティの値。メタデータプロパティを削除するために`null`に設定されていることがあります。

`api.user.setUserMetadata(name, value)`

ログインしているユーザーの一般メタデータを設定します。注意：このトリガーは Management API を呼び出し、Management API レート制限を消費します。この要求がレート制限に達し、タイムアウト制限時間内に再試行できなかった場合は、Deadline Exceededエラーを受け取ります。 apiオブジェクトへの参照を返します。

パラメーター	説明
`name`	文字列。メタデータプロパティの名前。
`value`	任意の値。メタデータプロパティの値。メタデータプロパティを削除するために`null`に設定されていることがあります。

`api.redirect`

`api.redirect.encodeToken(options)`

リダイレクト先（sendUserTo経由）のクエリ文字列パラメーターとして使用可能で、信頼性を対象のエンドポイントで証明可能なデータを含むセッショントークンを作成します。対象のエンドポイントは共有シークレットで JWT の署名を確認して、信頼性とデータの整合性を検証できます。 JWT 文字列を返します。

パラメーター	説明
`options`	オプション。結果のURLのクエリパラメーターに機密データをどのように暗号化するのかを構成します。
`options.expiresInSeconds`	数値。トークンが期限切れになるまでの秒数（デフォルトは900）。
`options.payload`	オプション。リダイレクト先に渡され、信頼性と整合性が証明可能であるべきデータ。
`options.secret`	文字列。リダイレクト先と共有され、JWTの署名に使用されるシークレット。シークレット値はシークレットとして保管され、`event.secrets['SECRET_NAME']`を使用して取得されなければなりません。

`api.redirect.sendUserTo(url, options)`

アクションが完了した直後に、ブラウザーを目的のurlにリダイレクトさせます。 apiオブジェクトへの参照を返します。

パラメーター	説明
`url`	文字列。リダイレクト先のURL。
`options`	オプション。リダイレクトURLに追加される任意のクエリ文字列パラメーターを表すオブジェクト。
`options.query`	オプション。リダイレクトURLに追加する追加のクエリ文字列パラメーター。

`api.redirect.validateToken(options)`

JWT トークンに含めて/continueエンドポイントに渡された暗号化済みのデータを取得すると同時に、そのデータの信頼性と整合性を検証します。 JWT トークンのペイロードを返します。

パラメーター	説明
`options`	オプション。リダイレクト後に、JWTトークンに含めて`/continue`エンドポイントに渡された暗号化済みのデータを取得するためのオプション。
`options.secret`	文字列。トークンの暗号化に使用されたシークレット。
`options.tokenParameterName`	文字列。`/continue`エンドポイントに送信されたクエリまたは本文のパラメーターの名前。デフォルト：`session_token`

`api.rules`

現在のトランザクション中に実行したルールについての情報を取得します。

`api.rules.wasExecuted(ruleId)`

現在のトランザクションにおけるこのアクションの前に特定のルールが実行されたかを確認します。アクションへの移行中に「そのルールからこのアクションに移行する」ロジックが重複して実行されることを防ぐために使用できます。このメソッドでは、指定した ID のルールがこのトランザクションで実行されたことがある場合にはtrueが返され、そうでなかった場合はfalseが返されます。

パラメーター	説明
`ruleId`	文字列。確認するルールID。

`api.samlResponse`

ログインしているユーザーの SAML 応答を修正します。

`api.samlResponse.setAttribute(attribute, value)`

カスタムの SAML 属性を設定します。失敗した操作は、Errorをスローします。エラーについて、返されたオブジェクトは、失敗の性質を示すメッセージを持ちます。値は、SAMLValueタイプでなければならず、次のものが可能です。 string | number | boolean | null | Array

パラメーター	説明
`attribute`	文字列。設定されるSAML属性。
`value`	SAMLValue 。SAMLアサーションの値。属性プロパティを削除するために`null`に設定されていることがあります。

`api.samlResponse.setAudience(audience)`

SAML 応答のオーディエンスを変更します。デフォルトは、SAMLRequest の発行者です。

パラメーター	説明
`audience`	文字列。設定されるSAMLオーディエンス。

`api.samlResponse.setEncryptionPublicKey(publicKey)`

SAML アサーションの暗号化に使用される公開鍵を任意に指定します。公開鍵はサービスプロバイダーから取得されるべきです。公開鍵と証明書の両方が指定される必要があります。

パラメーター	説明
`publicKey`	文字列。設定される公開鍵です。

`api.samlResponse.setRecipient(recipient)`

SAML アサーションの受信者を変更します（SubjectConfirmationData）。デフォルトは、SAMLRequestのAssertionConsumerUrlまたは SAMLRequest が送られなかった場合は Callback URL です。

パラメーター	説明
`recipient`	文字列。設定されるSAML受信者です。

`api.samlResponse.setCreateUpnClaim(createUpnClaim)`

UPN クレームが作成されるべきかどうかを指示します。デフォルトはtrueです。

パラメーター	説明
`createUpnClaim`	ブール値切り替えて、UPNクレームを作成します。

`api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)`

trueの場合（デフォルト）、共通プロファイルにマッピングされていない各クレームは、Auth0 がそれらを通じて出力アサーションに渡します。falseの場合、それらのクレームはマップされません。

パラメーター	説明
`passthroughClaimsWithNoMapping`	ブール値クレームを出力アサーションにマッピングするかどうかを指定します。

`api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)`

passthroughClaimsWithNoMappingがtrueで、これがfalseの場合（デフォルト）、共通プロファイルにマッピングされていない各クレームは、Auth0 がプレフィックス（http://schema.auth0.com）を追加します。`true`の場合、クレームをそのままパススルーします。

パラメーター	説明
`mapUnknownClaimsAsIs`	ブール値クレームをそのままマッピングするかどうか。

`api.samlResponse.setMapIdentities(mapIdentities)`

trueの場合（デフォルト）、これによりプロバイダー（Google、ADFS、AD など）や、利用可能な場合アクセストークンなどの追加情報がトークンに付け足されます

パラメーター	説明
`mapIdentities`	ブール値IDをマッピングするかどうか。

`api.samlResponse.setDestination(destination)`

SAML 応答の宛先。指定されていない場合、SAMLRequest の AsserionConsumerUrl になり、SAMLRequest がない場合は、Callback URL になります。

パラメーター	説明
`destination`	文字列SAML応答の宛先。

`api.samlResponse.setLifetimeInSeconds(lifetimeInSeconds)`

トークンの有効期限（秒）。デフォルトでは3600秒（1 時間）です。

パラメーター	説明
`lifetimeInSeconds`	数字トークンの有効期限（秒）。

`api.samlResponse.setSignResponse(signResponse)`

SAML 応答が署名されるべきかどうか。デフォルトでは、SAML アサーションは署名されますが、SAML 応答は署名されません。trueの場合、SAML アサーションではなく SAML 応答が署名されます。デフォルトはfalseです。

パラメーター	説明
`signResponse`	ブール値SAML応答が署名されるべきかどうか。

`api.samlResponse.setNameIdentifierFormat(nameIdentifierFormat)`

名前 ID 形式を設定します。デフォルトはurn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedです。

パラメーター	説明
`nameIdentifierFormat`	文字列名前IDの形式

`api.samlResponse.setNameIdentifierProbes(nameIdentifierProbes)`

Auth0 はこの配列の各属性に順番に名前を付けようとします。その一つが値を持つ場合は、それを件名/名前 ID に使用します。順序：

http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier （user_idからマッピング）
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress（ emailからマッピング）
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name （ nameからマッピング）

パラメーター	説明
`nameIdentifierProbes`	文字の配列名前識別子を取得するために試す属性の配列。

`api.samlResponse.setAuthnContextClassRef(authnContextClassRef)`

デフォルトはurn:oasis:names:tc:SAML:2.0:ac:classes:unspecifiedです。

パラメーター	説明
`authnContextClassRef`	文字列AuthnContextClassRef。

`api.samlResponse.setSigningCert(signingCert)`

SAML 要求の検証に使用される公開鍵証明書を任意に示します。設定された場合、SAML 要求の署名が必要になります。サンプル値は次のようになります：

"-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END CERTIFICATE-----\n"

パラメーター	説明
`signingCert`	文字列SAML要求の検証に使用される任意の公開鍵証明書。

`api.samlResponse.setIncludeAttributeNameFormat(includeAttributeNameFormat)`

trueに設定された場合、属性名に基づいた NameFormat を推測します。NameFormat 値は次の通りです： urn:oasis:names:tc:SAML:2.0:attrname-format:uri、 urn:oasis:names:tc:SAML:2.0:attrname-format:basic、 urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified。 falseに設定された場合、属性 NameFormat はアサーションに設定されません。デフォルトはtrueです。

パラメーター	説明
`includeAttributeNameFormat`	ブール値NameFormatは属性名に基づいて推測するべきかどうか。

`api.samlResponse.setTypedAttributes(typedAttributes)`

trueに設定された場合、要素のxs:typeを推測します。型は、xs:string、xs:boolean、xs:double、xs:anyTypeです。falseに設定された場合、すべてのxs:typeはxs:anyTypeになります。デフォルトはtrueです。

パラメーター	説明
`typedAttributes`	ブール値`xs:type`が推測されるべきかどうか。

`api.samlResponse.setEncryptionCert(encryptionCert)`

SAML アサーションの暗号化に使用される証明書を任意に指定します。証明書はサービスプロバイダーから取得されるべきです。証明書と公開鍵の両方が指定される必要があります。サンプル値は次のようになります：

"-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END CERTIFICATE-----\n"

パラメーター	説明
`encryptionCert`	文字列SAMLアサーションの暗号化に使用される任意の証明書。

`api.samlResponse.setCert(cert)`

デフォルトでは、Auth0 は SAML 応答やアサーションに署名するためのテナントに割り当てられた秘密鍵/公開鍵のペアを使用します。非常に特殊な場合、独自の証明書と秘密鍵を提供することが望ましいかもしれません。証明書と秘密鍵の両方が指定される必要があります。サンプル値は次のようになります：

"-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END CERTIFICATE-----\n"

パラメーター	説明
`cert`	文字列SAML応答またはアサーションに署名する任意の証明書。

`api.samlResponse.setKey(key)`

デフォルトでは、Auth0 は SAML 応答やアサーションに署名するためのテナントに割り当てられた秘密鍵/公開鍵のペアを使用します。非常に特殊な場合、独自の証明書と秘密鍵を提供することが望ましいかもしれません。この秘密鍵は機密であるため、 ［Actions のシークレット機能を追加する］ を使用することをおすすめします。詳細はこちらから：最初のアクションを書く証明書と秘密鍵の両方が指定される必要があります。サンプル値は次のようになります：

"-----BEGIN PRIVATE KEY-----\nnMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END PRIVATE KEY-----\n"

パラメーター	説明
`key`	文字列SAML応答またはアサーションに署名する任意の秘密鍵。

`api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`

廃止：デフォルトはrsa-sha256

ですパラメーター	説明
`signatureAlgorithm`	`rsa-sha256` \| `rsa-sha1`。 `rsa-sha1`は使用すべきではありません。安全性に問題があります。

`api.samlResponse.setDigestAlgorithm(digestAlgorithm)`

廃止：デフォルトはsha256 です。

パラメーター	説明
`digestAlgorithm`	`sha256` \| `sha1`。 `rsa-sha1`は使用すべきではありません。安全性に問題があります。

`api.session`

ユーザーセッションの取り消しなどでセッションを管理します。

`api.session.revoke(reason, options)`

現在のトランザクションを拒否し、セッションを取り消し、関連するリフレッシュトークンを削除します。ユーザーはフローを完了できなくなり、それ以降のアクションは実行されません。注意この方法はセッション取り消しのOIDC Back-Channel Logout Initiator（OIDC バックチャネルログアウトイニシエーター）を開始し、現在のセッションと関係するすべてのアプリケーションからユーザーをログアウトさせます。リフレッシュトークンに関連するセッションの削除は非同期の処理です。 apiオブジェクトにリファレンスを返します。

パラメーター説明

パラメーター	説明
`reason`	文字列。ログインを拒否するための、人間が理解できる説明。これはerror_descriptionとして要求を開始したアプリケーションに送信されます。
`options`	preserveRefreshTokens。ブール値で、取り消し後も同じsession_idのセッションに結びついたリフレッシュトークンが保存されるかを特定するために使われます。デフォルトはfalseです。例 api.session.revoke('reason', {'preserveRefreshTokens':true} );`

reason

文字列。ログインを拒否するための、人間が理解できる説明。これはerror_descriptionとして要求を開始したアプリケーションに送信されます。

options

preserveRefreshTokens。ブール値で、取り消し後も同じsession_idのセッションに結びついたリフレッシュトークンが保存されるかを特定するために使われます。デフォルトはfalseです。

例

  api.session.revoke('reason', 
             {'preserveRefreshTokens':true} );`

`api.refreshToken`

リフレッシュトークンの取り消しなどによってリフレッシュトークンを管理します。

`api.refreshToken.revoke(reason)`

現在のトークン交換を拒否し、リフレッシュトークンを取り消します。これによりユーザーはフローを完了できなくなり、それ以降のアクションは実行されません。 apiオブジェクトに参照を返します。

パラメーター	説明
`reason`	文字列。リフレッシュトークンを拒否するための、人間が理解できる説明。これはerror_descriptionとして要求を開始したアプリケーションに送信されます。

ブランドのカスタマイズ

コードのカスタマイズ

サードパーティーのカスタマイズ

​api.access

​api.access.deny(reason)

​api.accessToken

​api.accessToken.setCustomClaim(name, value)

​api.accessToken.addScope(scope)

​api.accessToken.removeScope(scope)

​api.authentication

​api.authentication.recordMethod(provider_url)

​api.authentication.challengeWith(factor, options)

​api.authentication.challengeWithAny(factors)

​api.authentication.enrollWith(factor, options)

​api.authentication.enrollWithAny(factors)

​api.authentication.setPrimaryUser(primary_user_id)

​api.cache

​api.cache.delete(key)

​api.cache.get(key)

​api.cache.set(key, value, [options])

​api.idToken

​api.idToken.setCustomClaim(name, value)

​api.multifactor

​api.multifactor.enable(provider, options)

​api.user

​api.user.setAppMetadata(name, value)

​api.user.setUserMetadata(name, value)

​api.redirect

​api.redirect.encodeToken(options)

​api.redirect.sendUserTo(url, options)

​api.redirect.validateToken(options)

​api.rules

​api.rules.wasExecuted(ruleId)

​api.samlResponse

​api.samlResponse.setAttribute(attribute, value)

​api.samlResponse.setAudience(audience)

​api.samlResponse.setEncryptionPublicKey(publicKey)

​api.samlResponse.setRecipient(recipient)

​api.samlResponse.setCreateUpnClaim(createUpnClaim)

​api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)

​api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)

​api.samlResponse.setMapIdentities(mapIdentities)

​api.samlResponse.setDestination(destination)

​api.samlResponse.setLifetimeInSeconds(lifetimeInSeconds)

​api.samlResponse.setSignResponse(signResponse)

​api.samlResponse.setNameIdentifierFormat(nameIdentifierFormat)

​api.samlResponse.setNameIdentifierProbes(nameIdentifierProbes)

​api.samlResponse.setAuthnContextClassRef(authnContextClassRef)

​api.samlResponse.setSigningCert(signingCert)

​api.samlResponse.setIncludeAttributeNameFormat(includeAttributeNameFormat)

​api.samlResponse.setTypedAttributes(typedAttributes)

​api.samlResponse.setEncryptionCert(encryptionCert)

​api.samlResponse.setCert(cert)

​api.samlResponse.setKey(key)

​api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)

​api.samlResponse.setDigestAlgorithm(digestAlgorithm)

​api.session

​api.session.revoke(reason, options)

​api.refreshToken

​api.refreshToken.revoke(reason)

`api.access`

`api.access.deny(reason)`

`api.accessToken`

`api.accessToken.setCustomClaim(name, value)`

`api.accessToken.addScope(scope)`

`api.accessToken.removeScope(scope)`

`api.authentication`

`api.authentication.recordMethod(provider_url)`

`api.authentication.challengeWith(factor, options)`

`api.authentication.challengeWithAny(factors)`

`api.authentication.enrollWith(factor, options)`

`api.authentication.enrollWithAny(factors)`

`api.authentication.setPrimaryUser(primary_user_id)`

`api.cache`

`api.cache.delete(key)`

`api.cache.get(key)`

`api.cache.set(key, value, [options])`

`api.idToken`

`api.idToken.setCustomClaim(name, value)`

`api.multifactor`

`api.multifactor.enable(provider, options)`

`api.user`

`api.user.setAppMetadata(name, value)`

`api.user.setUserMetadata(name, value)`

`api.redirect`

`api.redirect.encodeToken(options)`

`api.redirect.sendUserTo(url, options)`

`api.redirect.validateToken(options)`

`api.rules`

`api.rules.wasExecuted(ruleId)`

`api.samlResponse`

`api.samlResponse.setAttribute(attribute, value)`

`api.samlResponse.setAudience(audience)`

`api.samlResponse.setEncryptionPublicKey(publicKey)`

`api.samlResponse.setRecipient(recipient)`

`api.samlResponse.setCreateUpnClaim(createUpnClaim)`

`api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)`

`api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)`

`api.samlResponse.setMapIdentities(mapIdentities)`

`api.samlResponse.setDestination(destination)`

`api.samlResponse.setLifetimeInSeconds(lifetimeInSeconds)`

`api.samlResponse.setSignResponse(signResponse)`

`api.samlResponse.setNameIdentifierFormat(nameIdentifierFormat)`

`api.samlResponse.setNameIdentifierProbes(nameIdentifierProbes)`

`api.samlResponse.setAuthnContextClassRef(authnContextClassRef)`

`api.samlResponse.setSigningCert(signingCert)`

`api.samlResponse.setIncludeAttributeNameFormat(includeAttributeNameFormat)`

`api.samlResponse.setTypedAttributes(typedAttributes)`

`api.samlResponse.setEncryptionCert(encryptionCert)`

`api.samlResponse.setCert(cert)`

`api.samlResponse.setKey(key)`

`api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`

`api.samlResponse.setDigestAlgorithm(digestAlgorithm)`

`api.session`

`api.session.revoke(reason, options)`

`api.refreshToken`

`api.refreshToken.revoke(reason)`