@sourceloop/authentication-service / Exports / AuthUser

Class: AuthUser

Hierarchy

• User<AuthUser>

  ↳ AuthUser

Implements

• IAuthUserWithPermissions

Table of contents

Constructors

• constructor

Properties

• age
• authClientId
• authClientIds
• createdBy
• createdOn
• credentials
• defaultTenantId
• designation
• deviceInfo
• dob
• email
• externalAuthToken
• externalRefreshToken
• firstName
• gender
• id
• lastLogin
• lastName
• middleName
• modifiedBy
• modifiedOn
• passwordExpiryTime
• permissions
• phone
• photoUrl
• role
• status
• tenantId
• userPreferences
• userTenantId
• userTenants
• username

Methods

• getIdentifier

Constructors

constructor

• new AuthUser(data?)

Parameters

Name	Type
data?	Partial<AuthUser & User<DataObject<Model>>>

Inherited from

User.constructor

Defined in

packages/core/dist/models/base-entity.model.d.ts:6

Properties

age

• Optional age: number

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:54

---

authClientId

• authClientId: number

Implementation of

IAuthUserWithPermissions.authClientId

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:64

---

authClientIds

• Optional authClientIds: string

Inherited from

User.authClientIds

Defined in

services/authentication-service/src/models/user.model.ts:80

---

createdBy

• Optional createdBy: string

Inherited from

User.createdBy

Defined in

packages/core/dist/models/user-modifiable-entity.model.d.ts:4

---

createdOn

• Optional createdOn: Date

Inherited from

User.createdOn

Defined in

packages/core/dist/models/base-entity.model.d.ts:4

---

credentials

• credentials: UserCredentials

Inherited from

User.credentials

Defined in

services/authentication-service/src/models/user.model.ts:118

---

defaultTenantId

• defaultTenantId: string

Inherited from

User.defaultTenantId

Defined in

services/authentication-service/src/models/user.model.ts:128

---

designation

• Optional designation: string

Inherited from

User.designation

Defined in

services/authentication-service/src/models/user.model.ts:100

---

deviceInfo

• Optional deviceInfo: DeviceInfo

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:49

---

dob

• dob: Date

Inherited from

User.dob

Defined in

services/authentication-service/src/models/user.model.ts:105

---

email

• Optional email: string

Implementation of

IAuthUserWithPermissions.email

Inherited from

User.email

Defined in

services/authentication-service/src/models/user.model.ts:66

---

externalAuthToken

• Optional externalAuthToken: string

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:41

---

externalRefreshToken

• Optional externalRefreshToken: string

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:59

---

firstName

• firstName: string

Implementation of

IAuthUserWithPermissions.firstName

Inherited from

User.firstName

Defined in

services/authentication-service/src/models/user.model.ts:43

---

gender

• Optional gender: Gender

Inherited from

User.gender

Defined in

services/authentication-service/src/models/user.model.ts:115

---

id

• Optional id: string

Implementation of

IAuthUserWithPermissions.id

Inherited from

User.id

Defined in

services/authentication-service/src/models/user.model.ts:36

---

lastLogin

• Optional lastLogin: Date

Inherited from

User.lastLogin

Defined in

services/authentication-service/src/models/user.model.ts:89

---

lastName

• lastName: string

Implementation of

IAuthUserWithPermissions.lastName

Inherited from

User.lastName

Defined in

services/authentication-service/src/models/user.model.ts:49

---

middleName

• Optional middleName: string

Implementation of

IAuthUserWithPermissions.middleName

Inherited from

User.middleName

Defined in

services/authentication-service/src/models/user.model.ts:55

---

modifiedBy

• Optional modifiedBy: string

Inherited from

User.modifiedBy

Defined in

packages/core/dist/models/user-modifiable-entity.model.d.ts:5

---

modifiedOn

• Optional modifiedOn: Date

Inherited from

User.modifiedOn

Defined in

packages/core/dist/models/base-entity.model.d.ts:5

---

passwordExpiryTime

• Optional passwordExpiryTime: Date

Implementation of

IAuthUserWithPermissions.passwordExpiryTime

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:84

---

permissions

• permissions: string[]

Implementation of

IAuthUserWithPermissions.permissions

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:30

---

phone

• Optional phone: string

Inherited from

User.phone

Defined in

services/authentication-service/src/models/user.model.ts:74

---

photoUrl

• Optional photoUrl: string

Inherited from

User.photoUrl

Defined in

services/authentication-service/src/models/user.model.ts:95

---

role

• role: string

Implementation of

IAuthUserWithPermissions.role

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:36

---

status

• Optional status: UserStatus

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:98

---

tenantId

• Optional tenantId: string

Implementation of

IAuthUserWithPermissions.tenantId

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:74

---

userPreferences

• Optional userPreferences: IUserPrefs

Implementation of

IAuthUserWithPermissions.userPreferences

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:69

---

userTenantId

• Optional userTenantId: string

Implementation of

IAuthUserWithPermissions.userTenantId

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:79

---

userTenants

• userTenants: UserTenant[]

Inherited from

User.userTenants

Defined in

services/authentication-service/src/models/user.model.ts:131

---

username

• username: string

Implementation of

IAuthUserWithPermissions.username

Inherited from

User.username

Defined in

services/authentication-service/src/models/user.model.ts:61

Methods

getIdentifier

▸ getIdentifier(): undefined | string

Returns

undefined | string

Implementation of

IAuthUserWithPermissions.getIdentifier

Defined in

services/authentication-service/src/modules/auth/models/auth-user.model.ts:100