How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 users API

The users API from Auth0 — 23 operation(s) for users.

Auth0 users API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 37 operations across 23 paths, and defines 101 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

37 operations 23 paths 101 schemas 11 DELETE14 GET2 PATCH9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 37

Across 23 paths, the API surfaces 37 operations — 11 DELETE, 14 GET, 2 PATCH, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

users 37
GET
/users
List or Search Users
get_users 10 params → 200400401403429503
POST
/users
Create a User
post_users body → 201400401403409429
GET
/users/{id}
Get a User
get_users_by_id 3 params → 200400401403404429
DELETE
/users/{id}
Delete a User
delete_users_by_id 1 param → 204400401403429
PATCH
/users/{id}
Update a User
patch_users_by_id 1 param body → 200400401403404429
GET
/users/{id}/authentication-methods
Get a List of Authentication Methods
get_authentication-methods 4 params → 200400401403404429
DELETE
/users/{id}/authentication-methods
Delete All Authentication Methods for the Given User
delete_authentication-methods 1 param → 204400401403429
POST
/users/{id}/authentication-methods
Creates an Authentication Method for a Given User
post_authentication-methods 1 param body → 201400401403404409429
PUT
/users/{id}/authentication-methods
Update All Authentication Methods by Replacing Them with the Given Ones
put_authentication-methods 1 param body → 200400401403409429
GET
/users/{id}/authentication-methods/{authentication_method_id}
Get an Authentication Method by ID
get_authentication-methods_by_authentication_method_id 2 params → 200400401403404429
DELETE
/users/{id}/authentication-methods/{authentication_method_id}
Delete an Authentication Method by ID
delete_authentication-methods_by_authentication_method_id 2 params → 204400401403404429
PATCH
/users/{id}/authentication-methods/{authentication_method_id}
Update an Authentication Method
patch_authentication-methods_by_authentication_method_id 2 params body → 200400401403404429
DELETE
/users/{id}/authenticators
Delete All Authenticators
delete_authenticators 1 param → 204400401403429
GET
/users/{id}/connected-accounts
Get a User's Connected Accounts
get_connected-accounts 3 params → 200400401403429
GET
/users/{id}/enrollments
Get the First Confirmed Multi-factor Authentication (MFA) Enrollment
get_enrollments 1 param → 200400401403404429
GET
/users/{id}/federated-connections-tokensets
Get Tokensets for a User
get_federated-connections-tokensets 1 param → 200401403404429
DELETE
/users/{id}/federated-connections-tokensets/{tokenset_id}
Deletes a Tokenset for Federated Connections by Id.
delete_federated-connections-tokensets_by_tokenset_id 2 params → 204400401403429
GET
/users/{id}/groups
Get User's Groups
get_user_groups 8 params → 200400401403429
POST
/users/{id}/identities
Link a User Account
post_identities 1 param body → 201400401403409429
DELETE
/users/{id}/identities/{provider}/{user_id}
Unlink a User Identity
delete_user_identity_by_user_id 3 params → 200400401403429
GET
/users/{id}/logs
Get User's Log Events
get_logs_by_user 5 params → 200400401403429
POST
/users/{id}/multifactor/actions/invalidate-remember-browser
Invalidate All Remembered Browsers for Multi-factor Authentication (MFA)
post_invalidate-remember-browser 1 param → 204400401403
DELETE
/users/{id}/multifactor/{provider}
Delete a User's Multi-factor Provider
delete_multifactor_by_provider 2 params → 204400401403404429
GET
/users/{id}/organizations
List User's Organizations
get_user_organizations 4 params → 200401403429
GET
/users/{id}/permissions
Get a User's Permissions
get_permissions 4 params → 200400401403404429
DELETE
/users/{id}/permissions
Remove Permissions from a User
delete_permissions 1 param body → 204400401403429
POST
/users/{id}/permissions
Assign Permissions to a User
post_permissions 1 param body → 201400401403429
POST
/users/{id}/recovery-code-regeneration
Generate New Multi-factor Authentication (MFA) Recovery Code
post_recovery-code-regeneration 1 param → 200400401403404
POST
/users/{id}/revoke-access
Revokes Selected Resources from a User
user_revoke_access 1 param body → 202400401403429
POST
/users/{id}/risk-assessments/clear
Clear Risk Assessment Assessors for a Specific User
post_clear_assessors 1 param body → 204400401403429
GET
/users/{id}/roles
Get a User's Roles
get_user_roles 4 params → 200401403429
DELETE
/users/{id}/roles
Removes Roles from a User
delete_user_roles 1 param body → 204401403429
POST
/users/{id}/roles
Assign Roles to a User
post_user_roles 1 param body → 204400401403429
GET
/users/{user_id}/refresh-tokens
Get Refresh Tokens for a User
get_refresh_tokens_for_user 4 params → 200401403404429
DELETE
/users/{user_id}/refresh-tokens
Delete Refresh Tokens for a User
delete_refresh_tokens_for_user 1 param → 202400401403404429
GET
/users/{user_id}/sessions
Get Sessions for User
get_sessions_for_user 4 params → 200401403404429
DELETE
/users/{user_id}/sessions
Delete Sessions for User
delete_sessions_for_user 1 param → 202400401403404429

Schemas 101

The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are GetUserResponseContent (21 properties), CreateUserResponseContent (21 properties), Log (21 properties), UpdateUserResponseContent (21 properties). Each schema is shown below with its type and property counts.

SetUserAuthenticationMethodResponseContent
object
The successfully created authentication method.
13 properties 1 required
ConnectedAccountAccessTypeEnum
string
The access type for the connected account.
UserEnrollmentAuthMethodEnum
string
Authentication method for this enrollment. Can be authenticator, guardian, sms, webauthn-roaming, or webauthn-platform.
RefreshTokenMetadata
objectnull
Metadata associated with the refresh token, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
LogLocationInfo
object
Information about the location that triggered this event based on the ip.
8 properties
RefreshTokenSessionId
stringnull
ID of the authenticated session used to obtain this refresh-token
Log
object
21 properties
SessionDeviceMetadata
object
Metadata related to the device used in the session
6 properties
ListUserPermissionsResponseContent
ListUserRolesOffsetPaginatedResponseContent
object
4 properties
UserProfileData
object
8 properties
DeleteUserPermissionsRequestContent
object
1 property 1 required
LogDate
SearchEngineVersionsEnum
string
The version of the search engine
TokenQuota
object
1 property 1 required
UsersEnrollment
object
9 properties
UserEnrollmentStatusEnum
string
Status of this enrollment. Can be pending or confirmed.
UpdateUserAuthenticationMethodResponseContent
object
The successfully created authentication method.
14 properties 1 required
UserAppMetadataSchema
object
User metadata to which this user has read-only access.
Organization
object
6 properties
CreateUserResponseContent
object
21 properties
LogDateObject
object
Date when the event occurred in ISO 8601 format.
OrganizationMetadata
object
Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
UserResponseSchema
object
21 properties
RefreshTokenDate
UpdateUserRequestContent
object
18 properties
ListUsersResponseContent
RegenerateUsersRecoveryCodeResponseContent
object
1 property
SessionIp
stringnull
First IP address associated with this session
UserIdentity
object
8 properties 3 required
AssessorsTypeEnum
string
Assessors to clear.
TokenQuotaClientCredentials
object
The token quota configuration
3 properties
SetUserAuthenticationMethodsRequestContent
array
SessionAuthenticationSignal
object
Authentication signal details
3 properties
ListUserSessionsPaginatedResponseContent
object
2 properties
CreatedAuthenticationMethodTypeEnum
string
SessionCookieMetadataModeEnum
string
[Private Early Access] The persistence mode of the session cookie. When set to "non-persistent" (ephemeral), the cookie will be deleted when the browser is clo…
UserGroupsResponseSchema
ListUserOrganizationsResponseContent
SessionMetadata
objectnull
Metadata associated with the session, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
GetUserAuthenticationMethodResponseContent
object
20 properties 3 required
GetUserGroupsPaginatedResponseContent
object
5 properties 1 required
SetUserAuthenticationMethods
object
6 properties 1 required
Group
object
Represents the metadata of a group. Member lists are retrieved via a separate endpoint.
7 properties
LogDetails
object
Additional useful details about this event (structure is dependent upon event type).
UserPermissionSchema
object
5 properties
RevokeUserAccessRequestContent
object
2 properties
ListUserOrganizationsOffsetPaginatedResponseContent
object
4 properties
LinkUserIdentityRequestContent
object
4 properties
UpdateUserResponseContent
object
21 properties
RefreshTokenResourceServer
object
2 properties
CreateUserRequestContent
object
17 properties 1 required
CreatedUserAuthenticationMethodTypeEnum
string
ListRefreshTokensPaginatedResponseContent
object
2 properties
SessionClientMetadata
object
Client details
1 property
AssignUserRolesRequestContent
object
1 property 1 required
ListUserRolesResponseContent
ListUserConnectedAccountsResponseContent
object
2 properties 1 required
UserMetadataSchema
object
User metadata to which this user has read/write access.
AuthenticationTypeEnum
string
RefreshTokenDevice
object
Device used while issuing/exchanging the refresh token
6 properties
PreferredAuthenticationMethodEnum
string
Applies to phone authentication methods only. The preferred communication method.
UserAuthenticationMethodPropertiesEnum
string
Role
object
3 properties
AuthenticationMethodTypeEnum
string
SessionAuthenticationSignals
object
Details about authentication signals obtained during the login flow
1 property
AppMetadata
object
Data related to the user that does affect the application's core functionality.
CreateUserPermissionsRequestContent
object
1 property 1 required
GetUserResponseContent
object
21 properties
LogSecurityContext
object
Information about security-related signals.
2 properties
SessionCookieMetadata
object
[Private Early Access] Session cookie configuration.
1 property
UserIdentityProviderEnum
string
The type of identity provider
ConnectedAccount
object
9 properties 6 required
UserMultifactorProviderEnum
string
The multi-factor provider. Supported values 'duo' or 'google-authenticator'
CreateUserAuthenticationMethodRequestContent
object
9 properties 1 required
UpdateUserAuthenticationMethodRequestContent
object
2 properties
UserId
userid of the secondary user account being linked.
DeleteUserRolesRequestContent
object
1 property 1 required
UserListLogOffsetPaginatedResponseContent
object
5 properties
PermissionRequestPayload
object
2 properties 2 required
UserAuthenticationMethodProperties
object
2 properties
ListUsersOffsetPaginatedResponseContent
object
5 properties
CreateUserAuthenticationMethodResponseContent
object
The successfully created authentication method.
13 properties 1 required
UserMetadata
object
Data related to the user that does not affect the application's core functionality.
UserAuthenticationMethod
object
20 properties 3 required
DeleteUserIdentityResponseContent
array
An array of objects with information about the user's identities.
RefreshTokenResponseContent
object
12 properties
FederatedConnectionTokenSet
object
6 properties
GetUserGroupsResponseContent
SessionDate
RefreshTokenDateObject
object
The date and time when the refresh token was created
UserIdentitySchema
object
8 properties
OrganizationBrandingColors
object
Color scheme used to customize the login pages.
2 properties 2 required
OrganizationBranding
object
Theme defines how to style the login pages.
2 properties
ClearAssessorsRequestContent
object
2 properties 2 required
ListUserPermissionsOffsetPaginatedResponseContent
object
4 properties
SessionResponseContent
object
13 properties
ListUserAuthenticationMethodsResponseContent
UserDateSchema
ListUserAuthenticationMethodsOffsetPaginatedResponseContent
object
4 properties
UserListLogResponseContent

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-users-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 attack-protection API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Where this information came from

This is an independent, third-party profile of Auth0 users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.