v1

latestOpenAPI 3.0.12026-08-0435481.5 MB

Users

Get user

Get user data for the given ID.

get/api/users/{userId}

Path parameters

userIdstring required

The unique identifier of the user.

Query parameters

includeSsoIdentitiesstring

If it's provided with a truthy value (true, 1, yes), each user in the response will include a ssoIdentities property containing a list of SSO identities associated with the user.

includePasswordHashstring

If it's provided with a truthy value (true, 1, yes), the response will include the passwordDigest and passwordAlgorithm fields. These fields are omitted by default for security reasons.

Response

User data for the given ID.

idstring required

usernamestring nullable required

primaryEmailstring nullable required

primaryPhonestring nullable required

namestring nullable required

avatarstring nullable required

customDataobject required

arbitrary

identitiesobject required

lastSignInAtnumber nullable required

createdAtnumber required

updatedAtnumber required

applicationIdstring nullable required

isSuspendedboolean required

hasPasswordboolean

hasSecurityVerificationMethodboolean

passwordDigeststring nullable

The hashed password of the user. Only present when includePasswordHash is provided with a truthy value. null if the user has no password set.

The algorithm used to hash the password. Only present when includePasswordHash is provided with a truthy value. null if the user has no password set.