Interface IUser

Respresents a user that is attempting to do an action on a protected resource. Passed as part of the input to the permit.check() function.

Hierarchy

  • IUser

Properties

attributes? email? firstName? key lastName?

Properties

Optional attributes

attributes?: Dict

Custom attributes associated with the user, which can be used in ABAC (Attribute-Based Access Control).

Optional email

email?: string

The email address of the user (optional).

Optional firstName

firstName?: string

The first name of the user (optional).

key

key: string

The user key, which is the customer-side ID of the user.

Optional lastName

lastName?: string

The last name of the user (optional).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc