View source: R/cognitoidentityprovider_operations.R
cognitoidentityprovider_sign_up | R Documentation |
Registers the user in the specified user pool and creates a user name, password, and user attributes.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_sign_up/ for full documentation.
cognitoidentityprovider_sign_up(
ClientId,
SecretHash = NULL,
Username,
Password,
UserAttributes = NULL,
ValidationData = NULL,
AnalyticsMetadata = NULL,
UserContextData = NULL,
ClientMetadata = NULL
)
ClientId |
[required] The ID of the 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 you want to register. |
Password |
[required] The password of the user you want to register. |
UserAttributes |
An array of name-value pairs representing user attributes. For custom attributes, you must prepend the |
ValidationData |
The validation data in the request to register a user. |
AnalyticsMetadata |
The Amazon Pinpoint analytics metadata that contributes to your metrics
for |
UserContextData |
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests. |
ClientMetadata |
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the SignUp API action, Amazon Cognito invokes any
functions that are assigned to the following triggers: pre sign-up,
custom message, and post confirmation. When Amazon Cognito invokes
any of these functions, it passes a JSON payload, which the function
receives as input. This payload contains a For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.