Actions トリガー: post-login - API オブジェクト

post-login Actions トリガーの API オブジェクトには、次のものが含まれます。

`api.access`

ログインしようとしているユーザーのアクセスを制御します。たとえば、ログイン試行を拒否できます。

`api.access.deny(reason)`

現在のログイン試行を拒否としてマークします。これにより、エンドユーザーはログインフローを完了できなくなります。これは、この Action によって要求されたほかのユーザー関連の副作用 (メタデータの変更など) を 取り消すものではありません。この Action の完了後、ログインフローは直ちに停止し、それ以降の Actions は実行されません。

string

ログインを拒否する理由を、人が読める形で説明する文字列です。これはエンドユーザー向けインターフェイスに直接表示される場合があります。

`api.accessToken`

発行されるアクセストークンの変更をリクエストします。

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

ログインフローの完了時に発行されるアクセストークンに、カスタムクレームを設定します。

string

クレームの名前 (完全修飾URLの指定が必要になる場合があります) 。

unknown

クレームの値。

`api.accessToken.addScope(scope)`

ログインフローの完了時に発行されるアクセストークンに、スコープを追加します。

string

追加するスコープです。

`api.accessToken.removeScope(scope)`

ログインフローの完了時に発行されるアクセストークンから、スコープを削除します。

string

削除するスコープ。

`api.authentication`

現在のユーザーセッションの認証状態の変更をリクエストします。

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

指定した認証要素と、必要に応じて追加の認証要素を使用して、多要素認証のチャレンジを要求します。多要素チャレンジが要求されると、そのチャレンジがユーザーによって完了されるまで、後続の Actions は実行されません。ユーザーは、次のいずれかの場合にチャレンジ要件を満たしたことになります。

デフォルトの認証要素に対するチャレンジを正常に完了した場合。
additionalFactors で指定された追加認証要素のいずれかに対するチャレンジを正常に完了した場合。

要求された認証要素のいずれかが現在のトランザクションですでに正常にチャレンジされている場合、その認証要素は無視されます。要求された認証要素がテナントで有効になっていない場合は無視されます。要求された認証要素にユーザーが登録していない場合も無視されます。要求された認証要素のいずれも有効化または登録されていない場合、認証トランザクションは失敗します (つまり、ログインは完了しません) 。

ユーザーがまだチャレンジ要件を満たしていない場合、このメソッドにより認証要素のチャレンジ画面が表示されます。 additionalFactors が指定されている場合、ユーザーは必要に応じて別の認証要素を選択できます。

factorselector

初回のチャレンジに使用する認証要素の種類とそのオプションを記述するオブジェクトです。

非表示認証要素のプロパティ

string

push-notification、phone、email、otp、webauthn-roaming、webauthn-platform、recovery-code などの認証要素の種類です。使用可能な値: otp, email, webauthn-platform, webauthn-roaming, recovery-code

dictionary

optional

指定した種類の認証要素を設定するための追加オプションです。

challengewithoptions

optional

追加オプションです。プロパティとして additionalFactors を指定することもできます。認証要素固有のオプション (たとえば push-notification の otpFallback) は factor.options に指定します。

非表示 options のプロパティ

array of objects

optional

Challenge with a specific factor

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

Challenge with additional factors

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

Challenge with push notification and disable OTP fallback

api.authentication.challengeWith({
  type: 'push-notification',
  options: { otpFallback: false }
});

`api.authentication.challengeWithAny(factors)`

指定したいずれかの認証要素を使用して、多要素認証のチャレンジを要求します (最初に認証要素の選択画面が表示されます) 。多要素認証のチャレンジが要求されると、ユーザーがそのチャレンジを完了するまで、後続の Actions は実行されません。ユーザーは、次のいずれかの状況でチャレンジを満たしたことになります。

いずれかの認証要素でチャレンジを正常に完了した場合。

要求された認証要素のいずれかが現在のトランザクションですでに正常にチャレンジされている場合、その認証要素は無視されます。要求された認証要素がテナントで有効になっていない場合、その認証要素は無視されます。ユーザーが登録していない認証要素が要求された場合も、その認証要素は無視されます。要求された認証要素のいずれも有効でも登録済みでもない場合、認証トランザクションは失敗します (つまり、ログインは完了しません) 。

このメソッドでは、ユーザーがまだチャレンジの要件を満たしていない場合、認証要素の選択画面が表示されます。優先する認証要素がある場合は、api.authentication.challengeWith() メソッドを使用することを推奨します。渡される認証要素が 1 つだけの場合、または有効な認証要素が 1 つだけの場合は、認証要素の選択画面は表示されません。

array of objects

認証要素の配列。

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

指定した認証要素と、必要に応じて追加の認証要素を使用して、多要素認証の登録をリクエストします。多要素認証の登録がリクエストされると、その登録がユーザーによって完了されるまで、後続の Actions は実行されません。リクエストされた認証要素のいずれかが、現在のトランザクションですでに正常に登録またはチャレンジされている場合、その認証要素は無視されます。テナントで有効になっていない認証要素がリクエストされた場合、その認証要素は無視されます。ユーザーがすでに登録済みの認証要素がリクエストされた場合、その認証要素は無視されます。リクエストされた認証要素のいずれも有効かつ未登録でない場合、認証トランザクションは失敗します (つまり、ログインは完了しません) 。

enrollmentfactorselector

初回の登録プロンプトで使用する認証要素の種類と、そのオプションを記述するオブジェクトです。

非表示 factor のプロパティ

string

push-notification、phone、otp、webauthn-roaming、webauthn-platform、recovery-code などの認証要素の種類です。指定可能な値:

otp
webauthn-platform
webauthn-roaming
recovery-code
push
push-notification

dictionary

optional

指定した種類の認証要素を設定するための追加オプションです。

enrollwithoptions

optional

additionalFactors をプロパティとして指定することもできる追加オプションです。

非表示 options のプロパティ

array of objects

optional

Enroll with additional factors

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

`api.authentication.enrollWithAny(factors)`

指定された認証要素のいずれかを使用して、多要素認証の登録をリクエストします (最初に認証要素の選択画面が表示されます) 。多要素認証の登録がリクエストされると、その登録がユーザーによって完了されるまで、後続の Actions は実行されません。リクエストされた認証要素のいずれかが現在のトランザクションですでに正常に登録されている場合、その認証要素は無視されます。テナントで有効になっていない認証要素がリクエストされた場合、その認証要素は無視されます。ユーザーがすでに登録している認証要素がリクエストされた場合、その認証要素は無視されます。リクエストされた認証要素のいずれも有効かつ未登録でない場合、認証トランザクションは失敗します (つまり、ログインは完了しません) 。

優先する認証要素がある場合は、api.authentication.enrollWith() メソッドの使用を推奨します。渡される認証要素が 1 つだけの場合、または有効な認証要素が 1 つだけの場合、認証要素の選択画面は表示されません。

array of objects

追加の認証要素の配列。

`api.authentication.recordMethod(provider_url)`

現在のセッションで、カスタム認証方式が完了したことを示します。この方式は、以降のログイン時に event.authentication.methods 配列で参照できるようになります。重要: この API は、PostLogin Actions の onContinuePostLogin 関数内でのみ使用できます。つまり、api.redirect.sendUserTo() を使用してユーザーをリダイレクトした後に、カスタム認証方式の完了を記録するために使用できます。

string

完了した認証方式を一意に表す http: または https: の URL。

`api.authentication.setPrimaryUser(primary_user_id)`

ログイントランザクションのプライマリユーザーを変更します。ユーザーのリンクが必要なシナリオでは、ログインの開始に使用されたユーザー ID が、独立したユーザーとしては存在しなくなる場合があります。その ID は、既存のユーザーのセカンダリ ID になっている可能性があります。このような場合は、setPrimaryUser() 関数を使用して、ログインの対象を変更する必要があることを示せます。 IMPORTANT: 安全でない方法でアカウントをリンクすると、悪意のある攻撃者が正当なユーザーアカウントにアクセスできる可能性があります。 IMPORTANT: ログインの認証に使用された ID は、primary_user_id で参照されるユーザーのセカンダリ ID の 1 つに 含まれている必要があります。そうでない場合、ログインは失敗し、トークンは発行されません。

string

トークンを発行するユーザーのユーザー ID (sub クレーム) 。

`api.idToken`

発行されるIDトークンの変更をリクエストします。

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

ログインフローの完了時に発行されるIDトークンに、カスタムクレームを設定します。

string

クレームの名前 (完全修飾URLが必要になる場合がある点に注意してください) 。

unknown

クレームの値。

`api.multifactor`

ログイン試行で多要素認証を必須に設定するか、その要件を解除します。

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

このログインフローで多要素認証を有効にします。有効にすると、ユーザーは設定された多要素認証チャレンジを完了する必要があります。実際の多要素認証チャレンジは、ログインフローの最後に実行されます。

string

使用する多要素認証プロバイダーの名前、または設定済みのいずれかのプロバイダーを使用する場合は "any" を指定します。指定可能な値: duo, none, guardian, google-authenticator, any

object

optional

多要素認証チャレンジを有効にするための追加オプションです。

非表示 options のプロパティ

boolean

optional

provider が google-authenticator または duo に設定されている場合、ユーザーには 30 日に 1 回 MFA が要求されます。provider が guardian に設定されている場合、 MFA プロンプトには、登録するかどうかをユーザーが選択できる登録用チェックボックスが表示されます。デフォルトは false です。詳しくは、 Customize Multi-Factor Authentication Pages を参照してください。

object

optional

チャレンジを設定するための追加オプションです。duo プロバイダーでのみ使用できます。

`api.redirect`

外部リダイレクトを設定し、開始します。

`api.redirect.encodeToken(options)`

クエリ文字列パラメーターのリダイレクト先 (sendUserTo 経由) として使用できるセッショントークンを作成します。このトークンには、リダイレクト先エンドポイントで真正性を検証できる必要があるデータが含まれます。対象エンドポイントは、共有シークレットを使用して JWT の署名を検証することで、データの真正性と完全性を確認できます。共有シークレットは Action の secret として保存し、event.secrets['<secret_name>'] から参照できるようにする必要があります。

tokencreationoptions

生成される URL のクエリパラメーターに機密データをどのようにエンコードするかを設定します。

非表示 options のプロパティ

number

optional

このトークンの有効期限が切れるまでの秒数

dictionary

リダイレクト先に渡すことを目的としたデータで、その真正性と完全性を検証できる必要があります。

string

リダイレクト先と共有する JWT の署名に使用するシークレットです。シークレット値は secret として保存し、event.secrets['<secret_name>'] を使用して取得する必要があります。

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

この Action の完了直後に、ログインパイプラインで対象の url へのブラウザーリダイレクトを直ちにトリガーします。createUrl ヘルパーメソッドは、対象の url のクエリパラメーターとしてデータをエンコードする処理を簡略化するために用意されています。これにより、そのデータの真正性と完全性を対象エンドポイントで検証できます。

string

sendusertooptions

optional

非表示 options のプロパティ

dictionary

optional

リダイレクト URL に追加するクエリ文字列パラメーターを表すオブジェクトです。

`api.redirect.validateToken(options)`

データの真正性と完全性を検証しながら、/continue エンドポイントに渡された JWT トークンにエンコードされたデータを取得します。

validatesessiontokenoptions

リダイレクト後に /continue エンドポイントへ渡された JWT トークンにエンコードされたデータを取得するためのオプションです。

非表示 options のプロパティ

string

optional

/continue エンドポイントに送信されたクエリパラメーターまたはボディパラメーターの名前。

`api.user`

ログイン中のユーザーのメタデータを変更します。

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

ログイン中のユーザーに対して、アプリケーション固有のメタデータを設定します。注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。同じフロー内の複数の Actions 全体でこのメソッドを複数回呼び出すことができ、エンジンが変更を集約して、フローの完了前にメタデータを一括で更新します。この関数は、オブジェクト形式のメタデータでのみ動作します。

string

設定するメタデータのプロパティ。

unknown

メタデータのプロパティの値です。この値を null に設定すると、メタデータのプロパティを削除できます。

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

ログイン中のユーザーの一般的なメタデータを設定します。注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。同じフロー内の複数の Action でこれを複数回呼び出すことができ、エンジンが変更を集約して、フローの完了前にメタデータをまとめて更新します。この関数は、オブジェクト形式のメタデータでのみ動作します。

string

設定するメタデータのプロパティです。

unknown

メタデータプロパティの値です。メタデータプロパティを削除するには、これを null に設定できます。

`api.cache`

キャッシュを変更します。

`api.cache.delete(key)`

指定した key に対応するキャッシュ値のレコードが存在する場合は、削除します。

string

削除するキャッシュレコードのキー。

`api.cache.get(key)`

指定したキーに対応するキャッシュ済みの値のレコードが存在する場合は、そのレコードを取得します。レコードが見つかった場合、キャッシュされた値は返されるオブジェクトの value プロパティに格納されています。

string

キャッシュに保存されているレコードのキーです。

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

指定したキーで、キャッシュに文字列値を保存または更新します。このキャッシュに保存された値のスコープは、それを設定した Trigger に限定されます。これらの値には、Actions Cache Limits が適用されます。この方法で保存された値の有効期間は、指定した ttl または expires_at の最大までです。有効期間を指定しない場合は、デフォルトで 15 分が使用されます。有効期間は、 Actions Cache Limits に記載されている最大時間を超えることはできません。重要: このキャッシュは、短期間のみ保持される一時的なデータ向けに設計されています。項目は、指定された有効期間内であっても、後続のトランザクションでは利用できない場合があります。

string

保存するレコードのキー。

string

保存するレコードの値。

cachesetoptions

optional

キャッシュの動作を調整するためのオプション。

非表示 options のプロパティ

number

optional

Unix エポックからの経過時間をミリ秒で表した絶対有効期限です。キャッシュされたレコードはそれより前に削除される場合がありますが、指定された expires_at を過ぎて保持されることはありません。注: ttl の値も指定する場合は、この値を指定しないでください。両方のオプションが指定された場合は、 2 つのうち早いほうの有効期限が使用されます。

number

optional

このキャッシュエントリの有効期間 (ミリ秒) です。キャッシュされた値はそれより前に削除される場合がありますが、指定された ttl を過ぎて保持されることはありません。注: expires_at の値も指定する場合は、この値を指定しないでください。両方のオプションが指定された場合は、 2 つのうち早いほうの有効期限が使用されます。

`api.samlResponse`

カスタムのSAML設定と属性を設定します。

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

認証済みユーザーに対して発行されるSAMLアサーションに属性を設定します。

string

設定するSAML属性。

samlattributevalue

SAMLクレームの値。この値を null または undefined に設定すると、アサーションからクレームが削除されます。

`api.samlResponse.setAudience(audience)`

SAML アサーションの対象者。デフォルト値は SAMLRequest の issuer です。

string

`api.samlResponse.setRecipient(recipient)`

SAML アサーションの受信先 (SubjectConfirmationData) 。デフォルトは、SAMLRequest の AssertionConsumerUrl、または SAMLRequest が送信されなかった場合はコールバック URL です。

string

`api.samlResponse.setCreateUpnClaim(createUpnClaim)`

UPN クレームを作成するかどうか。既定値は true です。

boolean

`api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)`

true の場合 (既定値) 、共通プロファイルにマッピングされていない各クレームは、Auth0 によって出力アサーションにそのまま含められます。 false の場合、それらのクレームはマッピングされません。

boolean

`api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)`

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

boolean

`api.samlResponse.setMapIdentities(mapIdentities)`

true (デフォルト) の場合、利用可能であれば、プロバイダー (Google、ADFS、AD など) やアクセストークンといった追加情報がトークンに含まれます。

boolean

`api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`

SAML アサーションまたはレスポンスに署名するための署名アルゴリズムです。デフォルトは rsa-sha256 です。

string

使用できる値: rsa-sha256

`api.samlResponse.setDigestAlgorithm(digestAlgorithm)`

SAML アサーションまたはレスポンスのダイジェストの計算に使用するダイジェストアルゴリズムです。デフォルトは sha256 です。

string

使用できる値: sha256

`api.samlResponse.setDestination(destination)`

SAML レスポンスの宛先です。指定しない場合は、SAMLRequest の AssertionConsumerUrl、SAMLRequest がない場合はコールバック URL が使用されます。

string

`api.samlResponse.setLifetimeInSeconds(lifetimeInSeconds)`

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

number

`api.samlResponse.setSignResponse(signResponse)`

SAML レスポンスに署名するかどうかを指定します。デフォルトでは、SAML アサーションには署名されますが、SAML レスポンスには署名されません。 true の場合、SAML アサーションではなく SAML レスポンスに署名されます。デフォルト値は false です。

boolean

`api.samlResponse.setNameIdentifierFormat(nameIdentifierFormat)`

デフォルト値は urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified です。

string

`api.samlResponse.setNameIdentifierProbes(nameIdentifierProbes)`

Auth0 は、この配列内の各属性を順番に試します。いずれかに値がある場合は、その値を Subject/NameID として使用します。順序は次のとおりです。

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 からマッピング)

文字列の配列

`api.samlResponse.setAuthnContextClassRef(authnContextClassRef)`

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

string

`api.samlResponse.setSigningCert(signingCert)`

必要に応じて、SAML リクエストの検証に使用する公開鍵証明書を指定します。設定すると、SAML リクエストへの署名が必須になります。値の例: “-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END CERTIFICATE-----\n”

string

`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 です。

boolean

`api.samlResponse.setTypedAttributes(typedAttributes)`

true に設定すると、要素の xs:type を推定します。指定できる型は xs:string、xs:boolean、xs:double、xs:anyType です。 false に設定すると、すべての xs:type が xs:anyType になります。デフォルトは true です。

boolean

`api.samlResponse.setEncryptionCert(encryptionCert)`

必要に応じて、SAML アサーションの暗号化に使用する証明書を指定します。この証明書はサービスプロバイダーから取得してください。証明書と公開鍵の両方を指定する必要があります。値の例は

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

です。

string

`api.samlResponse.setEncryptionPublicKey(encryptionPublicKey)`

必要に応じて、SAML アサーションの暗号化に使用する公開鍵を指定します。公開鍵はサービスプロバイダーから取得してください。公開鍵と証明書は両方とも指定する必要があります。値の例は “-----BEGIN PUBLIC KEY-----\nnMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END PUBLIC KEY-----\n” です。

string

`api.samlResponse.setCert(cert)`

デフォルトでは、Auth0 はテナントに割り当てられた公開鍵/秘密鍵ペアを使用して、SAML レスポンスまたはアサーションに署名します。ごく限られた特定のシナリオでは、独自の証明書と秘密鍵を指定したい場合があります。証明書と秘密鍵の両方を指定する必要があります。値の例:

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

。

string

`api.samlResponse.setKey(key)`

デフォルトでは、Auth0 はテナントに割り当てられた秘密鍵/公開鍵のペアを使用して、SAML レスポンスまたはアサーションに署名します。ごく限られたケースでは、独自の証明書と秘密鍵を指定することもできます。この秘密鍵は機密情報であるため、Actions の Add Secret 機能を使用することを推奨します。詳細については、こちらを参照してください: https://auth0.com/docs/customize/actions/write-your-first-action#add-a-secret 証明書と秘密鍵の両方を指定する必要があります。値の例: “-----BEGIN PRIVATE KEY-----\nnMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..all the other lines..]-----END PRIVATE KEY-----\n”

string

`api.samlResponse.setRelayState(relayState)`

必要に応じて、サービスプロバイダーに戻る際に使用する RelayState を指定します

string

`api.samlResponse.setIssuer(issuer)`

必要に応じて、SAML アサーションの発行元を指定します。デフォルトは urn:auth0:TENANT です

string

`api.samlResponse.setEncryptionAlgorithm(encryptionAlgorithm)`

SAML アサーションの暗号化アルゴリズムを設定します。デフォルトは aes256-cbc です。

string

使用するアルゴリズム (aes256-gcm を推奨)

許可される値: aes256-gcm

Set the encryption algorithm to aes256-gcm (recommended)

api.samlResponse.setEncryptionAlgorithm('aes256-gcm');

`api.validation`

バリデーションエラーをスローして、ユーザーのログインを防止します。

`api.validation.error(errorCode, errorMessage)`

バリデーションエラーがある場合に、エラーをスローします。

string

バリデーションエラー用のユーザー定義のエラーコードです。

string

バリデーションエラー用のユーザー定義のメッセージです。

`api.rules`

Rule が現在のトランザクションで実行されたかどうかを判別します。

`api.rules.wasExecuted(ruleId)`

現在のトランザクションで、特定の ID を持つ Rule が実行済みかどうかを確認します。

string

Rule の ID。

`api.prompt`

カスタムプロンプトを表示します。

`api.prompt.render(promptId, promptOptions)`

カスタムプロンプトをレンダリングします。

string

プロンプト ID。

promptoptions

optional

レンダリングオプション。

非表示 promptOptions のプロパティ

dictionary

optional

フィールドの値を設定するためのキーと値のペア (クライアント側) 。

dictionary

optional

変数を挿入するためのキーと値のペア (サーバー側) 。

`api.refreshToken`

現在のユーザーのリフレッシュトークンの変更を要求します。

`api.refreshToken.revoke(reason)`

[エンタープライズのお客様] 現在のユーザーのリフレッシュトークンを取り消し、現在のリフレッシュトークン交換の試行を拒否済みとしてマークします。これにより、エンドユーザーはリフレッシュトークン交換フローを完了できなくなり、現在使用中のリフレッシュトークンは取り消されます。この処理の完了後、リフレッシュトークン交換フローは直ちに停止し、それ以降の Actions は実行されません。このメソッドは、event.transaction.protocol === "oauth2-refresh-token" の場合に、リフレッシュトークン交換フロー中でのみ使用できます。

string

リフレッシュトークン交換を拒否する理由を、人が読んで理解できる形で説明します。これはエンドユーザー向けインターフェースに直接表示される場合があります。

`api.refreshToken.setExpiresAt(absolute)`

[Enterprise Customers] 現在のリフレッシュトークンに、新しい絶対有効期限を設定します。有効期限は、設定で指定されたリフレッシュトークンの最大有効期間を超えて設定できません。複数回呼び出した場合は、最も早い有効期限が使用されます。

number

必須。Unixエポックからの経過時間をミリ秒単位で表した新しい絶対有効期限です。この時刻を過ぎると、リフレッシュトークンは無効と見なされます。

`api.refreshToken.setIdleExpiresAt(inactivity)`

[Enterprise Customers] 現在のリフレッシュトークンの新しいアイドル有効期限を設定します。この有効期限は、設定で定義されたリフレッシュトークンの絶対有効期間の最大値を超えて設定することはできません。複数回呼び出した場合は、最も早い有効期限が適用されます。

number

必須。新しいアイドル非アクティブ時間を、Unixエポックからのミリ秒数で指定します。この期間内にリフレッシュトークンが使用されなかった場合、無効と見なされます。

`api.refreshToken.setMetadata(key, value)`

現在のリフレッシュトークンのメタデータオブジェクトにキーと値のペアを設定します。

string

必須。メタデータオブジェクトに設定するキーです。

string

必須。メタデータオブジェクト内のキーに設定する値です。null を指定すると、指定したメタデータキーは削除されます。

`api.refreshToken.deleteMetadata(key)`

現在のリフレッシュトークンのメタデータオブジェクトから、指定したキーを削除します。

string

必須。メタデータオブジェクトから削除するキー。

`api.refreshToken.evictMetadata()`

現在のリフレッシュトークンのメタデータオブジェクト内のすべてのキーを削除します。

`api.session`

現在のユーザーのセッションに対する変更をリクエストします。

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

[Enterprise Customers] 現在のユーザーセッションを無効化し、現在のログイン試行を拒否としてマークします。これにより、エンドユーザーはログインフローを完了できなくなり、セッションも無効化されます。ログインフローはこのアクションの完了後ただちに停止し、以降の Actions は実行されません。

string

ログインを拒否する理由を、人が読める形式で説明します。これはエンドユーザー向けインターフェースに直接表示される場合があります。

sessionrevocationoptions

optional

非表示 options のプロパティ

boolean

optional

デフォルトは false です。true の場合、システムはセッションを終了しますが、リフレッシュトークンは保持されます。アプリケーションは、リフレッシュトークンの有効期間中、引き続きアクセストークンを取得できます。

Revoke the session while preserving refresh tokens

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

`api.session.setExpiresAt(absolute)`

[Enterprise Customers] 現在のセッションに新しい絶対有効期限を設定します。有効期限は、テナント設定で定義された最大セッション存続期間を超えて設定することはできません。複数回呼び出された場合は、最も早い有効期限が適用されます。

number

必須。新しい絶対有効期限を、Unix エポックからの経過ミリ秒数で指定します。この時刻を過ぎると、セッションは無効と見なされます。

`api.session.setIdleExpiresAt(inactivity)`

[Enterprise Customers] 現在のセッションの新しいアイドル有効期限を設定します。この有効期限には、テナント設定で設定されたセッションの最大絶対有効期間を超える値は指定できません。複数回呼び出した場合は、最も早い有効期限が使用されます。

number

必須。新しいアイドル有効期限の時刻を、Unix エポックからの経過ミリ秒数で指定します。この期間中にユーザー操作がない場合、Session はこの時刻を過ぎると無効と見なされます。

`api.session.setCookieMode(mode)`

[Enterprise Customers] [早期アクセス] 現在のセッションの cookie モードを設定します。指定できる値は、‘persistent’ または ‘non-persistent’ (一時的) のいずれかです。これにより、ブラウザーでセッション cookie がどのように扱われるかが決まります。

‘persistent’: cookie は、有効期限が切れるか、ユーザーが削除するまで保存されます。
‘non-persistent’ (一時的) : cookie は、ブラウザーを閉じると削除されます。

setCookieMode を複数回呼び出した場合は、最後の呼び出しだけが有効になります。‘non-persistent’ が設定されている場合、ブラウザーを閉じると cookie は削除されますが、セッション自体は絶対有効期限またはアイドル有効期限に達するまで、または利用可能な API を使用してセッションが取り消されるまで有効なままです。cookie モードの詳細については、ドキュメントを参照してください。

string

必須。現在のセッションの cookie モードです。 ‘persistent’ または ‘non-persistent’ (一時的) のいずれかを指定できます。使用可能な値: persistent, non-persistent

`api.session.setMetadata(key, value)`

[Enterprise Customers] [早期アクセス] 現在のセッションのメタデータオブジェクトにキーと値のペアを設定します。

string

必須。メタデータオブジェクトに設定するキーです。

string

必須。メタデータオブジェクトでそのキーに設定する値です。値が null の場合は、指定したメタデータキーが削除されます。

`api.session.deleteMetadata(key)`

[Enterprise Customers] [早期アクセス] 現在のセッションのメタデータオブジェクト内のキーを削除します。

string

必須。メタデータオブジェクトから削除するキーです。

`api.session.evictMetadata()`

[Enterprise Customers] [早期アクセス] 現在のセッションのメタデータオブジェクトから、すべてのキーを削除します。

`api.transaction`

トランザクションを変更します。

`api.transaction.setMetadata(key, value)`

指定したキーのトランザクションメタデータに値を保存または更新します。このメソッドで変更したメタデータは、event.transaction.metadata オブジェクトにリアルタイムで反映されます。

string

設定するプロパティのキーです。

txmetadatavalue

プロパティの値です。メタデータプロパティを削除するには、null を設定できます。

`api.groups`

ユーザーが所属するグループに関する情報を取得します。

`api.groups.getUserGroups(params)`

ユーザーが所属しているグループのページネーションされた一覧を取得します。

getusergroupsparams

optional

ページネーションオプションを含むオブジェクト。

非表示 params のプロパティ

number

optional

string

optional

`api.groups.hasGroupMembership(groups)`

ユーザーが指定されたグループのいずれかに所属しているかどうかを確認し、所属している場合は一致したグループの詳細を返します。

array of strings

メンバーシップを確認する対象のグループ識別子 (ID または名前) の配列。

​api.access

​api.access.deny(reason)

​api.accessToken

​api.accessToken.setCustomClaim(key, value)

​api.accessToken.addScope(scope)

​api.accessToken.removeScope(scope)

​api.authentication

​api.authentication.challengeWith(factor, options)

​api.authentication.challengeWithAny(factors)

​api.authentication.enrollWith(factor, options)

​api.authentication.enrollWithAny(factors)

​api.authentication.recordMethod(provider_url)

​api.authentication.setPrimaryUser(primary_user_id)

​api.idToken

​api.idToken.setCustomClaim(key, value)

​api.multifactor

​api.multifactor.enable(provider, options)

​api.redirect

​api.redirect.encodeToken(options)

​api.redirect.sendUserTo(url, options)

​api.redirect.validateToken(options)

​api.user

​api.user.setAppMetadata(key, value)

​api.user.setUserMetadata(key, value)

​api.cache

​api.cache.delete(key)

​api.cache.get(key)

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

​api.samlResponse

​api.samlResponse.setAttribute(attribute, value)

​api.samlResponse.setAudience(audience)

​api.samlResponse.setRecipient(recipient)

​api.samlResponse.setCreateUpnClaim(createUpnClaim)

​api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)

​api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)

​api.samlResponse.setMapIdentities(mapIdentities)

​api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)

​api.samlResponse.setDigestAlgorithm(digestAlgorithm)

​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.setEncryptionPublicKey(encryptionPublicKey)

​api.samlResponse.setCert(cert)

​api.samlResponse.setKey(key)

​api.samlResponse.setRelayState(relayState)

​api.samlResponse.setIssuer(issuer)

​api.samlResponse.setEncryptionAlgorithm(encryptionAlgorithm)

​api.validation

​api.validation.error(errorCode, errorMessage)

​api.rules

​api.rules.wasExecuted(ruleId)

​api.prompt

​api.prompt.render(promptId, promptOptions)

​api.refreshToken

​api.refreshToken.revoke(reason)

​api.refreshToken.setExpiresAt(absolute)

​api.refreshToken.setIdleExpiresAt(inactivity)

​api.refreshToken.setMetadata(key, value)

​api.refreshToken.deleteMetadata(key)

​api.refreshToken.evictMetadata()

​api.session

​api.session.revoke(reason, options)

​api.session.setExpiresAt(absolute)

​api.session.setIdleExpiresAt(inactivity)

​api.session.setCookieMode(mode)

​api.session.setMetadata(key, value)

​api.session.deleteMetadata(key)

​api.session.evictMetadata()

​api.transaction

​api.transaction.setMetadata(key, value)

​api.groups

​api.groups.getUserGroups(params)

​api.groups.hasGroupMembership(groups)

`api.access`

`api.access.deny(reason)`

`api.accessToken`

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

`api.accessToken.addScope(scope)`

`api.accessToken.removeScope(scope)`

`api.authentication`

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

`api.authentication.challengeWithAny(factors)`

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

`api.authentication.enrollWithAny(factors)`

`api.authentication.recordMethod(provider_url)`

`api.authentication.setPrimaryUser(primary_user_id)`

`api.idToken`

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

`api.multifactor`

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

`api.redirect`

`api.redirect.encodeToken(options)`

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

`api.redirect.validateToken(options)`

`api.user`

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

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

`api.cache`

`api.cache.delete(key)`

`api.cache.get(key)`

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

`api.samlResponse`

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

`api.samlResponse.setAudience(audience)`

`api.samlResponse.setRecipient(recipient)`

`api.samlResponse.setCreateUpnClaim(createUpnClaim)`

`api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)`

`api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)`

`api.samlResponse.setMapIdentities(mapIdentities)`

`api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`

`api.samlResponse.setDigestAlgorithm(digestAlgorithm)`

`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.setEncryptionPublicKey(encryptionPublicKey)`

`api.samlResponse.setCert(cert)`

`api.samlResponse.setKey(key)`

`api.samlResponse.setRelayState(relayState)`

`api.samlResponse.setIssuer(issuer)`

`api.samlResponse.setEncryptionAlgorithm(encryptionAlgorithm)`

`api.validation`

`api.validation.error(errorCode, errorMessage)`

`api.rules`

`api.rules.wasExecuted(ruleId)`

`api.prompt`

`api.prompt.render(promptId, promptOptions)`

`api.refreshToken`

`api.refreshToken.revoke(reason)`

`api.refreshToken.setExpiresAt(absolute)`

`api.refreshToken.setIdleExpiresAt(inactivity)`

`api.refreshToken.setMetadata(key, value)`

`api.refreshToken.deleteMetadata(key)`

`api.refreshToken.evictMetadata()`

`api.session`

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

`api.session.setExpiresAt(absolute)`

`api.session.setIdleExpiresAt(inactivity)`

`api.session.setCookieMode(mode)`

`api.session.setMetadata(key, value)`

`api.session.deleteMetadata(key)`

`api.session.evictMetadata()`

`api.transaction`

`api.transaction.setMetadata(key, value)`

`api.groups`

`api.groups.getUserGroups(params)`

`api.groups.hasGroupMembership(groups)`