ADMINCONFIRMSIGNUP()`¶

About AdminConfirmSignUp¶

Confirms user sign-up as an administrator.

This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end.

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

To configure your user pool to require administrative confirmation of users, set AllowAdminCreateUserOnly to true in a CreateUserPool or UpdateUserPool request.

Method Signature¶

METHODS /AWS1/IF_CGP~ADMINCONFIRMSIGNUP
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_USERNAME TYPE /AWS1/CGPUSERNAMETYPE OPTIONAL
    !IT_CLIENTMETADATA TYPE /AWS1/CL_CGPCLIENTMETTYPE_W=>TT_CLIENTMETADATATYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpadminconfsignuprsp
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDLAMBDARSPEX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPLIMITEXCEEDEDEX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYFAILEDATT00
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPUNEXPECTEDLAMBDAEX
    /AWS1/CX_CGPUSERLAMBDAVALIDA00
    /AWS1/CX_CGPUSERNOTFOUNDEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_userpoolid` `TYPE /AWS1/CGPUSERPOOLIDTYPE` `/AWS1/CGPUSERPOOLIDTYPE`¶

The ID of the user pool where you want to confirm a user's sign-up request.

`iv_username` `TYPE /AWS1/CGPUSERNAMETYPE` `/AWS1/CGPUSERNAMETYPE`¶

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Optional arguments:¶

`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 Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to 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_cgpadminconfsignuprsp` `/AWS1/CL_CGPADMINCONFSIGNUPRSP`¶

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->adminconfirmsignup(
  it_clientmetadata = VALUE /aws1/cl_cgpclientmettype_w=>tt_clientmetadatatype(
    (
      VALUE /aws1/cl_cgpclientmettype_w=>ts_clientmetadatatype_maprow(
        value = new /aws1/cl_cgpclientmettype_w( |string| )
        key = |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.
ENDIF.

/AWS1/IF_CGP=>ADMINCONFIRMSIGNUP()¶