']`から読み取れます。
**パラメータ**
生成されるURLのクエリパラメータに機密データをエンコードする方法を
設定します。
このtokenの有効期限が切れるまでの秒数。
任意。
リダイレクト先に渡すデータ。このデータの真正性と完全性は
証明可能である必要があります。
リダイレクト先と共有するJWTへの署名に使用するsecret。この
secret値は**secret**として保存し、
`event.secrets['']`を使用して取得する必要があります。
### `api.redirect.sendUserTo(url, options)`
このアクションの完了直後に、ログインパイプラインでブラウザーを対象の `url` にリダイレクトします。`createUrl` ヘルパーメソッドを使用すると、対象の `url` のクエリパラメータとしてデータをエンコードする処理を簡略化でき、対象の エンドポイント でデータの真正性と完全性を検証できます。
**パラメータ**
任意。
リダイレクト URL に追加するクエリ文字列パラメーターを表すオブジェクト。
任意。
### `api.redirect.canRedirect()`
現在のtransactionでユーザーをリダイレクトできるかどうかを示します。`oauth2-resource-owner` や `oauth2-refresh-token` などの一部のプロトコルでは、ユーザーをリダイレクトできません。`prompt=none` を含むrequestもリダイレクトの対象外です。
### `api.redirect.validateToken(options)`
`/continue` エンドポイントに渡された JWT token にエンコードされたデータを取得し、
その真正性と完全性を検証します。
**パラメータ**
リダイレクト後に `/continue` エンドポイントに渡された JWT token にエンコードされたデータを取得するための Options。
/continue エンドポイントに送信された query または body パラメータの名前。
任意です。
## `api.user`
ログイン中のユーザーのメタデータを変更します。
### `api.user.setAppMetadata(key, value)`
ログイン中のユーザーにアプリケーション固有のメタデータを設定します。
注: このメソッドはコールバック内では使用しないでください。呼び出しても、メタデータはすぐには更新されません。
同じフロー内の複数の Actions でこのメソッドを複数回呼び出すことができ、エンジンが変更を集約して、
フローの完了前にメタデータをまとめて更新します。この関数は、オブジェクト形式のメタデータでのみ使用できます。
**パラメータ**
設定するメタデータプロパティ。
メタデータプロパティの値。メタデータプロパティを削除するには、`null` を設定できます。
### `api.user.setUserMetadata(key, value)`
ログイン中のユーザーの一般的なメタデータを設定します。
注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。
同じフロー内の複数のActionsからこのメソッドを複数回呼び出すことができ、エンジンが変更を集約して、
フローの完了前にメタデータをまとめて更新します。この関数は、オブジェクト形式のメタデータでのみ使用できます。
**パラメータ**
設定するメタデータプロパティ。
メタデータプロパティの値。メタデータプロパティを削除するには、`null` に設定できます。
## `api.cache`
キャッシュを変更します。
### `api.cache.delete(key)`
指定したキーにキャッシュ値を表すレコードが存在する場合は、削除します。
**パラメータ**
削除するキャッシュレコードのキー。
### `api.cache.get(key)`
指定されたキーに対応するキャッシュ値のレコードが存在する場合は、それを取得します。レコードが見つかった場合、キャッシュ値は返されたオブジェクトの `value` プロパティに格納されています。
**パラメータ**
キャッシュに保存されているレコードのキー。
### `api.cache.set(key, value, options)`
指定したキーのキャッシュに文字列値を保存または更新します。
このキャッシュに保存される値は、それを設定したトリガーにスコープされます。
また、[Actions Cache Limits](https://auth0.com/docs/customize/actions/limitations) の制限が適用されます。
この方法で保存された値の有効期間は、指定した
`ttl` または `expires_at` の値までとなります。有効期間を指定しない場合は、デフォルトで
15 分間となります。有効期間は、[Actions Cache Limits](https://auth0.com/docs/customize/actions/limitations) に記載されている最大
期間を超えることはできません。
**重要**: このキャッシュは、短期間のみ使用する一時的なデータ向けに設計されています。指定した有効期間内であっても、
後続のトランザクションでは項目を利用できない場合があります。
**パラメータ**
保存するレコードのキー。
保存するレコードの値。
キャッシュの動作を調整するためのオプション。
任意。
Unix エポックからのミリ秒単位の絶対有効期限。
キャッシュされたレコードはそれより早く削除される場合がありますが、
指定した `expires_at` を過ぎて保持されることはありません。
*注*: `ttl` にも値を
指定している場合は、この値を指定しないでください。両方のオプションを指定した場合は、
2 つのうち早い方の有効期限が使用されます。
任意。
このキャッシュエントリのミリ秒単位の有効期間。
キャッシュ値はそれより早く削除される場合がありますが、
指定した `ttl` を過ぎて保持されることはありません。
*注*: `expires_at` にも値を
指定している場合は、この値を指定しないでください。両方のオプションを指定した場合は、
2 つのうち早い方の有効期限が使用されます。
任意。
## `api.samlResponse`
カスタム SAML 設定と属性を構成します。
### `api.samlResponse.setAttribute(attribute, value)`
認証済みユーザーに発行する SAML assertion に属性を設定します。
**パラメータ**
設定する SAML 属性。
SAML クレーム の値。この値を `null` または
`undefined` に設定すると、assertion から クレーム が削除されます。
### `api.samlResponse.setAudience(audience)`
SAML assertion の audience。
デフォルトは、SAMLRequest の発行者です。
**パラメータ**
### `api.samlResponse.setRecipient(recipient)`
SAML assertion の受信者 (SubjectConfirmationData) 。
デフォルトでは、SAMLRequest の AssertionConsumerUrl を使用します。SAMLRequest が送信されていない場合は、コールバック URL を使用します。
**パラメータ**
### `api.samlResponse.setCreateUpnClaim(createUpnClaim)`
UPN クレームを作成するかどうかを指定します。デフォルトは true です。
**パラメータ**
### `api.samlResponse.setPassthroughClaimsWithNoMapping(passthroughClaimsWithNoMapping)`
true (デフォルト) の場合、共通プロファイルにマッピングされていない各クレームは、出力 assertion にそのまま含まれます。
false の場合、それらのクレームはマッピングされません。
**パラメータ**
### `api.samlResponse.setMapUnknownClaimsAsIs(mapUnknownClaimsAsIs)`
passthroughClaimsWithNoMapping が true で、この値が false (デフォルト) の場合、共通プロファイルにマッピングされていない各クレームに Auth0 が `http://schema.auth0.com` というプレフィックスを追加します。
true の場合、クレームはそのまま渡されます。
**パラメータ**
### `api.samlResponse.setMapIdentities(mapIdentities)`
true (デフォルト) の場合、Provider (Google、ADFS、AD など) や、利用可能な場合はaccess tokenなどの追加情報がtokenに追加されます。
**パラメータ**
### `api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`
SAML assertion またはレスポンスの署名に使用する署名アルゴリズム。
デフォルトは `rsa-sha256` です。
**パラメータ**
使用可能な値: `rsa-sha256`
### `api.samlResponse.setSignatureAlgorithm(signatureAlgorithm)`
**パラメータ**
使用できる値: `rsa-sha1`
### `api.samlResponse.setDigestAlgorithm(digestAlgorithm)`
SAML assertion またはレスポンスのダイジェストを計算するためのダイジェストアルゴリズム。
デフォルトは sha256 です。
**パラメータ**
許可される値: `sha256`
### `api.samlResponse.setDigestAlgorithm(digestAlgorithm)`
**パラメータ**
設定可能な値: `sha1`
### `api.samlResponse.setDestination(destination)`
SAML レスポンスの送信先。指定しない場合は、SAMLRequest の AssertionConsumerUrl、SAMLRequest がない場合はコールバック URL になります。
**パラメータ**
### `api.samlResponse.setLifetimeInSeconds(lifetimeInSeconds)`
トークンの有効期限です。
デフォルトは3600秒 (1時間) です。
**パラメータ**
### `api.samlResponse.setSignResponse(signResponse)`
SAML レスポンスに署名するかどうかを指定します。
デフォルトではSAML assertionに署名され、SAML レスポンスには署名されません。
trueの場合、SAML assertionではなくSAML レスポンスに署名されます。
デフォルトはfalseです。
**パラメータ**
### `api.samlResponse.setNameIdentifierFormat(nameIdentifierFormat)`
デフォルト値は urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified です。
**パラメータ**
### `api.samlResponse.setNameIdentifierProbes(nameIdentifierProbes)`
Auth0 は、この配列内の属性を順に確認します。
値が設定されている属性があれば、その値を Subject/NameID として使用します。
確認順序は次のとおりです。
* [http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier](http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier) (user\_id からマッピング)
* [http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress](http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress) (email からマッピング)
* [http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name](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` です。
**パラメータ**
### `api.samlResponse.setSigningCert(signingCert)`
SAML リクエストの検証に使用する公開鍵証明書を任意で指定します。
設定した場合、SAML リクエストには署名が必要になります。
値の例: "-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n\[..その他の行..]-----END CERTIFICATE-----\n"。
**パラメータ**
### `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 です。
**パラメータ**
### `api.samlResponse.setTypedAttributes(typedAttributes)`
true に設定すると、要素の xs:type を推定します。型には xs:string、xs:boolean、xs:double、xs:anyType があります。
false に設定すると、すべての xs:type が xs:anyType になります。
デフォルトは true です。
**パラメータ**
### `api.samlResponse.setEncryptionCert(encryptionCert)`
SAML アサーションの暗号化に使用する証明書を指定できます。
証明書はサービスプロバイダーから取得してください。
証明書と公開鍵の両方を指定する必要があります。
値の例: "-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n\[..all the other lines..]-----END CERTIFICATE-----\n"。
**パラメータ**
### `api.samlResponse.setEncryptionPublicKey(encryptionPublicKey)`
SAML アサーション の暗号化に使用する公開鍵を任意で指定します。
公開鍵はサービスプロバイダーから取得してください。
公開鍵と証明書の両方を指定する必要があります。
値の例： "-----BEGIN PUBLIC KEY-----\nnMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n\[..その他のすべての行..]-----END PUBLIC KEY-----\n"
**パラメータ**
### `api.samlResponse.setCert(cert)`
デフォルトでは、Auth0 はテナントに割り当てられた秘密キーと公開鍵のペアを使用して、SAML Responseまたはアサーションに署名します。
非常に限定されたシナリオでは、独自の証明書と秘密キーを指定できます。
証明書と秘密キーの両方を指定する必要があります。
値の例は、"-----BEGIN CERTIFICATE-----\nMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n\[..その他の行..]-----END CERTIFICATE-----\n" です。
**パラメータ**
### `api.samlResponse.setKey(key)`
デフォルトでは、Auth0 はテナントに割り当てられた秘密キーと公開鍵のペアを使用して、SAML Response または アサーション に署名します。
ごく限定的なシナリオでは、独自の証明書と秘密キーを指定できます。
この秘密キーは機密情報であるため、**Actions の Add Secret 機能を使用することをお勧めします**。
詳細については、こちらを参照してください: [https://auth0.com/docs/customize/actions/write-your-first-action#add-a-secret](https://auth0.com/docs/customize/actions/write-your-first-action#add-a-secret)
証明書と秘密キーの両方を指定する必要があります。
値の例: `"-----BEGIN PRIVATE KEY-----\nnMIIC8jCCAdqgAwIBAgIJObB6jmhG0QIEMA0GCSqGSIb3DQEBBQUAMCAxHjAcBgNV\n[..その他のすべての行..]-----END PRIVATE KEY-----\n"`
**パラメータ**
### `api.samlResponse.setRelayState(relayState)`
サービスプロバイダーに戻る際に使用するRelayStateを指定できます
**パラメータ**
### `api.samlResponse.setIssuer(issuer)`
SAMLアサーションの発行者を任意で指定します。
既定値は `urn:auth0:TENANT` です。
**パラメータ**
### `api.samlResponse.setEncryptionAlgorithm(encryptionAlgorithm)`
SAMLアサーションの暗号化アルゴリズムを設定します。
デフォルトは aes256-cbc です。
```js Set the encryption algorithm to aes256-gcm (recommended) theme={null}
api.samlResponse.setEncryptionAlgorithm('aes256-gcm');
```
**パラメータ**
* 使用するアルゴリズム (`aes256-gcm` を推奨)
指定可能な値: `aes256-gcm`
### `api.samlResponse.setEncryptionAlgorithm(encryptionAlgorithm)`
```js Set encryption algorithm to aes256-cbc (not recommended) theme={null}
api.samlResponse.setEncryptionAlgorithm('aes256-cbc');
```
**パラメータ**
* 使用するアルゴリズム (aes256-cbc は非推奨)
使用できる値: `aes256-cbc`
## `api.validation`
バリデーションエラーをスローして、ユーザーのログインを阻止します。
### `api.validation.error(errorCode, errorMessage)`
バリデーションエラーが発生した際にエラーをスローします。
**パラメータ**
バリデーションエラー用にユーザーが定義するエラーコード。
バリデーションエラー用にユーザーが定義するメッセージ。
## `api.rules`
現在のトランザクションでルールが実行されたかどうかを確認します。
### `api.rules.wasExecuted(ruleId)`
指定した ID を持つ Rule が現在のトランザクションで実行されたかどうかを確認します。
**パラメータ**
Rule の ID。
## `api.prompt`
カスタムプロンプトをレンダリングします。
### `api.prompt.render(promptId, promptOptions)`
カスタムプロンプトをレンダリングします。
**パラメータ**
プロンプト ID。
レンダリングオプション。
任意。
フィールドの値を設定するキーと値のペア (クライアント側) 。
任意。
変数を注入するキーと値のペア (サーバー側) 。
任意。
## `api.refreshToken`
現在のユーザーのリフレッシュトークンの変更を要求します。
### `api.refreshToken.revoke(reason)`
\[Enterprise のお客様] 現在のユーザーのリフレッシュトークンを取り消し、現在のリフレッシュトークン交換の試行を拒否としてマークします。これにより、
エンドユーザーはリフレッシュトークン交換フローを完了できなくなり、現在使用中のリフレッシュトークンも取り消されます。
この Action の完了後、リフレッシュトークン交換フローは直ちに停止し、以降の Actions は実行されません。
このメソッドは、`event.transaction.protocol === "oauth2-refresh-token"` の場合にのみ、リフレッシュトークン交換フロー中で使用できます。
**パラメータ**
リフレッシュトークン交換を拒否する理由を、人間が理解できる形式で説明します。これは、
エンドユーザー向けのインターフェースに直接表示される場合があります。
### `api.refreshToken.setExpiresAt(absolute)`
\[Enterprise のお客様] 現在のリフレッシュトークンの新しい絶対有効期限を設定します。
有効期限には、設定で指定されたリフレッシュトークンの最大有効期間を超える値は設定できません。
複数回呼び出された場合は、最も早い有効期限が適用されます。
**パラメータ**
必須。unix epoch からのミリ秒単位で指定する新しい絶対有効期限です。この時点以降、リフレッシュトークンは無効と見なされます。
### `api.refreshToken.setIdleExpiresAt(inactivity)`
\[Enterprise のお客様] 現在のリフレッシュトークンに新しいアイドル有効期限を設定します。
有効期限には、設定で指定されたリフレッシュトークンの最大絶対有効期間を超える値を設定できません。
複数回呼び出した場合は、最も早い有効期限が適用されます。
**パラメータ**
必須。unix epoch からのミリ秒単位で指定する、新しいアイドル有効期限。この期間中に使用されなかった場合、リフレッシュトークンは無効と見なされます。
### `api.refreshToken.setMetadata(key, value)`
現在のリフレッシュトークンのメタデータオブジェクトにキーと値のペアを設定します。
**パラメータ**
必須。メタデータオブジェクトに設定するキーです。
必須。メタデータオブジェクト内でこのキーに設定する値です。null を指定すると、該当するメタデータキーが削除されます。
### `api.refreshToken.deleteMetadata(key)`
現在のリフレッシュトークンのメタデータオブジェクトからキーを削除します。
**パラメータ**
必須。メタデータオブジェクトから削除するキー。
### `api.refreshToken.evictMetadata()`
現在のリフレッシュトークンのメタデータオブジェクトからすべてのキーを削除します。
## `api.session`
現在のユーザーのセッションを変更するリクエスト。
### `api.session.revoke(reason, options)`
\[Enterprise のお客様] 現在のユーザーセッションを取り消し、現在のログイン試行を拒否としてマークします。これにより、
エンドユーザーはログインフローを完了できなくなり、セッションも取り消されます。この Action の完了後、ログインフローは直ちに
停止し、以降の Actions は実行されません。
```js Revoke the session while preserving refresh tokens theme={null}
api.session.revoke('reason', { preserveRefreshTokens: true });
```
**パラメータ**
ログインを拒否する理由を、人間が理解しやすい形で説明します。これは
エンドユーザー向けのインターフェースに直接表示される場合があります。
任意。
デフォルトは false です。true の場合、システムはセッションを終了しますが、リフレッシュトークンは保持します。アプリケーションはリフレッシュトークンの有効期間中、引き続きアクセストークンを取得できます。
任意。
### `api.session.setExpiresAt(absolute)`
\[Enterprise のお客様] 現在のセッションの絶対有効期限を新たに設定します。
有効期限は、テナント設定で設定されている最大セッション有効期間を超えて設定することはできません。
複数回呼び出した場合は、最も早い有効期限が使用されます。
**パラメータ**
必須。unix epoch からのミリ秒で指定する新しい絶対有効期限です。この時刻を過ぎると、セッションは無効と見なされます。
### `api.session.setIdleExpiresAt(inactivity)`
\[Enterprise のお客様] 現在のセッションに新しいアイドル有効期限を設定します。
有効期限は、Tenant Settings で設定されているセッションの最大絶対有効期間を超えて設定することはできません。
複数回呼び出した場合は、最も早い有効期限が使用されます。
**パラメータ**
必須。unix epoch からのミリ秒で指定する新しいアイドル有効期限です。この期間中にユーザー操作がない場合、セッションは無効と見なされます。
### `api.session.setCookieMode(mode)`
\[Enterprise のお客様] \[早期アクセス] 現在のセッションの Cookie モードを設定します。Cookie モードには「persistent」または「non-persistent」 (一時的) を指定できます。
これにより、ブラウザでセッション Cookie をどのように扱うかが決まります。
* 「persistent」: Cookie は有効期限が切れるか、ユーザーによって削除されるまで保存されます。
* 「non-persistent」 (一時的) : ブラウザを閉じると Cookie は削除されます。
setCookieMode を複数回呼び出した場合、有効になるのは最後の呼び出しのみです。「non-persistent」を設定した場合、ブラウザを閉じると Cookie は削除されますが、セッション自体は絶対有効期限またはアイドル有効期限に達するか、利用可能な API を通じて取り消されるまで有効です。Cookie モードの詳細については、ドキュメントを参照してください。
**パラメータ**
必須。現在のセッションの Cookie モードです。
「persistent」または「non-persistent」 (一時的) を指定できます。
許可される値: `persistent`, `non-persistent`
### `api.session.setMetadata(key, value)`
\[Enterprise のお客様] \[早期アクセス] 現在のセッションのメタデータオブジェクトにキーと値のペアを設定します。
**パラメータ**
必須。メタデータオブジェクトに設定するキーです。
必須。メタデータオブジェクト内のキーに設定する値です。null を指定すると、指定したメタデータキーが削除されます。
### `api.session.deleteMetadata(key)`
\[Enterprise のお客様] \[早期アクセス] 現在のセッションのメタデータオブジェクトからキーを削除します。
**パラメータ**
必須。メタデータオブジェクトから削除するキー。
### `api.session.evictMetadata()`
\[Enterprise のお客様] \[早期アクセス] 現在のセッションのメタデータオブジェクトからすべてのキーを削除します。
## `api.transaction`
トランザクション を変更します。
### `api.transaction.setMetadata(key, value)`
指定したキーのトランザクションメタデータに値を保存または更新します。
このメソッドで変更したメタデータは、
`event.transaction.metadata` オブジェクトにリアルタイムで反映されます。
**パラメータ**
設定するプロパティのキー。
プロパティの値。`null` を設定すると、メタデータプロパティを削除できます。
## `api.groups`
ユーザーのグループへの所属に関する情報を取得します。
### `api.groups.getUserGroups(params)`
ユーザーが所属するグループのページネーション対応一覧を取得します。
**パラメータ**
* ページネーションオプションを含むオブジェクト。
任意。
任意。
任意。
### `api.groups.hasGroupMembership(groups)`
ユーザーが指定したグループのいずれかに所属しているかを確認し、
所属している場合は該当するグループの詳細を返します。
**パラメータ**
* メンバーシップを確認するグループ識別子 (ID または名前) の配列。
## `api.roles`
ユーザーロールの割り当てに関する情報を取得します。
### `api.roles.getUserEffectiveRoles(params)`
ユーザーに直接、またはグループのメンバーシップを通じて割り当てられたすべてのロールを返します。
必要に応じて組織にスコープを限定し、チェックポイントベースのページネーションを使用できます。
```js Fetch the first page of roles theme={null}
const result = await api.roles.getUserEffectiveRoles({ take: 50 });
console.log(result.roles);
```
```js Paginate through roles theme={null}
let cursor;
do {
const result = await api.roles.getUserEffectiveRoles({ take: 100, from: cursor });
console.log(result.roles);
cursor = result.next;
} while (cursor);
```
**パラメータ**
* チェックポイント方式のページネーションパラメータ。
任意。
返されるロールの最大数 (最大 100) 。
任意。
前のレスポンスの `next` フィールドに含まれるページネーショントークン。これを使用して、結果の次のページを取得します。
任意。
### `api.roles.getUserEffectiveRolesByIds(ids)`
ユーザーに直接、またはグループのメンバーシップを通じて割り当てられたロールを返します。
必要に応じて組織をスコープに指定し、ロールIDで絞り込めます。
```js Filter roles by specific IDs theme={null}
const result = await api.roles.getUserEffectiveRolesByIds([
'rol_1234567890',
'rol_0987654321'
]);
console.log(result.roles);
```
**パラメータ**
* フィルタリングするロール ID の配列 (最大 100 件) 。
### `api.roles.getUserEffectiveRolesByNames(names)`
ユーザーに直接、またはグループのメンバーシップを通じて割り当てられたロールを返します。
必要に応じて組織にスコープを設定し、ロール名で絞り込むことができます。
```js Filter roles by specific names theme={null}
const result = await api.roles.getUserEffectiveRolesByNames([
'Admin',
'Editor'
]);
console.log(result.roles);
```
**パラメータ**
* フィルタリングするロール名の配列 (最大50件) 。