User

Representation of a human user of the system.

Schema

Properties

Name	Required	Type	Description
firstName	✓	string	Details The first name or given name of the user. This is the value as entered when the user is created. It is used to populate the profile resource.
lastName	✓	string	Details The last name or family name of the user. This is the value as entered when the user is created. It is used to populate the profile resource.
externalId		string	Details DEPRECATED Replaced by ProjectMembership.externalId.
email		string	Details The email address that uniquely identifies the user.
emailVerified		boolean	Details Whether the system has verified that the user has access to the email address.
admin		boolean	DEPRECATED Details DEPRECATED
passwordHash		string	Details Encrypted hash of the user's password.
mfaSecret		string	Details Shared secret for MFA authenticator applications.
mfaEnrolled		boolean	Details Whether the user has completed MFA enrollment.
project		Reference<Project>	Details Optional project if the user only exists for the project. This is used for the project-specific user database.

Search Parameters

Name	Type	Description	Expression
email	string	The email address of the user	User.email
external-id	string	The externalID of the user	User.externalId
project	reference	The project that contains the user	User.project

Inherited Properties

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta		Meta	Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language		code	Details The base language in which the resource is written.