API for AWS Single Sign-On¶

ABAP Package	`/AWS1/API_SSO_IMPL`
ABAP SDK "TLA"	`SSO`
ABAP Interface	`/AWS1/IF_SSO`

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 is SSO. 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 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¶

AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

Although AWS Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see IAM Identity Center rename.

This reference guide describes the IAM Identity Center Portal operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS 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, which is created with factory method /AWS1/CL_SSO_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_sso)       = /aws1/cl_sso_factory=>create( go_session ).

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

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_SSO.

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_SSO` `/AWS1/IF_SSO`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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