User

ResourceHaste Health

A User resource is used to represent a user in a tenant. The resource contains information about the user's role in the organization, the user's email address, and whether the user's email address has been verified.

StructureSearch parametersStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

5 of 5 parameters tested

Structure

Show inherited elements (2)

Element	Card.	Type	Description
email	0..1	string	Users email address.
emailVerified	0..1	boolean	Is Users email address verified.
name	0..1	HumanName	Users name
roleRequired	1..1	code	The Users role. Note that owner and superadmin roles are granted full access.Binding (required): UserRole
federated	0..1	Reference(IdentityProvider)	Is Users email address verified.

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/User?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
email	token	User email User.email
email-verified	token	User email verified status User.emailVerified
identityProvider	reference	User federated identityProvider User.federated
name	string	User name User.name
role	token	User role User.role

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition