Aws Cognito

Node: awsCognito · Full type: n8n-nodes-base.awsCognito · Version: 1

Credentials

aws (alias: @aws)

CREDENTIAL @aws = aws "My Aws Cognito"

Operations

Resource: group

create

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
newGroupName	string	""	required
additionalFields	collection	{}	keys: description, precedence, arn

delete

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
group	resourceLocator	{...}	required; modes: list, groupName

get

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
group	resourceLocator	{...}	required; modes: list, groupName
includeUsers	boolean	false

getAll

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
returnAll	boolean	false
limit	number	50	required
includeUsers	boolean	false

update

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
group	resourceLocator	{...}	required; modes: list, groupName
additionalFields	collection	{}	keys: description, precedence, arn

Resource: user

addToGroup

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
user	resourceLocator	{...}	required; modes: list, id
group	resourceLocator	{...}	required; modes: list, groupName

create

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
newUserName	string	""	required
additionalFields	collection	{}	keys: messageAction, forceAliasCreation, userAttributes, desiredDeliveryMediums, temporaryPasswordOptions

delete

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
user	resourceLocator	{...}	required; modes: list, id

get

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
user	resourceLocator	{...}	required; modes: list, id
simple	boolean	true

getAll

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
returnAll	boolean	false
limit	number	50	required
simple	boolean	true
filters	fixedCollection	{}	groups: filter

removeFromGroup

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
user	resourceLocator	{...}	required; modes: list, id
group	resourceLocator	{...}	required; modes: list, groupName

update

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
user	resourceLocator	{...}	required; modes: list, id
userAttributes	fixedCollection	{...}	required; groups: attributes

Resource: userPool

get

Parameter	Type	Default	Details
userPool	resourceLocator	{...}	required; modes: list, id
simple	boolean	true

Common Parameters

Parameter	Type	Default	Details
requestOptions	collection	{}	keys: batching, allowUnauthorizedCerts, proxy, timeout

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
description	string	""
precedence	number	""
arn	string	""

filters children:

filter group:

Parameter	Type	Default	Details
attribute	options	"email"	cognito:user_status, email, family_name, given_name, name, phone_number, preferred_username, status, ... (10 total)
value	string	""

userAttributes children:

attributes group:

Parameter	Type	Default	Details
attributeType	options	"standard"	standard, custom
standardName	options	"address"	address, birthdate, email, family_name, gender, given_name, locale, middle_name, ... (17 total)
customName	string	""
value	string	""

requestOptions children:

Parameter	Type	Default	Details
batching	fixedCollection	{...}	groups: batch
allowUnauthorizedCerts	boolean	false
proxy	string	""
timeout	number	10000

Example

NODE "awsCognito" @aws AS "Aws Cognito" {
  resource: "group",
  operation: "get",
  newGroupName: {{ $json.newGroupName }},
  limit: 50,
  newUserName: {{ $json.newUserName }}
}