Auth0

Auth0 の事前構築済みフローアクションを設定して、Management API へのリクエストやカスタム通知の送信を行う方法を説明します。

​

Auth0 Vault 接続を設定する

Auth0 Flow Actions で使用する Vault 接続の設定方法については、Auth0 Vault 接続を参照してください。

​

ユーザーの作成

ユーザーを作成します。

​

入力設定

パラメーター	説明
Body	追加する Auth0 ユーザーのプロパティを含むペイロードです。詳しくは、Create a user API ドキュメントを参照してください。

​

出力オブジェクト

レスポンスとステータスコードの詳細については、Create a userを参照してください。

​

ユーザーを取得

ユーザーの詳細を取得します。

​

入力設定

パラメーター	説明
ユーザー ID	取得するユーザーの ID。詳しくは、ユーザーを取得 の API ドキュメントを参照してください。

​

出力オブジェクト

想定されるレスポンスとステータスコードについては、ユーザーを取得を確認してください。

​

ユーザーを更新する

ユーザーを更新します。

​

入力設定

パラメーター	説明
ユーザー ID	更新するユーザーの ID。
Body	更新する Auth0 ユーザープロパティのペイロード。詳細については、Update a user API ドキュメントを参照してください。

​

出力オブジェクト

想定されるレスポンスとステータスコードについては、Update a user の API ドキュメントを参照してください。

​

カスタム API リクエスト

Auth0 API エンドポイントに、カスタム API リクエストを送信します。

​

入力設定

パラメーター	説明
Path	API エンドポイントの絶対パス名。 ( 例: /api/v2/organizations ) 注: 一部のエンドポイントでは、たとえば ユーザーを取得 のように、-、.、_、~ などの文字を使用する場合、英数字以外の文字を含むパラメーターを URI エンコードする必要があります。詳しくは 文字 を参照してください。 これには、encodeURIComponent 関数を使用できます。 {{ functions.encodeURIComponent(context.user.user_id) }}
Method	使用可能な HTTP メソッドは次のとおりです。 GET POST PUT PATCH DELETE
Body	リクエストの本文。
Headers	リクエストのヘッダー。
URL Params	URL パラメーター。これらのパラメーターは自動的に URL エンコードされます。

​

出力オブジェクト

想定されるレスポンスとステータスコードについては、Auth0 Management APIを確認してください。

​

通知

​

メールを送信

設定済みのメールプロバイダーを使用して、カスタムメールを送信します。

このActionを使用する前に、メールプロバイダーを有効にしておく必要があります。

​

入力設定

パラメーター	説明
カスタム送信元メールアドレスを使用	デフォルトでは、カスタマイズしたメールプロバイダーの設定で構成した送信元メールアドレスを使用します。別の送信元メールアドレスまたは送信者名を使用する場合は、このオプションを有効にします。
受信者のメールアドレス	受信者のメールアドレスです。
カスタム変数	メールテンプレートに挿入するカスタム変数を追加します。設定後は、{{custom_vars.your_variable_key}} を使用して参照できます。
件名	メールの件名です。カスタム変数と Liquid 構文をサポートします。
メッセージ	メールメッセージは HTML 形式で、Liquid 構文を使用でき、カスタム変数もサポートします。

件名とメッセージでは、Liquid 構文を共通変数と組み合わせて使用できます。また、{{custom_vars.your_variable_key}} 構文を使用してカスタム変数を利用することもできます。

カスタム変数を使用すると、Forms / Flows のコンテキストと件名およびメッセージの内容の間で情報を受け渡せます。

​

出力オブジェクト

Property	Type	Description
success	Boolean	実際に配信に成功したかどうかにかかわらず、メールが正常に送信キューへ追加されたかどうかを示します。

​

出力オブジェクトの例

{
  "success": true
}

​

SMSを送信

設定済みの電話プロバイダーを使用して、カスタムSMSを送信します。

このActionを使用する前に、テキストメッセージを配信できるように Phone Provider を有効にしておく必要があります。

​

入力設定

Parameter	Description
From	デフォルトでは、カスタマイズした電話プロバイダー設定で構成した送信元の電話番号を使用します。別の送信元電話番号を使用する場合は、カスタム値を入力してください。
To	送信先の電話番号。
Custom variables	電話テンプレートに挿入するカスタム変数を追加します。設定後は、{{custom_vars.your_variable_key}} を使用して参照できます。
Message	電話メッセージでは Liquid 構文を使用でき、カスタム変数もサポートされています。

Message では、Liquid 構文と 共通変数、または {{custom_vars.your_variable_key}} 構文を使用するカスタム変数を組み合わせて使用できます。

カスタム変数を使用すると、Forms / Flows コンテキストと Message の内容の間で情報を受け渡せます。

​

出力オブジェクト

Property	Type	Description
success	Boolean	配信の成否にかかわらず、電話メッセージが送信キューに正常に登録されたかどうかを示します。

​

出力オブジェクトの例

{
  "success": true
}

​

発信

設定済みの電話プロバイダーを使用して、カスタムの音声メッセージを送信します。

この Action を使用する前に、音声メッセージを配信できるように Phone Provider を有効にしておく必要があります。

​

入力設定

Parameter	Description
From	デフォルトでは、カスタマイズした電話プロバイダー設定で構成した送信元の電話番号が使用されます。別の送信元電話番号を使用する場合は、カスタム値を入力してください。
To	宛先の電話番号。
Custom variables	電話テンプレートに挿入するカスタム変数を追加します。設定後は、{{custom_vars.your_variable_key}} を使用して参照できます。
Message	電話メッセージでは Liquid 構文を使用でき、カスタム変数もサポートされています。

メッセージでは、Liquid 構文と 共通変数 を組み合わせて使用できます。また、{{custom_vars.your_variable_key}} 構文を使用してカスタム変数を参照することもできます。

カスタム変数を使用すると、Forms / Flows のコンテキストと Message の内容の間で情報を受け渡せます。

​

出力オブジェクト

Property	Type	Description
success	Boolean	配信の成否にかかわらず、電話メッセージの送信がキューに正常に登録されたかどうかを示します。

​

出力オブジェクトの例

{
  "success": true
}