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¶
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
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 identity store operations that you can call programatically and includes detailed information on data types and errors.
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¶
Required arguments:¶
IO_SESSION
TYPE REF TO
/AWS1/CL_RT_SESSION_BASE
¶
Optional arguments:¶
IV_PROTOCOL
TYPE
/AWS1/RT_PROTOCOL
¶
IV_REGION
TYPE
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO
/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.