cognitoidentityprovider_confirm_sign_up: Confirms registration of a user and handles the existing...

Description Usage Arguments Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

Confirms registration of a user and handles the existing alias from a previous user.

Usage

1
2
3
cognitoidentityprovider_confirm_sign_up(ClientId, SecretHash, Username,
  ConfirmationCode, ForceAliasCreation, AnalyticsMetadata,
  UserContextData)

Arguments

ClientId

[required] The ID of the app client associated with the user pool.

SecretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Username

[required] The user name of the user whose registration you wish to confirm.

ConfirmationCode

[required] The confirmation code sent by a user's request to confirm registration.

ForceAliasCreation

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

AnalyticsMetadata

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

UserContextData

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
svc$confirm_sign_up(
  ClientId = "string",
  SecretHash = "string",
  Username = "string",
  ConfirmationCode = "string",
  ForceAliasCreation = TRUE|FALSE,
  AnalyticsMetadata = list(
    AnalyticsEndpointId = "string"
  ),
  UserContextData = list(
    EncodedData = "string"
  )
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.