Skip to content

API for AWS Single Sign-On Admin

ABAP Package /AWS1/API_SSA_IMPL
ABAP SDK "TLA" SSA
ABAP Interface /AWS1/IF_SSA

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 Single Sign-On Admin is SSA. 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 SSO Admin 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 (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.

IAM Identity Center uses the sso and identitystore API namespaces.

This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.

Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.

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 create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

Using the SDK

In your code, create a client using the SDK module for AWS Single Sign-On Admin, which is created with factory method /AWS1/CL_SSA_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_ssa)       = /aws1/cl_ssa_factory=>create( go_session ).

Your variable go_ssa is an instance of /AWS1/IF_SSA, and all of the operations in the AWS Single Sign-On Admin service are accessed by calling methods in /AWS1/IF_SSA.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS Single Sign-On Admin, see the Operation List.

Factory Method

/AWS1/CL_SSA_FACTORY=>create( )

Creates an object of type /AWS1/IF_SSA.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_SSA

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

Configuring Programmatically

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

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

Paginators

Paginators for AWS Single Sign-On Admin can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SSA_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 Single Sign-On Admin can be found in interface /AWS1/IF_SSA_PAGINATOR.