Class CognitoUser

A user stored in a Cognito User Pool.

Hierarchy

CognitoUser

Index

Constructors

Properties

attributes email groups name picture userId

Methods

isAdmin isRobot parseGroupsFromClaims validate

Constructors

constructor

new CognitoUser(x?): CognitoUser
Parameters
- x: any = {}
Returns CognitoUser
- Defined in src/cognitoUser.model.ts:32

Properties

attributes

attributes: {
[attribute: string]: string | number;
}

The user's (custom) attributes.

Type declaration

[attribute: string]: string | number

email

email: string

The email address of the user.

groups

groups: string[]

The list of groups containing the user.

name

name: string

The fullname of the user.

picture

picture: string

The URI to the user's picture.

userId

userId: string

The id of the user.

Methods

isAdmin

isAdmin(): boolean
Whether the user is part of the administrators group.

Returns boolean
- Defined in src/cognitoUser.model.ts:70

isRobot

isRobot(): boolean
Whether the user is part of the robots group.

Returns boolean
- Defined in src/cognitoUser.model.ts:76

`Private` parseGroupsFromClaims

parseGroupsFromClaims(groupsClaim): string[]
Parameters
- groupsClaim: string | string[]
Returns string[]
- Defined in src/cognitoUser.model.ts:47

validate

validate(): string[]
Check whether the user's attributes are valid.

Returns string[]
- Defined in src/cognitoUser.model.ts:60

Generated using TypeDoc