User
Representation of a human user of the system.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
firstName | ✓ | string | DetailsThe 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 | DetailsThe 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 | DetailsDEPRECATED Replaced by ProjectMembership.externalId. | |
string | DetailsThe email address that uniquely identifies the user. | ||
emailVerified | boolean | DetailsWhether the system has verified that the user has access to the email address. | |
admin | boolean | DEPRECATED DetailsDEPRECATED | |
passwordHash | string | DetailsEncrypted hash of the user's password. | |
mfaSecret | string | DetailsShared secret for MFA authenticator applications. | |
mfaEnrolled | boolean | DetailsWhether the user has completed MFA enrollment. | |
project | Reference<Project> | DetailsOptional project if the user only exists for the project. This is used for the project-specific user database. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
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 Elements
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | DetailsThe 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 | DetailsA 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 | DetailsThe base language in which the resource is written. |