IWorkspaceUser
Represents platform user in context of the workspace.
export interface IWorkspaceUser
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | Contact email of the user | ||
string | (Optional) First name - when backend implementations supports it. | ||
string | (Optional) Full name. Note: This property has higher priority than firstName / lastName. Backend implementation MUST fill this property if user names are supported. | ||
string | (Optional) Last name - when backend implementations supports it. | ||
string | Login - unique user ID for logging into the platform | ||
Stored user reference | |||
“ENABLED” | “DISABLED” | (Optional) User status - when backend implementations supports it. | ||
string | User uri |
Property details
IWorkspaceUser.emailproperty
Contact email of the user
email: string;
IWorkspaceUser.firstNameproperty
First name - when backend implementations supports it.
firstName?: string;
IWorkspaceUser.fullNameproperty
Full name.
Note: This property has higher priority than firstName / lastName. Backend implementation MUST fill this property if user names are supported.
fullName?: string;
IWorkspaceUser.lastNameproperty
Last name - when backend implementations supports it.
lastName?: string;
IWorkspaceUser.loginproperty
Login - unique user ID for logging into the platform
login: string;
IWorkspaceUser.refproperty
Stored user reference
ref: ObjRef;
IWorkspaceUser.statusproperty
User status - when backend implementations supports it.
status?: "ENABLED" | "DISABLED";
IWorkspaceUser.uriproperty
User uri
uri: string;