IUser
Represents platform user.
export interface IUser
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) Authentication id of the user. | ||
string | (Optional) In which deployment the user was requested | ||
string | (Optional) Contact email of the user. | ||
(Optional) Entitlements for 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. | ||
string | (Optional) Organization id - when backend implementations supports it. | ||
string | (Optional) Organization name - when backend implementations supports it. | ||
string[] | (Optional) Permission of the user | ||
Stored user reference. | |||
boolean | (Optional) When true, the user is marked as a system account. |
Property details
IUser.authenticationIdproperty
Authentication id of the user.
authenticationId?: string;
IUser.deploymentproperty
In which deployment the user was requested
deployment?: string;
IUser.emailproperty
Contact email of the user.
email?: string;
IUser.entitlementsproperty
Entitlements for the user.
entitlements?: IEntitlementDescriptor[];
IUser.firstNameproperty
First name - when backend implementations supports it.
firstName?: string;
IUser.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;
IUser.lastNameproperty
Last name - when backend implementations supports it.
lastName?: string;
IUser.loginproperty
Login - unique user ID for logging into the platform.
login: string;
IUser.organizationIdproperty
Organization id - when backend implementations supports it.
organizationId?: string;
IUser.organizationNameproperty
Organization name - when backend implementations supports it.
organizationName?: string;
IUser.permissionsproperty
Permission of the user
permissions?: string[];
IUser.refproperty
Stored user reference.
ref: ObjRef;
IUser.systemAccountproperty
When true, the user is marked as a system account.
systemAccount?: boolean;