DESCRIBEGROUP()`¶

About DescribeGroup¶

Retrieves the group metadata and attributes from 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~DESCRIBEGROUP
  IMPORTING
    !IV_IDENTITYSTOREID TYPE /AWS1/IDSIDENTITYSTOREID OPTIONAL
    !IV_GROUPID TYPE /AWS1/IDSRESOURCEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_idsdescrgroupresponse
  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, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

`iv_groupid` `TYPE /AWS1/IDSRESOURCEID` `/AWS1/IDSRESOURCEID`¶

The identifier for a group in the identity store.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_idsdescrgroupresponse` `/AWS1/CL_IDSDESCRGROUPRESPONSE`¶

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->describegroup(
  iv_groupid = |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_groupdisplayname = lo_result->get_displayname( ).
  LOOP AT lo_result->get_externalids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_externalidissuer = lo_row_1->get_issuer( ).
      lv_externalididentifier = lo_row_1->get_id( ).
    ENDIF.
  ENDLOOP.
  lv_sensitivestringtype = lo_result->get_description( ).
  lv_datetype = lo_result->get_createdat( ).
  lv_datetype = lo_result->get_updatedat( ).
  lv_stringtype = lo_result->get_createdby( ).
  lv_stringtype = lo_result->get_updatedby( ).
  lv_identitystoreid = lo_result->get_identitystoreid( ).
ENDIF.

/AWS1/IF_IDS=>DESCRIBEGROUP()¶