Skip to main content

Interface: Profile

Defined in: auth/src/models/types.ts:89

Defines available contact methods and preferences for a given user. Requires the profile scope to read.

Note that the uid must be the same uid as the associated User record.

Extends​

  • BaseEntity

Properties​

avatar?​

optional avatar?: string

Defined in: auth/src/models/types.ts:93

The URL or path to the user's avatar image (e.g. gravatar).

birthdate?​

optional birthdate?: Date

Defined in: auth/src/models/types.ts:98

The user's date of birth.

contacts​

contacts: Contact[]

Defined in: auth/src/models/types.ts:103

The list of the user's contacts.

dateCreated​

dateCreated: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:18

The date and time that the entity was created.

Inherited from​

BaseEntity.dateCreated

dateModified​

dateModified: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:22

The date and time that the entity was last modified.

Inherited from​

BaseEntity.dateModified

familyName?​

optional familyName?: string

Defined in: auth/src/models/types.ts:113

The user's family surname (or last name).

givenName?​

optional givenName?: string

Defined in: auth/src/models/types.ts:108

The user's given name (aka: first name).

preferences​

preferences: Preferences

Defined in: auth/src/models/types.ts:118

The user's account preferences.

uid​

uid: string

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:14

The universally unique identifier of the entity.

Inherited from​

BaseEntity.uid

version​

version: number

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:26

The optimistic lock version.

Inherited from​

BaseEntity.version