DESCRIBEGROUP()`¶

About DescribeGroup¶

Returns information about a specific group.

Method Signature¶

METHODS /AWS1/IF_DSD~DESCRIBEGROUP
  IMPORTING
    !IV_DIRECTORYID TYPE /AWS1/DSDDIRECTORYID OPTIONAL
    !IV_REALM TYPE /AWS1/DSDREALM OPTIONAL
    !IV_SAMACCOUNTNAME TYPE /AWS1/DSDGROUPNAME OPTIONAL
    !IT_OTHERATTRIBUTES TYPE /AWS1/CL_DSDLDAPDSPNAMELIST_W=>TT_LDAPDISPLAYNAMELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsddescrgroupresult
  RAISING
    /AWS1/CX_DSDACCESSDENIEDEX
    /AWS1/CX_DSDDIRECTORYUNAVAILEX
    /AWS1/CX_DSDINTERNALSERVEREX
    /AWS1/CX_DSDRESOURCENOTFOUNDEX
    /AWS1/CX_DSDTHROTTLINGEX
    /AWS1/CX_DSDVALIDATIONEX
    /AWS1/CX_DSDCLIENTEXC
    /AWS1/CX_DSDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_directoryid` `TYPE /AWS1/DSDDIRECTORYID` `/AWS1/DSDDIRECTORYID`¶

The Identifier (ID) of the directory associated with the group.

`iv_samaccountname` `TYPE /AWS1/DSDGROUPNAME` `/AWS1/DSDGROUPNAME`¶

The name of the group.

Optional arguments:¶

`iv_realm` `TYPE /AWS1/DSDREALM` `/AWS1/DSDREALM`¶

The domain name that's associated with the group.

This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

This value is case insensitive.

`it_otherattributes` `TYPE /AWS1/CL_DSDLDAPDSPNAMELIST_W=>TT_LDAPDISPLAYNAMELIST` `TT_LDAPDISPLAYNAMELIST`¶

One or more attributes to be returned for the group. For a list of supported attributes, see Directory Service Data Attributes.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dsddescrgroupresult` `/AWS1/CL_DSDDESCRGROUPRESULT`¶

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(
  it_otherattributes = VALUE /aws1/cl_dsdldapdspnamelist_w=>tt_ldapdisplaynamelist(
    ( new /aws1/cl_dsdldapdspnamelist_w( |string| ) )
  )
  iv_directoryid = |string|
  iv_realm = |string|
  iv_samaccountname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_directoryid = lo_result->get_directoryid( ).
  lv_realm = lo_result->get_realm( ).
  lv_sid = lo_result->get_sid( ).
  lv_groupname = lo_result->get_samaccountname( ).
  lv_distinguishedname = lo_result->get_distinguishedname( ).
  lv_grouptype = lo_result->get_grouptype( ).
  lv_groupscope = lo_result->get_groupscope( ).
  LOOP AT lo_result->get_otherattributes( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_stringattributevalue = lo_value->get_s( ).
      lv_numberattributevalue = lo_value->get_n( ).
      lv_booleanattributevalue = lo_value->get_bool( ).
      LOOP AT lo_value->get_ss( ) into lo_row_1.
        lo_row_2 = lo_row_1.
        IF lo_row_2 IS NOT INITIAL.
          lv_stringattributevalue = lo_row_2->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

To return the attributes of a group¶

The following command returns the mapped attributes for a group along with the display name, description, and GUID for the group.

DATA(lo_result) = lo_client->describegroup(
  it_otherattributes = VALUE /aws1/cl_dsdldapdspnamelist_w=>tt_ldapdisplaynamelist(
    ( new /aws1/cl_dsdldapdspnamelist_w( |displayName| ) )
    ( new /aws1/cl_dsdldapdspnamelist_w( |description| ) )
    ( new /aws1/cl_dsdldapdspnamelist_w( |objectGUID| ) )
  )
  iv_directoryid = |d-12233abcde|
  iv_realm = |example.domain.com|
  iv_samaccountname = |DevOpsMail|
).

/AWS1/IF_DSD=>DESCRIBEGROUP()¶