STstytch
User

Get

Changed on

Get information about a specific User.

get/v1/users/{user_id}

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Path parameters

user_idstring required

The unique ID of a specific User. You may use an external_id here if one is set for the user.

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

user_idstring required

The unique ID of the returned User.

statusstring required

The status of the User. The possible values are pending and active.

is_lockedboolean required
rolesstring[] required

Roles assigned to this User. See the RBAC guide for more information about role assignment.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

created_atstring

The timestamp of the User's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.

trusted_metadataobject

The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.

untrusted_metadataobject

The untrusted_metadata field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and cannot be used to store critical information. See the Metadata reference for complete field behavior details.

external_idstring
lock_created_atstring
lock_expires_atstring

Changes