アクションのトリガー：ログイン後 - APIオブジェクト

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

文字列 。クレームの名前（これは完全修飾URLが必要な場合があります）。

すべての値。クレームの値。

文字列 追加するスコープ。

文字列 削除するスコープ。

文字列。完了したカスタム認証方法の IDを示すURL。

オブジェクト。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'} 
  });`

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

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

例

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

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

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

• otp
• recovery-code
• email
• push-notification
• otpFallback``trueに設定されている場合、ユーザーはプッシュ通知ファクターのOTPフォールバックオプションを使用できません。
• phone
• preferredMethod: voice
• preferredMethod: sms
• preferredMethod: both
• webauthn-platform
• webauthn-roaming

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

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

• otp
• recovery-code
• push-notification
• phone
• preferredMethod: voice
• preferredMethod: sms
• preferredMethod: both
• webauthn-platform
• webauthn-roaming

任意のオブジェクト。任意の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'
    }]
  })`

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

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

• otp
• recovery-code
• push-notification
• phone
• preferredMethod: voice
• preferredMethod: sms
• preferredMethod: both
• webauthn-platform
• webauthn-roaming

文字列 。トークンが発行される（subクレーム）べきユーザーのユーザーID。

文字列。キャッシュに保管されているレコードのキー。

文字列。キャッシュに保管されているレコードのキー。

文字列。キャッシュに保管されているレコードのキー。

文字列。保管するレコードの値。

任意のオブジェクト 。キャッシュの動作を調整するためのオプション。

任意の数値 。UNIXエポックからのミリ秒単位で指定した絶対有効期限です。キャッシュ済みのレコードは早期に削除されることはあっても、expires_atで指定された時点を過ぎて存続することはありません。

注意： この値がttlで指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。

任意の数値 。このキャッシュエントリーのミリ秒単位で指定した存続時間。キャッシュ済みのレコードは早期に削除されることはあっても、ttlで指定された時点を過ぎて存続することはありません。

注意： この値がexpires_atで指定されている場合は指定するべきではありません。両方で指定された場合、2つの中で早い方の有効期限が適用されます。

文字列 。クレームの名前（これは完全修飾URLが必要な場合があります）。

任意の値。クレームの値。

文字列 。使用する多要素認証プロバイダーの名前、またはanyの値を使用して、構成されたプロバイダーのいずれかを使用します。

次の値に対応しています。

• any任意の設定されたチャレンジを使用します。
• duoDuo多要素認証プロバイダーを使用します。
• google-authenticatorGoogle Authenticatorプロバイダーを使用します。
• guardianGuardianプロバイダーを使用します。
• noneMFAフローのトリガーを防ぐために設定されたチャレンジを使用しません。

任意のオブジェクト 。多要素認証チャレンジを有効にする追加のオプション。

任意のブール値 。プロバイダーがgoogle-authenticatorまたはduoに設定されている場合、ユーザーは30日ごとにMFAを促されます。プロバイダーがguardianに設定されている場合、MFAプロンプトが登録チェックボックスを表示して、 ユーザーに登録するかしないかを選択させます。デフォルトはfalseです。詳細はこちらをご覧ください：多要素認証ページをカスタマイズする

任意のオブジェクト 。チャレンジを設定する追加オプションで、duoプロバイダーに使用可能です。

対応オプションは次の通りです：

• host 文字列。これはDuoアカウントのAPIホスト名の値です。
• ikey 文字列 。これはDuoアカウントからのクライアントID（旧Integration key（統合キー））値です。
• skey 文字列 。これはDuoアカウントからのクライアントID（旧Secret key（シークレットキー））です。
• username 任意の文字列 。DuoSecurityのユーザー名として、いくつかのプロファイル属性を使用します。またこれは、Duoに登録されたユーザーを持っている場合に便利です。

文字列。メタデータプロパティの名前。

任意の値。メタデータプロパティの値。メタデータプロパティを 削除するためにnullに設定されていることがあります。

文字列。メタデータプロパティの名前。

任意の値 。メタデータプロパティの値。メタデータプロパティを削除するためにnullに設定されていることがあります。

オプション 。結果のURLのクエリパラメーターに機密データをどのように暗号化するのかを構成します。

数値。トークンが期限切れになるまでの秒数（デフォルトは900）。

オプション 。リダイレクト先に渡され、信頼性と整合性が証明可能であるべきデータ。

文字列 。リダイレクト先と共有され、JWTの署名に使用されるシークレット。シークレット値はシークレットとして保管され、event.secrets['SECRET_NAME']を使用して取得されなければなりません。

文字列。リダイレクト先のURL。

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

オプション 。リダイレクトURLに追加する追加のクエリ文字列パラメーター。

オプション 。リダイレクト後に、JWTトークンに含めて/continueエンドポイントに渡された暗号化済みのデータを取得するためのオプション。

文字列。トークンの暗号化に使用されたシークレット。

文字列 。/continueエンドポイントに送信されたクエリまたは本文のパラメーターの名前。デフォルト：session_token

文字列。確認するルールID。

文字列。設定されるSAML属性。

SAMLValue 。SAMLアサーションの値。属性プロパティを削除するためにnullに設定されていることがあります。

文字列。設定されるSAMLオーディエンス。

文字列。設定される公開鍵です。

文字列。設定されるSAML受信者です。

ブール値切り替えて、UPNクレームを作成します。

ブール値 クレームを出力アサーションにマッピングするかどうかを指定します。

ブール値クレームをそのままマッピングするかどうか。

ブール値IDをマッピングするかどうか。

文字列SAML応答の宛先。

数字トークンの有効期限（秒）。

ブール値SAML応答が署名されるべきかどうか。

文字列名前IDの形式

文字の配列名前識別子を取得するために試す属性の配列。

文字列AuthnContextClassRef。

文字列SAML要求の検証に使用される任意の公開鍵証明書。

ブール値NameFormatは属性名に基づいて推測するべきかどうか。

ブール値xs:typeが推測されるべきかどうか。

文字列SAMLアサーションの暗号化に使用される任意の証明書。

文字列SAML応答またはアサーションに署名する任意の証明書。

文字列SAML応答またはアサーションに署名する任意の秘密鍵。

rsa-sha256 | rsa-sha1。 rsa-sha1は使用すべきではありません。安全性に問題があります。

sha256 | sha1。 rsa-sha1は使用すべきではありません。安全性に問題があります。

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

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

例

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

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