/AWS1/IF_CGP=>ADMINCREATEUSER()

About AdminCreateUser

Creates a new user in the specified user pool.

If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.

In either case, if the user has a password, they will be in the FORCE_CHANGE_PASSWORD state until they sign in and set their password. Your invitation message template must have the {####} password placeholder if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito doesn't deliver the invitation message. In this case, you must update your message template and resend the password with a new AdminCreateUser request with a MessageAction value of RESEND.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Method Signature

IMPORTING

Required arguments:

iv_userpoolid TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The ID of the user pool where you want to create a user.

iv_username TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE

The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.

• The username can't be a duplicate of another username in the same user pool.

• You can't change the value of a username after you create it.

• You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.

Optional arguments:

it_userattributes TYPE /AWS1/CL_CGPATTRIBUTETYPE=>TT_ATTRIBUTELISTTYPE TT_ATTRIBUTELISTTYPE

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

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

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a TemporaryPassword.

In your AdminCreateUser request, you can set the email_verified and phone_number_verified attributes to true. The following conditions apply:

email

The email address where you want the user to receive their confirmation code and username. You must provide a value for email when you want to set email_verified to true, or if you set EMAIL in the DesiredDeliveryMediums parameter.

phone_number

The phone number where you want the user to receive their confirmation code and username. You must provide a value for phone_number when you want to set phone_number_verified to true, or if you set SMS in the DesiredDeliveryMediums parameter.

it_validationdata TYPE /AWS1/CL_CGPATTRIBUTETYPE=>TT_ATTRIBUTELISTTYPE TT_ATTRIBUTELISTTYPE

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

iv_temporarypassword TYPE /AWS1/CGPPASSWORDTYPE /AWS1/CGPPASSWORDTYPE

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The exception to the requirement for a password is when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

If you don't specify a value, Amazon Cognito generates one for you unless you have passwordless options active for your user pool.

The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify RESEND for the MessageAction parameter.

iv_forcealiascreation TYPE /AWS1/CGPFORCEALIASCREATION /AWS1/CGPFORCEALIASCREATION

This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

iv_messageaction TYPE /AWS1/CGPMESSAGEACTIONTYPE /AWS1/CGPMESSAGEACTIONTYPE

Set to RESEND to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to SUPPRESS to suppress sending the message. You can specify only one value.

it_desireddeliverymediums TYPE /AWS1/CL_CGPDELIVERYMEDIUMLS00=>TT_DELIVERYMEDIUMLISTTYPE TT_DELIVERYMEDIUMLISTTYPE

Specify EMAIL if email will be used to send the welcome message. Specify SMS if the phone number will be used. The default value is SMS. You can specify more than one value.

it_clientmetadata TYPE /AWS1/CL_CGPCLIENTMETTYPE_W=>TT_CLIENTMETADATATYPE TT_CLIENTMETADATATYPE

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 AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ClientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

RETURNING

oo_output TYPE REF TO /aws1/cl_cgpadmincreateuserrsp /AWS1/CL_CGPADMINCREATEUSERRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_cgp~admincreateuser(
  it_clientmetadata = VALUE /aws1/cl_cgpclientmettype_w=>tt_clientmetadatatype(
    (
      VALUE /aws1/cl_cgpclientmettype_w=>ts_clientmetadatatype_maprow(
        key = |string|
        value = new /aws1/cl_cgpclientmettype_w( |string| )
      )
    )
  )
  it_desireddeliverymediums = VALUE /aws1/cl_cgpdeliverymediumls00=>tt_deliverymediumlisttype(
    ( new /aws1/cl_cgpdeliverymediumls00( |string| ) )
  )
  it_userattributes = VALUE /aws1/cl_cgpattributetype=>tt_attributelisttype(
    (
      new /aws1/cl_cgpattributetype(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  it_validationdata = VALUE /aws1/cl_cgpattributetype=>tt_attributelisttype(
    (
      new /aws1/cl_cgpattributetype(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_forcealiascreation = ABAP_TRUE
  iv_messageaction = |string|
  iv_temporarypassword = |string|
  iv_username = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_usertype = lo_result->get_user( ).
  IF lo_usertype IS NOT INITIAL.
    lv_usernametype = lo_usertype->get_username( ).
    LOOP AT lo_usertype->get_attributes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_attributenametype = lo_row_1->get_name( ).
        lv_attributevaluetype = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_datetype = lo_usertype->get_usercreatedate( ).
    lv_datetype = lo_usertype->get_userlastmodifieddate( ).
    lv_booleantype = lo_usertype->get_enabled( ).
    lv_userstatustype = lo_usertype->get_userstatus( ).
    LOOP AT lo_usertype->get_mfaoptions( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_deliverymediumtype = lo_row_3->get_deliverymedium( ).
        lv_attributenametype = lo_row_3->get_attributename( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

An AdminCreateUser request for for a test user named John.

This request submits a value for all possible parameters for AdminCreateUser.

DATA(lo_result) = lo_client->/aws1/if_cgp~admincreateuser(
  it_desireddeliverymediums = VALUE /aws1/cl_cgpdeliverymediumls00=>tt_deliverymediumlisttype(
    ( new /aws1/cl_cgpdeliverymediumls00( |SMS| ) )
  )
  it_userattributes = VALUE /aws1/cl_cgpattributetype=>tt_attributelisttype(
    (
      new /aws1/cl_cgpattributetype(
        iv_name = |name|
        iv_value = |John|
      )
    )
    (
      new /aws1/cl_cgpattributetype(
        iv_name = |phone_number|
        iv_value = |+12065551212|
      )
    )
    (
      new /aws1/cl_cgpattributetype(
        iv_name = |email|
        iv_value = |testuser@example.com|
      )
    )
  )
  iv_messageaction = |SUPPRESS|
  iv_temporarypassword = |This-is-my-test-99!|
  iv_username = |testuser|
  iv_userpoolid = |us-east-1_EXAMPLE|
).