cognito tools
$ npm install -g cognito-tools
$ cognito-tools COMMAND
running command...
$ cognito-tools (-v|--version|version)
cognito-tools/0.0.13 darwin-x64 node-v10.15.1
$ cognito-tools --help [COMMAND]
USAGE
$ cognito-tools COMMAND
...cognito-tools backupcognito-tools deletecognito-tools delete-allcognito-tools force-registrationcognito-tools help [COMMAND]cognito-tools restore
cognito-tools backup -u [USER_POOL_ID] -r [REGION] -o [OUTPUT_TARGET_DIR]
USAGE
$ cognito-tools backup
OPTIONS
-o, --output=output [default: ./output] output target dir
-r, --region=region [default: ap-northeast-1] region name
-u, --userPoolId=userPoolId (required) userPool Id
DESCRIPTION
cognito-tools backup -u [USER_POOL_ID] -r [REGION] -o [OUTPUT_TARGET_DIR]
output file example
[{"Username":"","Attributes":[{"Name":"sub","Value":"7f1f8d94-5c2d-430f-97a7-e2d5d0bb14f1"},{"Name":"email_verified","
Value":"false"},{"Name":"email","Value":"[email protected]"}],"UserCreateDate":"2019-01-18T00:48:59.572Z","UserLastMo
difiedDate":"2019-01-18T00:48:59.572Z","Enabled":true,"UserStatus":"UNCONFIRMED"}]
See code: src/commands/backup.ts
cognito-tools delete -u [USER_POOL_ID] -r [REGION] -i [INPUT_JSON_FILE]
USAGE
$ cognito-tools delete
OPTIONS
-i, --input=input (required) input target path
-r, --region=region (required) [default: ap-northeast-1] region name
-u, --userPoolId=userPoolId (required) userPool Id
DESCRIPTION
cognito-tools delete -u [USER_POOL_ID] -r [REGION] -i [INPUT_JSON_FILE]
cognito admin delete user
input json file example
[{"Username":"","Attributes":[{"Name":"sub","Value":"039bf366-7942-4888-a772-41dadacb2ea9"},{"Name":"email","Value":"s
[email protected]"}]}]
See code: src/commands/delete.ts
cognito-tools delete -u [USER_POOL_ID] -r [REGION]
USAGE
$ cognito-tools delete-all
OPTIONS
-r, --region=region (required) [default: ap-northeast-1] region name
-u, --userPoolId=userPoolId (required) userPool Id
DESCRIPTION
cognito-tools delete -u [USER_POOL_ID] -r [REGION]
fetch delete command
See code: src/commands/delete-all.ts
cognito-tools force-registration -u [USER_POOL_ID] -c [CLIENT_ID] -r [REGION] -i [INPUT_CSV_FILE] -o [OUTPUT_TARGET_DIR]
USAGE
$ cognito-tools force-registration
OPTIONS
-c, --clientId=clientId (required) client Id
-i, --input=input (required) input target csv file
-l, --limit=limit [default: 5] request limit (AdminCreateUser or signUp or linkFacebookProvider)
-o, --output=output [default: ./output] output target dir
-r, --region=region [default: ap-northeast-1] region name
-u, --userPoolId=userPoolId (required) userPool Id
DESCRIPTION
cognito-tools force-registration -u [USER_POOL_ID] -c [CLIENT_ID] -r [REGION] -i [INPUT_CSV_FILE] -o
[OUTPUT_TARGET_DIR]
force create user
input file example
email,password,custom:customAttributeName,facebookId
[email protected],,1,00000000000
[email protected],password,2,00000000001
[email protected],password,3,
password none -> admin create user
password exists -> sign up user
facebook id exists -> admin create user or sign up user and link provider
output file example
userName,email,password,custom:customAttributeName,facebookId
66ef45ad-86a1-4377-aa86-2d3356933b36,[email protected],,1,00000000000
b9225937-9578-4b31-9efe-3a00bebc4ccd,[email protected],password,2,00000000001
ffb029f0-2b2c-4b1d-a927-1845990707fd,[email protected],password,3,
See code: src/commands/force-registration.ts
display help for cognito-tools
USAGE
$ cognito-tools help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
cognito-tools restore -u [USER_POOL_ID] -r [REGION] -i [INPUT_JSON_FILE]
USAGE
$ cognito-tools restore
OPTIONS
-i, --input=input (required) input target file
-l, --limit=limit [default: 5] request limit (AdminCreateUser)
-r, --region=region [default: ap-northeast-1] region name
-u, --userPoolId=userPoolId (required) userPool Id
DESCRIPTION
cognito-tools restore -u [USER_POOL_ID] -r [REGION] -i [INPUT_JSON_FILE]
cognito admin create user
input json file example
[{"Username":"","Attributes":[{"Name":"sub","Value":"039bf366-7942-4888-a772-41dadacb2ea9"},{"Name":"email","Value":"s
[email protected]"}]}]
admin create use options
Username = email
MessageAction = SUPPRESS
DesiredDeliveryMediums = none
ForceAliasCreation = false
See code: src/commands/restore.ts