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.
The identity and technical contract details declared by the specification.
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
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
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
UpdateUserRequestContent
object
18 properties
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…
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
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
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
ListUserAuthenticationMethodsOffsetPaginatedResponseContent
object
4 properties
UserListLogResponseContent
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Auth0 publishes across the network.