Class AWSCognitoUserPoolApi

Hierarchy

AWSCognitoUserPoolApi

Index

Constructors

Properties

Methods

addIdp blockUserAccount createUser deleteUser generateStrongPassword getUserContextCognitoPoolId invokeCognitoLambda removeIdp sendWelcomeEmail unblockUserAccount updateEmailMessage updateUser userMFASMSpreference validatePasswordStrength formatUserAttributes

Constructors

constructor

new AWSCognitoUserPoolApi(_runtimeConfig: RuntimeConfig, _cognito: CognitoIdentityServiceProvider): AWSCognitoUserPoolApi
Parameters
- _runtimeConfig: RuntimeConfig
- _cognito: CognitoIdentityServiceProvider
Returns AWSCognitoUserPoolApi
- Defined in src/services/AWSCognito.ts:61

Properties

`Protected` _cognito

_cognito: CognitoIdentityServiceProvider

`Protected` _runtimeConfig

_runtimeConfig: RuntimeConfig

`Private` lambda

lambda: Lambda

Methods

addIdp

addIdp(context: KosmosUserContext<object>, provider: string, metadataUrl: string, metadataFile: string, attributeMapping: string, idpSignout: boolean): Promise<CognitoOperationResult>
Add an identity provider.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
- provider: string
  
  The identity provider name.
- metadataUrl: string
  
  The metadata URL.
- metadataFile: string
  
  The metadata file.
- attributeMapping: string
  
  The attribute mapping data as string.
- idpSignout: boolean
  
  Whether to sign out of the IdP.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:548

blockUserAccount

blockUserAccount(context: KosmosUserContext<object>, item: CognitoItem): Promise<CognitoOperationResult>
Block a user account.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- item: CognitoItem
  
  The user item.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:443

createUser

createUser(temporaryPassword: string | boolean, setPasswordAutomatically: Required<boolean>, context: KosmosUserContext<object>, item: CognitoItem): Promise<CognitoOperationResult>
Creates new user in cognito

Returns
A promise that resolves to the operation result.
Parameters
- temporaryPassword: string | boolean
  
  The temporary password for the user.
- setPasswordAutomatically: Required<boolean>
  
  Indicates whether to automatically generate a strong password.
- context: KosmosUserContext<object>
  
  The user context object.
- item: CognitoItem
  
  Item to update
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:280

deleteUser

deleteUser(context: KosmosUserContext<object>, item: CognitoItem): Promise<CognitoOperationResult>
Deletes a user from the Cognito User Pool.

Returns
A promise that resolves to the operation result.
Parameters
- context: KosmosUserContext<object>
  
  The user context object.
- item: CognitoItem
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:338

`Private` generateStrongPassword

generateStrongPassword(): string
Generates a strong password with a length of at least 10 characters.

Returns
The generated strong password.

Returns string
- Defined in src/services/AWSCognito.ts:118

`Private` getUserContextCognitoPoolId

getUserContextCognitoPoolId(context: KosmosUserContext<object>): null | string
Extracts the Cognito User Pool ID from the iss property of a user context.

Returns
The extracted Cognito User Pool ID or null if not found.
Parameters
- context: KosmosUserContext<object>
  
  The user context object.
Returns null | string
- Defined in src/services/AWSCognito.ts:102

`Private` invokeCognitoLambda

invokeCognitoLambda(action: string, params: any): Promise<CognitoOperationResult>
This function invokes the Cognito Proxy Lambda with the specified action and parameters.

Returns
Returns a promise that resolves to the result of the operation.
Parameters
- action: string
  
  The action to be performed by the Cognito Proxy Lambda.
- params: any
  
  The parameters to be passed to the Cognito Proxy Lambda.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:173

removeIdp

removeIdp(context: KosmosUserContext<object>, provider: string): Promise<CognitoOperationResult>
Remove an identity provider.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
- provider: string
  
  The identity provider name.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:590

sendWelcomeEmail

sendWelcomeEmail(temporaryPassword: string, setPasswordAutomatically: Required<boolean>, context: KosmosUserContext<object>, username: string, email: string): Promise<CognitoOperationResult>
Sends a welcome email to a user with the specified parameters.

Returns
A promise that resolves to the operation result.
Parameters
- temporaryPassword: string
  
  The temporary password for the user.
- setPasswordAutomatically: Required<boolean>
  
  Indicates whether to automatically generate a strong password.
- context: KosmosUserContext<object>
  
  The user context object.
- username: string
  
  Username of the use to send welcome email too.
- email: string
  
  The email of the use to send welcome email too.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:218

unblockUserAccount

unblockUserAccount(context: KosmosUserContext<object>, item: CognitoItem): Promise<CognitoOperationResult>
Unblock a user account.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- item: CognitoItem
  
  The user item.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:474

updateEmailMessage

updateEmailMessage(context: KosmosUserContext<object>, subject: string, message: string): Promise<CognitoOperationResult>
Update email template message.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- subject: string
  
  The email template subject to use.
- message: string
  
  The email template message to use.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:506

updateUser

updateUser(context: KosmosUserContext<object>, item: CognitoItem): Promise<CognitoOperationResult>
Updates the email address of a user in the Cognito User Pool.

Returns
A promise that resolves to the operation result.
Parameters
- context: KosmosUserContext<object>
  
  The user context object.
- item: CognitoItem
  
  The new email address for the user.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:367

userMFASMSpreference

userMFASMSpreference(context: KosmosUserContext<object>, enable: boolean, username: string, phoneNumber?: string): Promise<CognitoOperationResult>
Enable or disable MFA with SMS for a user.

Returns
A promise that resolves to the result of the operation.
Parameters
- context: KosmosUserContext<object>
  
  The user context.
- enable: boolean
  
  A boolean indicating whether to enable or disable MFA with SMS.
- username: string
  
  The username for enabling MFA.
- Optional phoneNumber: string
  
  The phoneNumber for enabling MFA.
Returns Promise<CognitoOperationResult>
- Defined in src/services/AWSCognito.ts:400

`Private` validatePasswordStrength

validatePasswordStrength(password: string): boolean
Validates the strength of a password based on certain criteria.

Returns
True if the password meets the specified criteria, otherwise false.
Parameters
- password: string
  
  The password to be validated.
Returns boolean
- Defined in src/services/AWSCognito.ts:149

`Static` `Protected` formatUserAttributes

formatUserAttributes(data: Record<string, any>): {
Name: string;
Value: string;
}[]
Formats user attributes for use with Cognito.

Returns
An array of formatted user attributes with 'Name' and 'Value'.
Parameters
- data: Record<string, any>
  
  The input object containing user attributes.
Returns {
Name: string;
Value: string;
}[]
- Defined in src/services/AWSCognito.ts:74

Class AWSCognitoUserPoolApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_runtimeConfig: RuntimeConfig

_cognito: CognitoIdentityServiceProvider

Returns AWSCognitoUserPoolApi

Properties

Protected _cognito

Protected _runtimeConfig

Private lambda

Methods

addIdp

Returns

Parameters

context: KosmosUserContext<object>

provider: string

metadataUrl: string

metadataFile: string

attributeMapping: string

idpSignout: boolean

Returns Promise<CognitoOperationResult>

blockUserAccount

Returns

Parameters

context: KosmosUserContext<object>

item: CognitoItem

Returns Promise<CognitoOperationResult>

createUser

Returns

Parameters

temporaryPassword: string | boolean

setPasswordAutomatically: Required<boolean>

context: KosmosUserContext<object>

item: CognitoItem

Returns Promise<CognitoOperationResult>

deleteUser

Returns

Parameters

context: KosmosUserContext<object>

item: CognitoItem

Returns Promise<CognitoOperationResult>

Private generateStrongPassword

Returns

Returns string

Private getUserContextCognitoPoolId

Returns

Parameters

context: KosmosUserContext<object>

Returns null | string

Private invokeCognitoLambda

Returns

Parameters

action: string

params: any

Returns Promise<CognitoOperationResult>

removeIdp

Returns

Parameters

context: KosmosUserContext<object>

provider: string

Returns Promise<CognitoOperationResult>

sendWelcomeEmail

Returns

Parameters

temporaryPassword: string

setPasswordAutomatically: Required<boolean>

context: KosmosUserContext<object>

username: string

email: string

Returns Promise<CognitoOperationResult>

unblockUserAccount

Returns

Parameters

context: KosmosUserContext<object>

`Protected` _cognito

`Protected` _runtimeConfig

`Private` lambda

`Private` generateStrongPassword

`Private` getUserContextCognitoPoolId

`Private` invokeCognitoLambda

`Optional` phoneNumber: string

`Private` validatePasswordStrength

`Static` `Protected` formatUserAttributes

Returns {
Name: string;
Value: string;
}[]