Skip to content

API for Amazon Cognito Identity Provider

ABAP Package /AWS1/API_CGP_IMPL
ABAP SDK "TLA" CGP
ABAP Interface /AWS1/IF_CGP

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Cognito Identity Provider is CGP. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Cognito Identity Provider module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and managed login reference.

This API reference provides detailed information about API operations and object types in Amazon Cognito.

Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.

  1. An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.

  2. A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.

  3. A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.

For more information, see Understanding API, OIDC, and managed login pages authentication in the Amazon Cognito Developer Guide.

With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the CognitoIdentityProvider client in supported Amazon Web Services SDKs.

To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.

Using the SDK

In your code, create a client using the SDK module for Amazon Cognito Identity Provider, which is created with factory method /AWS1/CL_CGP_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_cgp)       = /aws1/cl_cgp_factory=>create( go_session ).

Your variable go_cgp is an instance of /AWS1/IF_CGP, and all of the operations in the Amazon Cognito Identity Provider service are accessed by calling methods in /AWS1/IF_CGP.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon Cognito Identity Provider, see the Operation List.

Factory Method

/AWS1/CL_CGP_FACTORY=>create( )

Creates an object of type /AWS1/IF_CGP.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_CGP /AWS1/IF_CGP

/AWS1/IF_CGP represents the ABAP client for the Cognito Identity Provider service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_cgp)->get_config( ).

lo_config is a variable of type /AWS1/CL_CGP_CONFIG. See the documentation for /AWS1/CL_CGP_CONFIG for details on the settings that can be configured.

Paginators

Paginators for Amazon Cognito Identity Provider can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_CGP_PAGINATOR`](./_AWS1_IF_CGP_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.

Details about the paginator methods available for service Amazon Cognito Identity Provider can be found in interface [`/AWS1/IF_CGP_PAGINATOR`](./_AWS1_IF_CGP_PAGINATOR.md).