Class Cognito

constructor

• new Cognito(options?): Cognito

• Parameters

  • options: {
        region?: string;
    } = {}

    • Optionalregion?: string

  Returns Cognito

client

addUserToGroup

• addUserToGroup(email, group, userPoolId): Promise<void>

• Add a user (by email) to a group in the user pool.

  Parameters

  • email: string
  • group: string
  • userPoolId: string

  Returns Promise<void>

confirmForgotPassword

• confirmForgotPassword(email, newPassword, confirmationCode, userPoolClientId): Promise<void>

• Complete the flow of a password forgot.

  Parameters

  • email: string
  • newPassword: string
  • confirmationCode: string
  • userPoolClientId: string

  Returns Promise<void>

confirmSignUp

• confirmSignUp(email, confirmationCode, userPoolClientId): Promise<void>

• Confirm and conclude a registration, usign a confirmation code.

  Parameters

  • email: string
  • confirmationCode: string
  • userPoolClientId: string

  Returns Promise<void>

createGroup

• createGroup(groupName, userPoolId): Promise<void>

• Create a new group in the user pool.

  Parameters

  • groupName: string
  • userPoolId: string

  Returns Promise<void>

createUser

• createUser(cognitoUserOrEmail, userPoolId, options?): Promise<string>

• Create a new user (by its email) in the pool specified.

  Parameters

  • cognitoUserOrEmail: string | CognitoUser
  • userPoolId: string
  • options: CreateUserOptions = {}

  Returns Promise<string>

  userId of the new user

deleteGroup

• deleteGroup(groupName, userPoolId): Promise<void>

• Delete a group from the user pool.

  Parameters

  • groupName: string
  • userPoolId: string

  Returns Promise<void>

deleteUser

• deleteUser(email, userPoolId): Promise<void>

• Delete a user by its email (username), in the pool specified.

  Parameters

  • email: string
  • userPoolId: string

  Returns Promise<void>

forgotPassword

• forgotPassword(email, userPoolClientId): Promise<CodeDeliveryDetailsType>

• Send to a user the instructions to change the password.

  Parameters

  • email: string
  • userPoolClientId: string

  Returns Promise<CodeDeliveryDetailsType>

getUserByClaims

• getUserByClaims(claims): CognitoUserGeneric

• Get the attributes of the user, from the authorizer claims.

  Parameters

  • claims: Record<string, any>

    authorizer claims

  Returns CognitoUserGeneric

  user's data

  Deprecated

  use idea-toolbox's CognitoUser instead

getUserByEmail

• getUserByEmail(email, userPoolId): Promise<CognitoUserGeneric>

• Identify a user by its email address, returning its attributes.

  Parameters

  • email: string
  • userPoolId: string

  Returns Promise<CognitoUserGeneric>

getUserBySub

• getUserBySub(sub, userPoolId): Promise<CognitoUserGeneric>

• Identify a user by its userId (sub), returning its attributes.

  Parameters

  • sub: string
  • userPoolId: string

  Returns Promise<CognitoUserGeneric>

getUserGroupsByEmail

• getUserGroupsByEmail(email, userPoolId): Promise<string[]>

• Get the list of groups of a user by its email address.

  Parameters

  • email: string
  • userPoolId: string

  Returns Promise<string[]>

globalSignOut

• globalSignOut(email, userPoolId): Promise<void>

• Sign out the user from all devices.

  Parameters

  • email: string
  • userPoolId: string

  Returns Promise<void>

listGroups

• listGroups(userPoolId, options?): Promise<CognitoGroup[]>

• List the groups of the user pool.

  Parameters

  • userPoolId: string
  • options: {
        groups: CognitoGroup[];
        pagination?: string;
    } = ...

    • groups: CognitoGroup[]

    • Optionalpagination?: string

  Returns Promise<CognitoGroup[]>

listUsers

• listUsers(userPoolId, options?): Promise<CognitoUser[]>

• List all the users of the pool.

  Parameters

  • userPoolId: string
  • options: {
        pagination?: string;
        users: CognitoUser[];
    } = ...

    • Optionalpagination?: string

    • users: CognitoUser[]

  Returns Promise<CognitoUser[]>

listUsersInGroup

• listUsersInGroup(group, userPoolId, options?): Promise<CognitoUser[]>

• List the users part of a group in the user pool.

  Parameters

  • group: string
  • userPoolId: string
  • options: {
        pagination?: string;
        users: CognitoUser[];
    } = ...

    • Optionalpagination?: string

    • users: CognitoUser[]

  Returns Promise<CognitoUser[]>

listUsersWithGroupsDetail

• listUsersWithGroupsDetail(cognitoUserPoolId): Promise<CognitoUser[]>

• List all the users of the pool, including the information about the groups they're in. Note: it's slower than the alternative listUsers: use it only when needed.

  Parameters

  • cognitoUserPoolId: string

  Returns Promise<CognitoUser[]>

refreshSession

• refreshSession(email, refreshToken, userPoolId, userPoolClientId): Promise<AuthenticationResultType>

• Given a username and a refresh token (and pool data), refresh the session and return the new tokens.

  Parameters

  • email: string
  • refreshToken: string
  • userPoolId: string
  • userPoolClientId: string

  Returns Promise<AuthenticationResultType>

removeUserFromGroup

• removeUserFromGroup(email, group, userPoolId): Promise<void>

• Remove a user (by email) from a group in the user pool.

  Parameters

  • email: string
  • group: string
  • userPoolId: string

  Returns Promise<void>

resendPassword

• resendPassword(email, userPoolId, options?): Promise<void>

• Resend the password to a user who never logged in.

  Parameters

  • email: string
  • userPoolId: string
  • options: CreateUserOptions = {}

  Returns Promise<void>

setPassword

• setPassword(email, userPoolId, options?): Promise<void>

• Set a new password for a specific user identified by its email (admin-only). If not specified, the password is generated randomly, and the user must change it at the first login.

  Parameters

  • email: string
  • userPoolId: string
  • options: {
        password?: string;
        permanent?: boolean;
    } = {}

    • Optionalpassword?: string

    • Optionalpermanent?: boolean

  Returns Promise<void>

setRegion

• setRegion(region): void

• Change the region in which to find the user pool. Default: the runner's (e.g. Lambda function) region.

  Parameters

  • region: string

  Returns void

signIn

• signIn(email, password, userPoolId, userPoolClientId): Promise<AuthenticationResultType>

• Sign in a user of a specific pool through username and password.

  Parameters

  • email: string
  • password: string
  • userPoolId: string
  • userPoolClientId: string

  Returns Promise<AuthenticationResultType>

updateEmail

• updateEmail(email, newEmail, userPoolId): Promise<void>

• Change the email address (== username) associated to a user.

  Parameters

  • email: string
  • newEmail: string
  • userPoolId: string

  Returns Promise<void>

updatePassword

• updatePassword(email, oldPassword, newPassword, userPoolId, userPoolClientId): Promise<void>

• Change the password to sign in for a user.

  Parameters

  • email: string
  • oldPassword: string
  • newPassword: string
  • userPoolId: string
  • userPoolClientId: string

  Returns Promise<void>

updateUser

• updateUser(user, userPoolId): Promise<void>

• Update a (Cognito)User's attributes, excluding the attributes that require specific methods.

  Parameters

  • user: CognitoUser
  • userPoolId: string

  Returns Promise<void>