ADDGROUPMEMBER()`¶

About AddGroupMember¶

Adds an existing user, group, or computer as a group member.

Method Signature¶

METHODS /AWS1/IF_DSD~ADDGROUPMEMBER
  IMPORTING
    !IV_DIRECTORYID TYPE /AWS1/DSDDIRECTORYID OPTIONAL
    !IV_GROUPNAME TYPE /AWS1/DSDGROUPNAME OPTIONAL
    !IV_MEMBERNAME TYPE /AWS1/DSDMEMBERNAME OPTIONAL
    !IV_MEMBERREALM TYPE /AWS1/DSDREALM OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/DSDCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsdaddgroupmemberrslt
  RAISING
    /AWS1/CX_DSDACCESSDENIEDEX
    /AWS1/CX_DSDCONFLICTEXCEPTION
    /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 that's associated with the group.

`iv_groupname` `TYPE /AWS1/DSDGROUPNAME` `/AWS1/DSDGROUPNAME`¶

The name of the group.

`iv_membername` `TYPE /AWS1/DSDMEMBERNAME` `/AWS1/DSDMEMBERNAME`¶

The SAMAccountName of the user, group, or computer to add as a group member.

Optional arguments:¶

`iv_memberrealm` `TYPE /AWS1/DSDREALM` `/AWS1/DSDREALM`¶

The domain name that's associated with the group member. This parameter is required only when adding a member outside of your Managed Microsoft AD domain to a group inside of your Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain.

This parameter is case insensitive.

`iv_clienttoken` `TYPE /AWS1/DSDCLIENTTOKEN` `/AWS1/DSDCLIENTTOKEN`¶

A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

This parameter is optional when using the CLI or SDK.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dsdaddgroupmemberrslt` `/AWS1/CL_DSDADDGROUPMEMBERRSLT`¶

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->addgroupmember(
  iv_clienttoken = |string|
  iv_directoryid = |string|
  iv_groupname = |string|
  iv_membername = |string|
  iv_memberrealm = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

To add a member to the Marketing group¶

The following command adds an existing user to the Marketing group in the europe.example.com domain.

DATA(lo_result) = lo_client->addgroupmember(
  iv_clienttoken = |550e8400-e29b-41d4-a716-446655440000|
  iv_directoryid = |d-12233abcde|
  iv_groupname = |Marketing|
  iv_membername = |Pat Candella|
  iv_memberrealm = |europe.example.com|
).

/AWS1/IF_DSD=>ADDGROUPMEMBER()¶