CREATEUSERPOOLCLIENT()`¶

About CreateUserPoolClient¶

Creates an app client in a user pool. This operation sets basic and advanced configuration options.

Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

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

Method Signature¶

METHODS /AWS1/IF_CGP~CREATEUSERPOOLCLIENT
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_CLIENTNAME TYPE /AWS1/CGPCLIENTNAMETYPE OPTIONAL
    !IV_GENERATESECRET TYPE /AWS1/CGPGENERATESECRET OPTIONAL
    !IV_REFRESHTOKENVALIDITY TYPE /AWS1/CGPREFRESHTOKVALIDITYT00 OPTIONAL
    !IV_ACCESSTOKENVALIDITY TYPE /AWS1/CGPACCTOKENVALIDITYTYPE OPTIONAL
    !IV_IDTOKENVALIDITY TYPE /AWS1/CGPIDTOKENVALIDITYTYPE OPTIONAL
    !IO_TOKENVALIDITYUNITS TYPE REF TO /AWS1/CL_CGPTOKVALIDITYUNITS00 OPTIONAL
    !IT_READATTRIBUTES TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE OPTIONAL
    !IT_WRITEATTRIBUTES TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE OPTIONAL
    !IT_EXPLICITAUTHFLOWS TYPE /AWS1/CL_CGPEXPLICITAUTHFLOW00=>TT_EXPLICITAUTHFLOWSLISTTYPE OPTIONAL
    !IT_SUPPORTEDIDENTITYPVDRS TYPE /AWS1/CL_CGPSUPPEDIDPVDRSLST00=>TT_SUPPORTEDIDPVDRSLISTTYPE OPTIONAL
    !IT_CALLBACKURLS TYPE /AWS1/CL_CGPCALLBACKURLSLSTT00=>TT_CALLBACKURLSLISTTYPE OPTIONAL
    !IT_LOGOUTURLS TYPE /AWS1/CL_CGPLOGOUTURLSLSTTYP00=>TT_LOGOUTURLSLISTTYPE OPTIONAL
    !IV_DEFAULTREDIRECTURI TYPE /AWS1/CGPREDIRECTURLTYPE OPTIONAL
    !IT_ALLOWEDOAUTHFLOWS TYPE /AWS1/CL_CGPOAUTHFLOWSTYPE_W=>TT_OAUTHFLOWSTYPE OPTIONAL
    !IT_ALLOWEDOAUTHSCOPES TYPE /AWS1/CL_CGPSCOPELISTTYPE_W=>TT_SCOPELISTTYPE OPTIONAL
    !IV_ALWEDOAUTHFLOWSUSERPOOL00 TYPE /AWS1/CGPBOOLEANTYPE OPTIONAL
    !IO_ANALYTICSCONFIGURATION TYPE REF TO /AWS1/CL_CGPANALYTICSCONFTYPE OPTIONAL
    !IV_PREVENTUSEREXENCEERRORS TYPE /AWS1/CGPPREVTUSEREXENCEERRT00 OPTIONAL
    !IV_ENABLETOKENREVOCATION TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE OPTIONAL
    !IV_ENBPROPAGATEADDLUSERCTX00 TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE OPTIONAL
    !IV_AUTHSESSIONVALIDITY TYPE /AWS1/CGPAUTHSESSVALIDITYTYPE OPTIONAL
    !IO_REFRESHTOKENROTATION TYPE REF TO /AWS1/CL_CGPREFRESHTOKROTATI00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpcreuserpoolclirsp
  RAISING
    /AWS1/CX_CGPFTUNAVINTIEREX
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDOAUTHFLOWEX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPLIMITEXCEEDEDEX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPSCOPEDOESNOTEXEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /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 create an app client.

`iv_clientname` `TYPE /AWS1/CGPCLIENTNAMETYPE` `/AWS1/CGPCLIENTNAMETYPE`¶

A friendly name for the app client that you want to create.

Optional arguments:¶

`iv_generatesecret` `TYPE /AWS1/CGPGENERATESECRET` `/AWS1/CGPGENERATESECRET`¶

When true, generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types.

`iv_refreshtokenvalidity` `TYPE /AWS1/CGPREFRESHTOKVALIDITYT00` `/AWS1/CGPREFRESHTOKVALIDITYT00`¶

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

`iv_accesstokenvalidity` `TYPE /AWS1/CGPACCTOKENVALIDITYTYPE` `/AWS1/CGPACCTOKENVALIDITYTYPE`¶

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

`iv_idtokenvalidity` `TYPE /AWS1/CGPIDTOKENVALIDITYTYPE` `/AWS1/CGPIDTOKENVALIDITYTYPE`¶

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

`io_tokenvalidityunits` `TYPE REF TO /AWS1/CL_CGPTOKVALIDITYUNITS00` `/AWS1/CL_CGPTOKVALIDITYUNITS00`¶

The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.

`it_readattributes` `TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE` `TT_CLIENTPERMISSIONLISTTYPE`¶

The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list.

When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified, phone_number_verified, and the standard attributes of your user pool. When your user pool app client has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of read attributes.

`it_writeattributes` `TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE` `TT_CLIENTPERMISSIONLISTTYPE`¶

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.

When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

`it_explicitauthflows` `TYPE /AWS1/CL_CGPEXPLICITAUTHFLOW00=>TT_EXPLICITAUTHFLOWSLISTTYPE` `TT_EXPLICITAUTHFLOWSLISTTYPE`¶

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows, your app client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

The values for authentication flow options include the following.

ALLOW_USER_AUTH: Enable selection-based sign-in with USER_AUTH. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ExplicitAuthFlows permitting them. For example users can complete an SRP challenge through USER_AUTH without the flow USER_SRP_AUTH being active for the app client. This flow doesn't include CUSTOM_AUTH.

To activate this setting, your user pool must be in the Essentials tier or higher.

ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

`it_supportedidentitypvdrs` `TYPE /AWS1/CL_CGPSUPPEDIDPVDRSLST00=>TT_SUPPORTEDIDPVDRSLISTTYPE` `TT_SUPPORTEDIDPVDRSLISTTYPE`¶

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of COGNITO from this list doesn't prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent SDK-based authentication is to block access with a WAF rule.

`it_callbackurls` `TYPE /AWS1/CL_CGPCALLBACKURLSLSTT00=>TT_CALLBACKURLSLISTTYPE` `TT_CALLBACKURLSLISTTYPE`¶

A list of allowed redirect, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.

A redirect URI must meet the following requirements:

Be an absolute URI.

Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with redirect_uri values that aren't in the list of CallbackURLs that you provide in this parameter.

Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

`it_logouturls` `TYPE /AWS1/CL_CGPLOGOUTURLSLSTTYP00=>TT_LOGOUTURLSLISTTYPE` `TT_LOGOUTURLSLISTTYPE`¶

A list of allowed logout URLs for managed login authentication. When you pass logout_uri and client_id parameters to /logout, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of logout_uri. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint.

`iv_defaultredirecturi` `TYPE /AWS1/CGPREDIRECTURLTYPE` `/AWS1/CGPREDIRECTURLTYPE`¶

The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.

`it_allowedoauthflows` `TYPE /AWS1/CL_CGPOAUTHFLOWSTYPE_W=>TT_OAUTHFLOWSTYPE` `TT_OAUTHFLOWSTYPE`¶

The OAuth grant types that you want your app client to generate for clients in managed login authentication. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token, and the ID token when scopes like openid and profile are requested, directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user, authorized by a combination of the client ID and client secret.

`it_allowedoauthscopes` `TYPE /AWS1/CL_CGPSCOPELISTTYPE_W=>TT_SCOPELISTTYPE` `TT_SCOPELISTTYPE`¶

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the userInfo endpoint, and third-party APIs. Scope values include phone, email, openid, and profile. The aws.cognito.signin.user.admin scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.

`iv_alwedoauthflowsuserpool00` `TYPE /AWS1/CGPBOOLEANTYPE` `/AWS1/CGPBOOLEANTYPE`¶

Set to true to use OAuth 2.0 authorization server features in your app client.

This parameter must have a value of true before you can configure the following features in your app client.

CallBackURLs: Callback URLs.

LogoutURLs: Sign-out redirect URLs.

AllowedOAuthScopes: OAuth 2.0 scopes.

AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use authorization server features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false. When false, only SDK-based API sign-in is permitted.

`io_analyticsconfiguration` `TYPE REF TO /AWS1/CL_CGPANALYTICSCONFTYPE` `/AWS1/CL_CGPANALYTICSCONFTYPE`¶

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics.

`iv_preventuserexenceerrors` `TYPE /AWS1/CGPPREVTUSEREXENCEERRT00` `/AWS1/CGPPREVTUSEREXENCEERRT00`¶

When ENABLED, suppresses messages that might indicate a valid user exists when someone attempts sign-in. This parameters sets your preference for the errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Defaults to LEGACY.

`iv_enabletokenrevocation` `TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE` `/AWS1/CGPWRAPPEDBOOLEANTYPE`¶

Activates or deactivates token revocation in the target app client.

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

`iv_enbpropagateaddluserctx00` `TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE` `/AWS1/CGPWRAPPEDBOOLEANTYPE`¶

When true, your application can include additional UserContextData in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests. If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

`iv_authsessionvalidity` `TYPE /AWS1/CGPAUTHSESSVALIDITYTYPE` `/AWS1/CGPAUTHSESSVALIDITYTYPE`¶

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

`io_refreshtokenrotation` `TYPE REF TO /AWS1/CL_CGPREFRESHTOKROTATI00` `/AWS1/CL_CGPREFRESHTOKROTATI00`¶

The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpcreuserpoolclirsp` `/AWS1/CL_CGPCREUSERPOOLCLIRSP`¶

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->createuserpoolclient(
  io_analyticsconfiguration = new /aws1/cl_cgpanalyticsconftype(
    iv_applicationarn = |string|
    iv_applicationid = |string|
    iv_externalid = |string|
    iv_rolearn = |string|
    iv_userdatashared = ABAP_TRUE
  )
  io_refreshtokenrotation = new /aws1/cl_cgprefreshtokrotati00(
    iv_feature = |string|
    iv_retrygraceperiodseconds = 123
  )
  io_tokenvalidityunits = new /aws1/cl_cgptokvalidityunits00(
    iv_accesstoken = |string|
    iv_idtoken = |string|
    iv_refreshtoken = |string|
  )
  it_allowedoauthflows = VALUE /aws1/cl_cgpoauthflowstype_w=>tt_oauthflowstype(
    ( new /aws1/cl_cgpoauthflowstype_w( |string| ) )
  )
  it_allowedoauthscopes = VALUE /aws1/cl_cgpscopelisttype_w=>tt_scopelisttype(
    ( new /aws1/cl_cgpscopelisttype_w( |string| ) )
  )
  it_callbackurls = VALUE /aws1/cl_cgpcallbackurlslstt00=>tt_callbackurlslisttype(
    ( new /aws1/cl_cgpcallbackurlslstt00( |string| ) )
  )
  it_explicitauthflows = VALUE /aws1/cl_cgpexplicitauthflow00=>tt_explicitauthflowslisttype(
    ( new /aws1/cl_cgpexplicitauthflow00( |string| ) )
  )
  it_logouturls = VALUE /aws1/cl_cgplogouturlslsttyp00=>tt_logouturlslisttype(
    ( new /aws1/cl_cgplogouturlslsttyp00( |string| ) )
  )
  it_readattributes = VALUE /aws1/cl_cgpclipermlisttype_w=>tt_clientpermissionlisttype(
    ( new /aws1/cl_cgpclipermlisttype_w( |string| ) )
  )
  it_supportedidentitypvdrs = VALUE /aws1/cl_cgpsuppedidpvdrslst00=>tt_supportedidpvdrslisttype(
    ( new /aws1/cl_cgpsuppedidpvdrslst00( |string| ) )
  )
  it_writeattributes = VALUE /aws1/cl_cgpclipermlisttype_w=>tt_clientpermissionlisttype(
    ( new /aws1/cl_cgpclipermlisttype_w( |string| ) )
  )
  iv_accesstokenvalidity = 123
  iv_alwedoauthflowsuserpool00 = ABAP_TRUE
  iv_authsessionvalidity = 123
  iv_clientname = |string|
  iv_defaultredirecturi = |string|
  iv_enabletokenrevocation = ABAP_TRUE
  iv_enbpropagateaddluserctx00 = ABAP_TRUE
  iv_generatesecret = ABAP_TRUE
  iv_idtokenvalidity = 123
  iv_preventuserexenceerrors = |string|
  iv_refreshtokenvalidity = 123
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_userpoolclienttype = lo_result->get_userpoolclient( ).
  IF lo_userpoolclienttype IS NOT INITIAL.
    lv_userpoolidtype = lo_userpoolclienttype->get_userpoolid( ).
    lv_clientnametype = lo_userpoolclienttype->get_clientname( ).
    lv_clientidtype = lo_userpoolclienttype->get_clientid( ).
    lv_clientsecrettype = lo_userpoolclienttype->get_clientsecret( ).
    lv_datetype = lo_userpoolclienttype->get_lastmodifieddate( ).
    lv_datetype = lo_userpoolclienttype->get_creationdate( ).
    lv_refreshtokenvaliditytyp = lo_userpoolclienttype->get_refreshtokenvalidity( ).
    lv_accesstokenvaliditytype = lo_userpoolclienttype->get_accesstokenvalidity( ).
    lv_idtokenvaliditytype = lo_userpoolclienttype->get_idtokenvalidity( ).
    lo_tokenvalidityunitstype = lo_userpoolclienttype->get_tokenvalidityunits( ).
    IF lo_tokenvalidityunitstype IS NOT INITIAL.
      lv_timeunitstype = lo_tokenvalidityunitstype->get_accesstoken( ).
      lv_timeunitstype = lo_tokenvalidityunitstype->get_idtoken( ).
      lv_timeunitstype = lo_tokenvalidityunitstype->get_refreshtoken( ).
    ENDIF.
    LOOP AT lo_userpoolclienttype->get_readattributes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_clientpermissiontype = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_writeattributes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_clientpermissiontype = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_explicitauthflows( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_explicitauthflowstype = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_supportedidentitypvdrs( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_providernametype = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_callbackurls( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_redirecturltype = lo_row_7->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_logouturls( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_redirecturltype = lo_row_9->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_redirecturltype = lo_userpoolclienttype->get_defaultredirecturi( ).
    LOOP AT lo_userpoolclienttype->get_allowedoauthflows( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_oauthflowtype = lo_row_11->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_userpoolclienttype->get_allowedoauthscopes( ) into lo_row_12.
      lo_row_13 = lo_row_12.
      IF lo_row_13 IS NOT INITIAL.
        lv_scopetype = lo_row_13->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_booleantype = lo_userpoolclienttype->get_alwedoauthflowsuserpoo00( ).
    lo_analyticsconfigurationt = lo_userpoolclienttype->get_analyticsconfiguration( ).
    IF lo_analyticsconfigurationt IS NOT INITIAL.
      lv_hexstringtype = lo_analyticsconfigurationt->get_applicationid( ).
      lv_arntype = lo_analyticsconfigurationt->get_applicationarn( ).
      lv_arntype = lo_analyticsconfigurationt->get_rolearn( ).
      lv_stringtype = lo_analyticsconfigurationt->get_externalid( ).
      lv_booleantype = lo_analyticsconfigurationt->get_userdatashared( ).
    ENDIF.
    lv_preventuserexistenceerr = lo_userpoolclienttype->get_preventuserexenceerrors( ).
    lv_wrappedbooleantype = lo_userpoolclienttype->get_enabletokenrevocation( ).
    lv_wrappedbooleantype = lo_userpoolclienttype->get_enbpropagateaddluserct00( ).
    lv_authsessionvaliditytype = lo_userpoolclienttype->get_authsessionvalidity( ).
    lo_refreshtokenrotationtyp = lo_userpoolclienttype->get_refreshtokenrotation( ).
    IF lo_refreshtokenrotationtyp IS NOT INITIAL.
      lv_featuretype = lo_refreshtokenrotationtyp->get_feature( ).
      lv_retrygraceperiodseconds = lo_refreshtokenrotationtyp->get_retrygraceperiodseconds( ).
    ENDIF.
  ENDIF.
ENDIF.

The following example creates an app client with all configurable properties set to an example value. The resulting user pool client connects to an analytics client, allows sign-in with username and password, and has two external identity providers associated with it.

DATA(lo_result) = lo_client->createuserpoolclient(
  io_analyticsconfiguration = new /aws1/cl_cgpanalyticsconftype(
    iv_applicationid = |d70b2ba36a8c4dc5a04a0451a31a1e12|
    iv_externalid = |my-external-id|
    iv_rolearn = |arn:aws:iam::123456789012:role/test-cognitouserpool-role|
    iv_userdatashared = ABAP_TRUE
  )
  io_tokenvalidityunits = new /aws1/cl_cgptokvalidityunits00(
    iv_accesstoken = |hours|
    iv_idtoken = |minutes|
    iv_refreshtoken = |days|
  )
  it_allowedoauthflows = VALUE /aws1/cl_cgpoauthflowstype_w=>tt_oauthflowstype(
    ( new /aws1/cl_cgpoauthflowstype_w( |code| ) )
  )
  it_allowedoauthscopes = VALUE /aws1/cl_cgpscopelisttype_w=>tt_scopelisttype(
    ( new /aws1/cl_cgpscopelisttype_w( |aws.cognito.signin.user.admin| ) )
    ( new /aws1/cl_cgpscopelisttype_w( |openid| ) )
  )
  it_callbackurls = VALUE /aws1/cl_cgpcallbackurlslstt00=>tt_callbackurlslisttype(
    ( new /aws1/cl_cgpcallbackurlslstt00( |https://example.com| ) )
    ( new /aws1/cl_cgpcallbackurlslstt00( |http://localhost| ) )
    ( new /aws1/cl_cgpcallbackurlslstt00( |myapp://example| ) )
  )
  it_explicitauthflows = VALUE /aws1/cl_cgpexplicitauthflow00=>tt_explicitauthflowslisttype(
    ( new /aws1/cl_cgpexplicitauthflow00( |ALLOW_ADMIN_USER_PASSWORD_AUTH| ) )
    ( new /aws1/cl_cgpexplicitauthflow00( |ALLOW_USER_PASSWORD_AUTH| ) )
    ( new /aws1/cl_cgpexplicitauthflow00( |ALLOW_REFRESH_TOKEN_AUTH| ) )
  )
  it_logouturls = VALUE /aws1/cl_cgplogouturlslsttyp00=>tt_logouturlslisttype(
    ( new /aws1/cl_cgplogouturlslsttyp00( |https://example.com/logout| ) )
  )
  it_readattributes = VALUE /aws1/cl_cgpclipermlisttype_w=>tt_clientpermissionlisttype(
    ( new /aws1/cl_cgpclipermlisttype_w( |email| ) )
    ( new /aws1/cl_cgpclipermlisttype_w( |address| ) )
    ( new /aws1/cl_cgpclipermlisttype_w( |preferred_username| ) )
  )
  it_supportedidentitypvdrs = VALUE /aws1/cl_cgpsuppedidpvdrslst00=>tt_supportedidpvdrslisttype(
    ( new /aws1/cl_cgpsuppedidpvdrslst00( |SignInWithApple| ) )
    ( new /aws1/cl_cgpsuppedidpvdrslst00( |MySSO| ) )
  )
  it_writeattributes = VALUE /aws1/cl_cgpclipermlisttype_w=>tt_clientpermissionlisttype(
    ( new /aws1/cl_cgpclipermlisttype_w( |family_name| ) )
    ( new /aws1/cl_cgpclipermlisttype_w( |email| ) )
  )
  iv_accesstokenvalidity = 6
  iv_alwedoauthflowsuserpool00 = ABAP_TRUE
  iv_clientname = |my-test-app-client|
  iv_defaultredirecturi = |https://example.com|
  iv_generatesecret = ABAP_TRUE
  iv_idtokenvalidity = 6
  iv_preventuserexenceerrors = |ENABLED|
  iv_refreshtokenvalidity = 6
  iv_userpoolid = |us-east-1_EXAMPLE|
).

/AWS1/IF_CGP=>CREATEUSERPOOLCLIENT()¶

About CreateUserPoolClient¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_userpoolid TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE¶

iv_clientname TYPE /AWS1/CGPCLIENTNAMETYPE /AWS1/CGPCLIENTNAMETYPE¶

Optional arguments:¶

iv_generatesecret TYPE /AWS1/CGPGENERATESECRET /AWS1/CGPGENERATESECRET¶

iv_refreshtokenvalidity TYPE /AWS1/CGPREFRESHTOKVALIDITYT00 /AWS1/CGPREFRESHTOKVALIDITYT00¶

iv_accesstokenvalidity TYPE /AWS1/CGPACCTOKENVALIDITYTYPE /AWS1/CGPACCTOKENVALIDITYTYPE¶

iv_idtokenvalidity TYPE /AWS1/CGPIDTOKENVALIDITYTYPE /AWS1/CGPIDTOKENVALIDITYTYPE¶

io_tokenvalidityunits TYPE REF TO /AWS1/CL_CGPTOKVALIDITYUNITS00 /AWS1/CL_CGPTOKVALIDITYUNITS00¶

it_readattributes TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE TT_CLIENTPERMISSIONLISTTYPE¶

it_writeattributes TYPE /AWS1/CL_CGPCLIPERMLISTTYPE_W=>TT_CLIENTPERMISSIONLISTTYPE TT_CLIENTPERMISSIONLISTTYPE¶

it_explicitauthflows TYPE /AWS1/CL_CGPEXPLICITAUTHFLOW00=>TT_EXPLICITAUTHFLOWSLISTTYPE TT_EXPLICITAUTHFLOWSLISTTYPE¶

it_supportedidentitypvdrs TYPE /AWS1/CL_CGPSUPPEDIDPVDRSLST00=>TT_SUPPORTEDIDPVDRSLISTTYPE TT_SUPPORTEDIDPVDRSLISTTYPE¶

it_callbackurls TYPE /AWS1/CL_CGPCALLBACKURLSLSTT00=>TT_CALLBACKURLSLISTTYPE TT_CALLBACKURLSLISTTYPE¶

it_logouturls TYPE /AWS1/CL_CGPLOGOUTURLSLSTTYP00=>TT_LOGOUTURLSLISTTYPE TT_LOGOUTURLSLISTTYPE¶

iv_defaultredirecturi TYPE /AWS1/CGPREDIRECTURLTYPE /AWS1/CGPREDIRECTURLTYPE¶

it_allowedoauthflows TYPE /AWS1/CL_CGPOAUTHFLOWSTYPE_W=>TT_OAUTHFLOWSTYPE TT_OAUTHFLOWSTYPE¶

it_allowedoauthscopes TYPE /AWS1/CL_CGPSCOPELISTTYPE_W=>TT_SCOPELISTTYPE TT_SCOPELISTTYPE¶

iv_alwedoauthflowsuserpool00 TYPE /AWS1/CGPBOOLEANTYPE /AWS1/CGPBOOLEANTYPE¶

io_analyticsconfiguration TYPE REF TO /AWS1/CL_CGPANALYTICSCONFTYPE /AWS1/CL_CGPANALYTICSCONFTYPE¶

iv_preventuserexenceerrors TYPE /AWS1/CGPPREVTUSEREXENCEERRT00 /AWS1/CGPPREVTUSEREXENCEERRT00¶

iv_enabletokenrevocation TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE /AWS1/CGPWRAPPEDBOOLEANTYPE¶

iv_enbpropagateaddluserctx00 TYPE /AWS1/CGPWRAPPEDBOOLEANTYPE /AWS1/CGPWRAPPEDBOOLEANTYPE¶

iv_authsessionvalidity TYPE /AWS1/CGPAUTHSESSVALIDITYTYPE /AWS1/CGPAUTHSESSVALIDITYTYPE¶

io_refreshtokenrotation TYPE REF TO /AWS1/CL_CGPREFRESHTOKROTATI00 /AWS1/CL_CGPREFRESHTOKROTATI00¶