Skip to main content

User

Representation of a human user of the system.

Properties

NameRequiredTypeDescription
firstNamestring

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.

lastNamestring

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.

externalIdstring

Details

DEPRECATED Replaced by ProjectMembership.externalId.

emailstring

Details

The email address that uniquely identifies the user.

emailVerifiedboolean

Details

Whether the system has verified that the user has access to the email address.

adminboolean

DEPRECATED

Details

DEPRECATED

passwordHashstring

Details

Encrypted hash of the user's password.

mfaSecretstring

Details

Shared secret for MFA authenticator applications.

mfaEnrolledboolean

Details

Whether the user has completed MFA enrollment.

projectReference<Project>

Details

Optional project if the user only exists for the project. This is used for the project-specific user database.

Search Parameters

NameTypeDescriptionExpression
emailstringThe email address of the userUser.email
external-idstringThe externalID of the userUser.externalId
projectreferenceThe project that contains the userUser.project

Inherited Properties

NameRequiredTypeDescription
idstring

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.

metaMeta

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.

implicitRulesuri

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.

languagecode

Details

The base language in which the resource is written.