← Tools Reference

Auth0 Management

Auth0 Management integration (Security). Imported from open-connector.

API key15 toolshttps://{domain}/{auth0_api_segment}
GET
auth0_management_list_users
List Auth0 users with pagination and optional Lucene search query.

/users

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
querystringoptionalAuth0 user search query in Lucene syntax.
GET
auth0_management_search_users_by_email
Search Auth0 users by email with the official users-by-email endpoint.

/users-by-email

1 parameter
ParamTypeRequiredDescription
emailstringrequiredThe email address to search for.
GET
auth0_management_get_user
Retrieve one Auth0 user by user ID.

/users/{userId}

1 parameter
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
GET
auth0_management_list_roles
List Auth0 roles with pagination and optional name filter.

/roles

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
nameFilterstringoptionalA role name filter passed to Auth0 as name_filter.
GET
auth0_management_get_role
Retrieve one Auth0 role by role ID.

/roles/{roleId}

1 parameter
ParamTypeRequiredDescription
roleIdstringrequiredThe Auth0 role ID, such as rol_abc123.
GET
auth0_management_list_user_roles
List Auth0 roles assigned to a user.

/users/{userId}/roles

4 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
GET
auth0_management_list_user_permissions
List permissions directly assigned to an Auth0 user.

/users/{userId}/permissions

4 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
GET
auth0_management_list_user_effective_permissions
List Auth0 permissions granted to a user directly or through roles or groups.

/users/{userId}/effective-permissions

4 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
GET
auth0_management_list_user_effective_roles
List Auth0 roles granted to a user directly or through group membership.

/users/{userId}/effective-roles

4 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
POST
auth0_management_assign_roles_to_user
Assign one or more Auth0 roles to a user.

/users/{userId}/roles

2 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
roleIdsarrayrequiredAuth0 role IDs to assign or remove.
DELETE
auth0_management_remove_roles_from_user
Remove one or more Auth0 roles from a user.

/users/{userId}/roles

2 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Auth0 user ID, such as auth0|abc123.
roleIdsarrayrequiredAuth0 role IDs to assign or remove.
GET
auth0_management_list_role_permissions
List permissions granted by an Auth0 role.

/roles/{roleId}/permissions

4 parameters
ParamTypeRequiredDescription
roleIdstringrequiredThe Auth0 role ID, such as rol_abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
POST
auth0_management_add_permissions_to_role
Associate one or more Auth0 permissions with a role.

/roles/{roleId}/permissions

2 parameters
ParamTypeRequiredDescription
roleIdstringrequiredThe Auth0 role ID, such as rol_abc123.
permissionsarrayrequiredAuth0 permissions to associate with or remove from the role.
DELETE
auth0_management_remove_permissions_from_role
Remove one or more Auth0 permissions from a role.

/roles/{roleId}/permissions

2 parameters
ParamTypeRequiredDescription
roleIdstringrequiredThe Auth0 role ID, such as rol_abc123.
permissionsarrayrequiredAuth0 permissions to associate with or remove from the role.
GET
auth0_management_list_role_users
List users assigned to an Auth0 role with offset or checkpoint pagination.

/roles/{roleId}/users

6 parameters
ParamTypeRequiredDescription
roleIdstringrequiredThe Auth0 role ID, such as rol_abc123.
pageintegeroptionalZero-based Auth0 page number to request.
perPageintegeroptionalThe number of Auth0 records to return per page.
includeTotalsbooleanoptionalWhether Auth0 should return a totals wrapper.
fromstringoptionalAuth0 checkpoint pagination cursor.
takeintegeroptionalThe number of Auth0 users to retrieve with checkpoint pagination.