Users

Get user

Get user data for the given ID.

get/api/users/{userId}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/users/{userId}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

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, and always omitted when the request carries the logto-read-only-access: true header.

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
cimdClientIdstring nullable required

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId.

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.

passwordAlgorithm'Argon2i' | 'Argon2id' | 'Argon2d' | 'SHA1' | 'SHA256' | 'MD5' | 'Bcrypt' | 'Legacy' nullable

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.

Changes