paws.security.identity (version 0.1.0)

cognitoidentityprovider_sign_up: Registers the user in the specified user pool and creates a user name, password, and user attributes

Description

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Usage

cognitoidentityprovider_sign_up(ClientId, SecretHash, Username,
  Password, UserAttributes, ValidationData, AnalyticsMetadata,
  UserContextData)

Arguments

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 wish to register.

Password

[required] The password of the user you wish to register.

UserAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

ValidationData

The validation data in the request to register a user.

AnalyticsMetadata

The Amazon Pinpoint analytics metadata for collecting metrics for SignUp 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

svc$sign_up(
  ClientId = "string",
  SecretHash = "string",
  Username = "string",
  Password = "string",
  UserAttributes = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  ValidationData = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  AnalyticsMetadata = list(
    AnalyticsEndpointId = "string"
  ),
  UserContextData = list(
    EncodedData = "string"
  )
)