> ## Documentation Index
> Fetch the complete documentation index at: https://auth0-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Learn how to configure your Auth0 pre-built flow actions to make requests against the Management API or send custom notifications.

# Auth0

## Configure your Auth0 Vault Connection

Learn how to configure a Vault Connection for your Auth0 Flow Actions at [Auth0 Vault Connection](/docs/customize/forms/vaults/auth0).

## Create user

Create a user.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/cdy7uua7fh8z/6MQIKf2IpTtI2g7d5Pwn7u/222ec746cf9c0c1003d18ba4c0aa451e/create_user.png" alt="" />
</Frame>

### Input settings

| Parameter | Description                                                                                                                                                    |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Body      | The payload of Auth0 user properties to add. To learn more, read [Create a user](https://auth0.com/docs/api/management/v2/users/post-users) API documentation. |

### Output object

Review [Create a user](https://auth0.com/docs/api/management/v2/users/post-users#response-messages) for expected response and status code.

## Get user

Retrieve user details.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/cdy7uua7fh8z/3GoNZsXOvMTYRtMQNj00mm/6e92d94cee7b165479c688358a5df242/Screenshot_2024-11-18_at_16.31.49.png" alt="" />
</Frame>

### Input settings

| Parameter | Description                                                                                                                                     |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| User ID   | ID of the user to retrieve. To learn more, read [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id) API documentation. |

### Output object

Review [Get a user](https://auth0.com/docs/api/management/v2/users/get-users-by-id#response-messages) for expected response and status code.

## Update user

Update a user.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/cdy7uua7fh8z/3tymSpaeod6EksWRJp1sge/1122b244d756d754fe41baac209a132b/Screenshot_2024-11-18_at_16.49.56.png" alt="" />
</Frame>

### Input settings

| Parameter | Description                                                                                                                                                              |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| User ID   | ID of the user to update.                                                                                                                                                |
| Body      | The payload of Auth0 user properties to update. To learn more, read [Update a user](https://auth0.com/docs/api/management/v2/users/patch-users-by-id) API documentation. |

### Output object

You can find the expected response and status codes at [Update a user](https://auth0.com/docs/api/management/v2/users/patch-users-by-id#response-messages) API documentation.

## Custom API request

Send a custom API request to Auth0 API endpoints.

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/cdy7uua7fh8z/66uV9iuhwfnXUdE1quLOyx/2ae3ff26335acbcd172cbb40618a5a90/Screenshot_2025-01-24_at_18.50.26.png" alt="Dashboard > Customize > Flows > Integrations > Auth0" />
</Frame>

### Input settings

| Parameter  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Path       | The API endpoint absolute pathname.<br />( Example: `/api/v2/organizations` )<br />**Note:** Some endpoints, for example: [ Get a user ](https://auth0.com/docs/api/management/v2/users/get-users-by-id), require URI encoded parameters when not using alphanumeric characters, such as: `-`, `.`, `_`, or `~`, [ characters ](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3)).<br />To do this, you can use the encodeURIComponent function:<br />`{{ functions.encodeURIComponent(context.user.user_id) }}` |
| Method     | Available HTTP methods include: <ul> <li>`GET`</li> <li>`POST`</li> <li>`PUT`</li> <li>`PATCH`</li> <li>`DELETE`</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                |
| Body       | The body of the request.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Headers    | The headers of the request.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| URL Params | The URL parameters. These parameters are automatically URL-encoded.                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

### Output object

Review [Auth0 Management API](https://auth0.com/docs/api/management/v2/introduction) for expected responses and status codes.

## Notifications

## Send email

Send a custom email using your [configured email provider](/docs/customize/email).

<Warning>
  [Email Provider](/docs/customize/email) must be enabled before using this Action.
</Warning>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/forms/flows/integrations/auth0-notifications-send-email.png" alt="" />
</Frame>

### Input settings

| Parameter               | Description                                                                                                                                                                      |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Use custom sender email | By default, we will use the sender email you have configured in your customized email provider settings. Enable this option if you want to use a different sender email or name. |
| Recipient email         | The recipient’s email.                                                                                                                                                           |
| Custom variables        | Add custom variables to be inserted in your email template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`.                                   |
| Subject                 | The email subject. Supports custom variables and Liquid syntax.                                                                                                                  |
| Message                 | The email message is in HTML format, uses Liquid syntax, and supports custom variables.                                                                                          |

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  Subject and Message can use a combination of Liquid syntax with [common variables](https://auth0.com/docs/customize/email/email-templates/supported-liquid-syntax) or custom variables using `{{custom_vars.your_variable_key}}` syntax.

  Use custom variables to pass information between Forms / Flows context and Subject and Message content.
</Callout>

### Output object

| Property | Type    | Description                                                                                                  |
| -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| success  | Boolean | Indicates if the email was successfully queued to be sent, regardless of whether the delivery failed or not. |

### Output object example

```json theme={null}
{
  "success": true
}
```

## Send SMS

Send a custom SMS using your [configured phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).

<Warning>
  [Phone Provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) must be enabled for text message delivery before using this Action.
</Warning>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/forms/flows/integrations/auth0-notifications-send-sms.png" alt="" />
</Frame>

### Input settings

| Parameter        | Description                                                                                                                                                                              |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| From             | By default, we will use the sender phone number you have configured in your customized phone provider settings. Input a custom value if you want to use a different sender phone number. |
| To               | The recipient’s phone number.                                                                                                                                                            |
| Custom variables | Add custom variables to be inserted in your phone template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`.                                           |
| Message          | The phone message uses Liquid syntax and supports custom variables.                                                                                                                      |

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  Message can use a combination of Liquid syntax with [common variables](https://auth0.com/docs/customize/email/email-templates/supported-liquid-syntax) or custom variables using `{{custom_vars.your_variable_key}}` syntax.

  Use custom variables to pass information between Forms / Flows context and Message content.
</Callout>

### Output object

| Property | Type    | Description                                                                                                          |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| success  | Boolean | Indicates if the phone message was successfully queued to be sent, regardless of whether the delivery failed or not. |

### Output object example

```json theme={null}
{
  "success": true
}
```

## Make call

Send a custom voice message using your [configured phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).

<Warning>
  [Phone Provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) must be enabled  for voice message delivery before using this Action.
</Warning>

<Frame>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/auth0-docs-event-stream-action-templates/docs/images/forms/flows/integrations/auth0-notifications-make-call.png" alt="" />
</Frame>

### Input settings

| Parameter        | Description                                                                                                                                                                              |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| From             | By default, we will use the sender phone number you have configured in your customized phone provider settings. Input a custom value if you want to use a different sender phone number. |
| To               | The recipient’s phone number.                                                                                                                                                            |
| Custom variables | Add custom variables to be inserted in your phone template. Once configured, you can reference them using `{{custom_vars.your_variable_key}}`.                                           |
| Message          | The phone message uses Liquid syntax and supports custom variables.                                                                                                                      |

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
  Message can use a combination of Liquid syntax with [common variables](https://auth0.com/docs/customize/email/email-templates/supported-liquid-syntax) or custom variables using `{{custom_vars.your_variable_key}}` syntax.

  Use custom variables to pass information between Forms / Flows context and Message content.
</Callout>

### Output object

| Property | Type    | Description                                                                                                          |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| success  | Boolean | Indicates if the phone message was successfully queued to be sent, regardless of whether the delivery failed or not. |

### Output object example

```json theme={null}
{
  "success": true
}
```
