Auth0

Auth0 の事前構築済みのフローアクションを設定して、Management API にリクエストを送信したり、カスタム通知を送信したりする方法を学びます。

​

Auth0 Vault 接続を設定する

Auth0 フローの Actions 用の Vault 接続を設定する方法については、Auth0 Vault Connectionをご覧ください。

​

Create user

ユーザーを作成します。

​

入力設定

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

​

出力オブジェクト

想定されるレスポンスとステータスコードについては、ユーザーの作成を参照してください。

​

Get User

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

​

入力設定

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

​

出力オブジェクト

想定されるレスポンスとステータスコードについては、Get a userを参照してください。

​

ユーザーを更新

ユーザーを更新します。

​

入力設定

パラメータ	説明
User ID	更新するユーザーの ID。
Body	更新する Auth0 ユーザープロパティのペイロードです。詳しくは、ユーザーを更新 API ドキュメントをご覧ください。

​

出力オブジェクト

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

​

カスタム API リクエスト

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

​

入力設定

パラメーター	説明
パス	APIエンドポイントの絶対パス名。 ( 例: /api/v2/organizations ) 注: 一部のエンドポイントでは、たとえば Get a user のように、-、.、_、~ などの英数字以外の 文字 を使用する場合、URIエンコードされたパラメーターが必要です。 その場合は、encodeURIComponent 関数を使用できます。 {{ functions.encodeURIComponent(context.user.user_id) }}
メソッド	使用可能なHTTPメソッドは次のとおりです。 GET POST PUT PATCH DELETE
ボディ	リクエストのボディ。
ヘッダー	リクエストのヘッダー。
URL Params	URLパラメーター。これらのパラメーターは自動的にURLエンコードされます。

​

出力オブジェクト

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

​

通知

​

メールを送信

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

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

​

入力設定

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

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

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

​

出力オブジェクト

プロパティ	型	説明
success	Boolean	配信に成功したかどうかにかかわらず、メール送信が正常にキューに追加されたかどうかを示します。

​

出力オブジェクトの例

{
  "success": true
}

​

SMSを送信

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

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

​

入力設定

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

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

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

​

出力オブジェクト

プロパティ	型	説明
success	Boolean	配信の成否にかかわらず、電話メッセージが送信待ちキューに正常に追加されたかどうかを示します。

​

Output objectの例

{
  "success": true
}

​

通話をかける

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

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

​

入力設定

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

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

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

​

出力オブジェクト

Property	Type	Description
success	Boolean	電話メッセージが送信待ちキューに正常に追加されたかどうかを示します。実際に配信に失敗したかどうかは問いません。

​

出力オブジェクトの例

{
  "success": true
}