API for AWS SSO Identity Store¶

ABAP Package	`/AWS1/API_IDS`
ABAP SDK "TLA"	`IDS`
ABAP Interface	`/AWS1/IF_IDS`

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 AWS SSO Identity Store is IDS. 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 identitystore 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¶

IAM Identity Center uses the sso, sso-directory, and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.

The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). You can use the identity store API operations in this guide to manage your identity data programmatically. The scope of these APIs allows you to create, read, update, delete, and list users, groups, and memberships.

This guide also describes identity store operations that you can call and includes detailed information about data types and errors.

If you use an external identity provider or Active Directory as your identity source, we recommend that you use the Create, Update, and Delete APIs with caution. Because IAM Identity Center doesn't support outbound synchronization, your identity source won't automatically update with the changes that you make to users or groups using these APIs.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to programmatically access the identity store and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Amazon Web Services Builder Center Toolbox.

Using the SDK¶

In your code, create a client using the SDK module for AWS SSO Identity Store, which is created with factory method /AWS1/CL_IDS_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_ids)       = /aws1/cl_ids_factory=>create( go_session ).

Your variable go_ids is an instance of /AWS1/IF_IDS, and all of the operations in the AWS SSO Identity Store service are accessed by calling methods in /AWS1/IF_IDS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS SSO Identity Store, see the Operation List.

Factory Method¶

`/AWS1/CL_IDS_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_IDS.

IMPORTING¶

Optional arguments:¶

`iv_protocol` `TYPE /aws1/rt_protocol` `/AWS1/RT_PROTOCOL`¶

`io_session` `TYPE REF TO /aws1/cl_rt_session_base` `/AWS1/CL_RT_SESSION_BASE`¶

`iv_region` `TYPE /aws1/rt_region_id` `/AWS1/RT_REGION_ID`¶

`iv_custom_endpoint` `TYPE /aws1/rt_endpoint` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`oo_client` `TYPE REF TO /aws1/if_ids` `/AWS1/IF_IDS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS SSO Identity Store can be created via get_paginator() which returns a paginator object of type /AWS1/IF_IDS_PAGINATOR. 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 AWS SSO Identity Store can be found in interface /AWS1/IF_IDS_PAGINATOR.