Auth0
App · Compliance & Security · 20 actions
Create, find and update Auth0 users, manage roles and who holds them, send verification emails and password reset links, and read your tenant's connections, applications and sign-in logs.
Actions
| Action | What it does |
|---|---|
| Assign roles to user | Give a user one or more roles. |
| Create password reset link | Mint a one-time URL that lets a user set a new password. |
| Create role | Create a role the tenant's users can be given. |
| Create user | Create a user in one of the tenant's database connections, with an email address and a password. |
| Delete role | Permanently delete a role. |
| Delete user | Permanently delete a user and every role assignment they have. |
| Find users by email | Find every user with an email address, across all the tenant's connections. |
| Get daily statistics | Read how many sign-ins and sign-ups the tenant had per day, with the totals across the range. |
| Get user | Read one user's full profile, including their metadata. |
| List a role's members | Read which users hold a role. |
| List a user's roles | Read which roles one user currently holds. |
| List applications | List the tenant's applications and their callback URLs. |
| List connections | List the tenant's identity connections - its username-password databases, social logins and enterprise providers. |
| List roles | List the tenant's roles, optionally filtered by name. |
| List tenant log events | Read the tenant's log - sign-ins, failures and administrative changes. |
| List user log events | Read one user's own log events - sign-ins, failed attempts and profile changes. |
| List users | List the tenant's users, or search them with an Auth0 query like email:"ada@example.com" or name:Ada*. |
| Remove roles from user | Take one or more roles away from a user. |
| Send verification email | Ask Auth0 to email a user the link that verifies their address. |
| Update user | Change a user's profile, metadata, password or blocked status. |
Assign roles to user
Give a user one or more roles. Assigning a role they already hold changes nothing, so this is safe to re-run.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Roles
role_idslistRequired - One or more roles. Auth0 takes them together, so assigning three roles is one step rather than three.
Outputs
assignednumberrole_idsliststatustextuser_idtext
Example output
{
"assigned": 1,
"role_ids": [
"rol_9Kd2LmN4pQr7StU1"
],
"status": "success",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Create password reset link
Mint a one-time URL that lets a user set a new password. Anyone holding the link can use it, so treat it as a credential.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Redirect to
result_urltext - Where to send the user once they have set their password. Leave empty to show Auth0's own confirmation.
- Valid for (seconds)
ttl_secnumber - How long the link works, in seconds. Auth0's default is 432000 - five days. The most allowed here is 2592000 (30 days).From 1 to 2592000.
- Mark email verified when used
mark_email_as_verifiedtrue/false - Turn on to treat using the link as proof the user owns the address.
Outputs
statustexttickettextttl_secnumberuser_idtext
Example output
{
"status": "success",
"ticket": "https://example.us.auth0.com/lo/reset?ticket=aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY#",
"ttl_sec": 432000,
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Create role
Create a role the tenant's users can be given. Permissions are added to it in the Auth0 dashboard.
Inputs
- Role name
nametextRequired - What the role is called, such as Support agent.
- Description
descriptiontext - What the role is for, in one line.
Outputs
nametextroleobjectrole_idtextstatustext
Example output
{
"name": "Support agent",
"role": {
"description": "Can read tickets and reset passwords",
"id": "rol_9Kd2LmN4pQr7StU1",
"name": "Support agent"
},
"role_id": "rol_9Kd2LmN4pQr7StU1",
"status": "success"
}Create user
Create a user in one of the tenant's database connections, with an email address and a password.
Inputs
- Email address
emailtextRequired - The address the user signs in with.
- Password
passwordtextRequired - The user's initial password. It has to satisfy the tenant's password policy - by default at least 8 characters with a mix of cases, numbers and symbols - and Auth0 rejects one that appears in a known breach.
- Connection
connectiontext - Which database connection the user belongs in. Leave empty if the tenant has only one - Lodol will find it. Most tenants call theirs Username-Password-Authentication.
- Username
usernametext - A username, if the connection is set up to require one. Most are not - leave it empty unless yours is.
- First name
given_nametext - The user's first name.
- Last name
family_nametext - The user's last name.
- Full name
nametext - The name shown for this user in Auth0.
- Nickname
nicknametext - A short name for the user.
- Email already verified
email_verifiedtrue/false - Mark the address as verified without the user clicking anything. Only turn this on for an address you already trust.
- Send verification email
verify_emailtrue/false - Turn on to have Auth0 email the user a verification link as soon as they are created.
- Blocked
blockedtrue/false - Turn on to stop this user signing in, without deleting them.
- User metadata
user_metadataobject - Data the user is allowed to change, as a JSON object - for example {"theme": "dark"}. Auth0 merges this into whatever is already there rather than replacing it, and only at the top level.
- App metadata
app_metadataobject - Data only your applications can change, as a JSON object - for example {"plan": "pro"}. Merged the same way as user metadata.
Outputs
connectiontextemailtextstatustextuserobjectuser_idtext
Example output
{
"connection": "Username-Password-Authentication",
"email": "ada@example.com",
"status": "success",
"user": {
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
},
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Delete role
Permanently delete a role. Every user who holds it loses it. This cannot be undone.
Inputs
- Role
role_idtextRequired - Which role. Use List roles if the one you want is not offered.
Outputs
deletedtrue/falserole_idtextstatustext
Example output
{
"deleted": true,
"role_id": "rol_9Kd2LmN4pQr7StU1",
"status": "success"
}Delete user
Permanently delete a user and every role assignment they have. This cannot be undone.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
Outputs
deletedtrue/falsestatustextuser_idtext
Example output
{
"deleted": true,
"status": "success",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Find users by email
Find every user with an email address, across all the tenant's connections. Auth0 matches case-sensitively, and one address can belong to more than one user.
Inputs
- Email address
emailtextRequired - The address to look for. Auth0 matches it case-sensitively.
Outputs
countnumberemailtextstatustextuser_idslistuserslist
Example output
{
"count": 1,
"email": "ada@example.com",
"status": "success",
"user_ids": [
"auth0|68f0c1a2b3c4d5e6f7a8b9c0"
],
"users": [
{
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
}
]
}Get daily statistics
Read how many sign-ins and sign-ups the tenant had per day, with the totals across the range.
Inputs
- From
from_datedate - First day to include. Leave empty for Auth0's default window.
- To
to_datedate - Last day to include.
Outputs
countnumberdaysliststatustexttotal_loginsnumbertotal_signupsnumber
Example output
{
"count": 1,
"days": [
{
"created_at": "2026-09-02T00:04:11.000Z",
"date": "2026-09-02T00:00:00.000Z",
"leaked_passwords": 0,
"logins": 48,
"signups": 3,
"updated_at": "2026-09-02T23:58:02.000Z"
}
],
"status": "success",
"total_logins": 48,
"total_signups": 3
}Get user
Read one user's full profile, including their metadata.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
Outputs
statustextuserobjectuser_idtext
Example output
{
"status": "success",
"user": {
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
},
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}List a role's members
Read which users hold a role.
Inputs
- Role
role_idtextRequired - Which role. Use List roles if the one you want is not offered.
- How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falsepagenumberrole_idtextstatustexttotalnumberuserslist
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"role_id": "rol_9Kd2LmN4pQr7StU1",
"status": "success",
"total": 1,
"users": [
{
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
}
]
}List a user's roles
Read which roles one user currently holds.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falsepagenumberrole_idslistrolesliststatustexttotalnumberuser_idtext
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"role_ids": [
"rol_9Kd2LmN4pQr7StU1"
],
"roles": [
{
"description": "Can read tickets and reset passwords",
"id": "rol_9Kd2LmN4pQr7StU1",
"name": "Support agent"
}
],
"status": "success",
"total": 1,
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}List applications
List the tenant's applications and their callback URLs. Client secrets are never returned.
Inputs
- Kind
app_typetext - Only return applications of this kind.One of:
native(Native (mobile or desktop)),spa(Single-page web app),regular_web(Regular web app),non_interactive(Machine to machine). - Your own applications only
is_first_partytrue/false - Turn on to leave out third-party applications registered against this tenant.
- How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
client_idslistclientslistcountnumberhas_moretrue/falsepagenumberstatustexttotalnumber
Example output
{
"client_ids": [
"kX2m9QpL4vR7sT1nB6yD8fG3hJ5wZ0aC"
],
"clients": [
{
"app_type": "spa",
"callbacks": [
"https://portal.example.com/callback"
],
"client_id": "kX2m9QpL4vR7sT1nB6yD8fG3hJ5wZ0aC",
"grant_types": [
"authorization_code",
"refresh_token"
],
"is_first_party": true,
"name": "Customer portal"
}
],
"count": 1,
"has_more": false,
"page": 0,
"status": "success",
"total": 1
}List connections
List the tenant's identity connections - its username-password databases, social logins and enterprise providers.
Inputs
- Kind
strategytext - Only return connections of this kind.One of:
auth0(Username-password database),google-oauth2(Google),facebook,apple,github,linkedin,windowslive(Microsoft Account),twitter(X (Twitter)),email(Passwordless email),sms(Passwordless SMS), and 5 more. - Named
nametext - Only return the connection with exactly this name.
- How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
connection_nameslistconnectionslistcountnumberhas_moretrue/falsepagenumberstatustexttotalnumber
Example output
{
"connection_names": [
"Username-Password-Authentication"
],
"connections": [
{
"display_name": "Email and password",
"enabled_clients": [
"kX2m9QpL4vR7sT1nB6yD8fG3hJ5wZ0aC"
],
"id": "con_8Hj3KlM5nPq2RsT4",
"is_domain_connection": false,
"name": "Username-Password-Authentication",
"strategy": "auth0"
}
],
"count": 1,
"has_more": false,
"page": 0,
"status": "success",
"total": 1
}List roles
List the tenant's roles, optionally filtered by name.
Inputs
- Name contains
name_filtertext - Only return roles whose name contains this. Auth0 ignores case, and never matches on the description.
- How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falsepagenumberrolesliststatustexttotalnumber
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"roles": [
{
"description": "Can read tickets and reset passwords",
"id": "rol_9Kd2LmN4pQr7StU1",
"name": "Support agent"
}
],
"status": "success",
"total": 1
}List tenant log events
Read the tenant's log - sign-ins, failures and administrative changes. Free tenants keep only the last couple of days.
Inputs
- Search
querytext - An Auth0 log query, such as type:f for failed logins or user_id:"auth0|68f0...". Leave empty for everything. Auth0 caps a search at 100 entries per request and 1000 in total.
- Order
sort_ordertext - Which end of the range to start from.One of:
asc(Oldest / lowest first),desc(Newest / highest first). - How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falselogslistpagenumberstatustexttotalnumber
Example output
{
"count": 1,
"has_more": false,
"logs": [
{
"client_id": "kX2m9QpL4vR7sT1nB6yD8fG3hJ5wZ0aC",
"client_name": "Customer portal",
"connection": "Username-Password-Authentication",
"date": "2026-09-02T11:03:41.882Z",
"description": "Successful login",
"ip": "203.0.113.14",
"log_id": "90020260902110341882000000000000000000000000000",
"strategy": "auth0",
"type": "s",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_name": "ada@example.com"
}
],
"page": 0,
"status": "success",
"total": null
}List user log events
Read one user's own log events - sign-ins, failed attempts and profile changes. A user who has never signed in returns nothing.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Order
sort_ordertext - Which end of the range to start from.One of:
asc(Oldest / lowest first),desc(Newest / highest first). - How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falselogslistpagenumberstatustexttotalnumberuser_idtext
Example output
{
"count": 1,
"has_more": false,
"logs": [
{
"client_id": "kX2m9QpL4vR7sT1nB6yD8fG3hJ5wZ0aC",
"client_name": "Customer portal",
"connection": "Username-Password-Authentication",
"date": "2026-09-02T11:03:41.882Z",
"description": "Successful login",
"ip": "203.0.113.14",
"log_id": "90020260902110341882000000000000000000000000000",
"strategy": "auth0",
"type": "s",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_name": "ada@example.com"
}
],
"page": 0,
"status": "success",
"total": null,
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}List users
List the tenant's users, or search them with an Auth0 query like email:"ada@example.com" or name:Ada*.
Inputs
- Search
querytext - An Auth0 search query, such as email:"ada@example.com", name:Ada* or logins_count:[10 TO *]. Leave empty to list everyone. Auth0 can only page through the first 1000 matches, so narrow the search rather than paging past that.
- Sort by
sort_fieldtext - Which field to order the results on.One of:
created_at(Created),updated_at(Last updated),last_login(Last sign-in),logins_count(Number of sign-ins),email(Email address),name. - Order
sort_ordertext - Which end of the range to start from.One of:
asc(Oldest / lowest first),desc(Newest / highest first). - How many
limitnumber - How many records to return, up to 100. Defaults to 25.From 1 to 100.
- Page
pagenumber - Which page of results, counting from 0.At least 0.
Outputs
countnumberhas_moretrue/falsepagenumberstatustexttotalnumberuserslist
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"status": "success",
"total": 1,
"users": [
{
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
}
]
}Remove roles from user
Take one or more roles away from a user.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Roles
role_idslistRequired - One or more roles. Auth0 takes them together, so assigning three roles is one step rather than three.
Outputs
removednumberrole_idsliststatustextuser_idtext
Example output
{
"removed": 1,
"role_ids": [
"rol_9Kd2LmN4pQr7StU1"
],
"status": "success",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Send verification email
Ask Auth0 to email a user the link that verifies their address. This starts a job, so a success means Auth0 accepted the request rather than that the mail has arrived.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Application
client_idtext - Which application's branding and redirect the email should use. Leave empty to use the tenant's default.
Outputs
jobobjectjob_idtextstatustextuser_idtext
Example output
{
"job": {
"created_at": "2026-09-02T11:04:00.000Z",
"id": "job_7Yt3RmK9pL2wQx4V",
"status": "pending",
"type": "verification_email"
},
"job_id": "job_7Yt3RmK9pL2wQx4V",
"status": "success",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}Update user
Change a user's profile, metadata, password or blocked status. Auth0 will not change the password, username and email in one request, so use a step for each.
Inputs
- User
user_idtextRequired - The user's Auth0 id, like auth0|68f0c1a2b3c4d5e6f7a8b9c0 - including the vertical bar. Use List users or Find users by email to get one.
- Email address
emailtext - A new address. Auth0 will not change this in the same step as the password or username, and it needs the Connection field filled in.
- Password
passwordtext - A new password. Needs the Connection field, and cannot be changed in the same step as the email or username.
- Username
usernametext - A new username. Needs the Connection field, and cannot be changed in the same step as the email or password.
- Connection
connectiontext - Required only when changing the email, username, password or verified flag - Auth0 needs to know which identity to write to. It is on the user's record as identities[0].connection.
- First name
given_nametext - The user's first name.
- Last name
family_nametext - The user's last name.
- Full name
nametext - The name shown for this user in Auth0.
- Nickname
nicknametext - A short name for the user.
- Email already verified
email_verifiedtrue/false - Mark the address as verified without the user clicking anything. Only turn this on for an address you already trust.
- Blocked
blockedtrue/false - Turn on to stop this user signing in, without deleting them.
- User metadata
user_metadataobject - Data the user is allowed to change, as a JSON object - for example {"theme": "dark"}. Auth0 merges this into whatever is already there rather than replacing it, and only at the top level.
- App metadata
app_metadataobject - Data only your applications can change, as a JSON object - for example {"plan": "pro"}. Merged the same way as user metadata.
Outputs
statustextupdated_fieldslistuserobjectuser_idtext
Example output
{
"status": "success",
"updated_fields": [
"given_name"
],
"user": {
"app_metadata": {},
"blocked": false,
"created_at": "2026-08-01T09:14:22.114Z",
"email": "ada@example.com",
"email_verified": true,
"family_name": "Lovelace",
"given_name": "Ada",
"identities": [
{
"connection": "Username-Password-Authentication",
"isSocial": false,
"provider": "auth0",
"user_id": "68f0c1a2b3c4d5e6f7a8b9c0"
}
],
"last_login": "2026-09-02T11:03:41.882Z",
"logins_count": 14,
"name": "Ada Lovelace",
"nickname": "ada",
"updated_at": "2026-09-02T11:03:41.882Z",
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0",
"user_metadata": {}
},
"user_id": "auth0|68f0c1a2b3c4d5e6f7a8b9c0"
}