GETGROUPID()`¶

About GetGroupId¶

Retrieves GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Method Signature¶

METHODS /AWS1/IF_IDS~GETGROUPID
  IMPORTING
    !IV_IDENTITYSTOREID TYPE /AWS1/IDSIDENTITYSTOREID OPTIONAL
    !IO_ALTERNATEIDENTIFIER TYPE REF TO /AWS1/CL_IDSALTERNATEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_idsgetgroupidresponse
  RAISING
    /AWS1/CX_IDSACCESSDENIEDEX
    /AWS1/CX_IDSINTERNALSERVEREX
    /AWS1/CX_IDSTHROTTLINGEX
    /AWS1/CX_IDSRESOURCENOTFOUNDEX
    /AWS1/CX_IDSVALIDATIONEX
    /AWS1/CX_IDSCLIENTEXC
    /AWS1/CX_IDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_identitystoreid` `TYPE /AWS1/IDSIDENTITYSTOREID` `/AWS1/IDSIDENTITYSTOREID`¶

The globally unique identifier for the identity store.

`io_alternateidentifier` `TYPE REF TO /AWS1/CL_IDSALTERNATEID` `/AWS1/CL_IDSALTERNATEID`¶

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_idsgetgroupidresponse` `/AWS1/CL_IDSGETGROUPIDRESPONSE`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getgroupid(
  io_alternateidentifier = new /aws1/cl_idsalternateid(
    io_externalid = new /aws1/cl_idsexternalid(
      iv_id = |string|
      iv_issuer = |string|
    )
    io_uniqueattribute = new /aws1/cl_idsuniqueattribute(
      io_attributevalue = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
      iv_attributepath = |string|
    )
  )
  iv_identitystoreid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourceid = lo_result->get_groupid( ).
  lv_identitystoreid = lo_result->get_identitystoreid( ).
ENDIF.

/AWS1/IF_IDS=>GETGROUPID()¶