EssDeleteGroupEx

Deletes an existing group. Similar to EssDeleteGroup, but can accept a user directory specification or unique identity attribute for GroupID.

Syntax

ESS_FUNC_M EssDeleteGroupEx (hCtx, GroupId, bisIdentity );

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle (input).
GroupId	ESS_STR_T	Name of group to delete (input). Can be specified as groupname@provider or as a unique identity attribute.
bIsIdentity	ESS_BOOL_T	Input. Indicates if GroupId is a name or an identity. If TRUE, GroupId is an identity.

Return Value

None.

Access

This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Example

ESS_FUNC_M ESS_DeleteGroupEx (ESS_HCTX_T hCtx)
{
   ESS_STS_T sts = ESS_STS_NOERR;
   ESS_STR_T groupId;
   ESS_BOOL_T bIsIdentity;
   
   groupId = "IDTempGroup1@ldap";
   bIsIdentity = ESS_FALSE;
   sts = EssDeleteGroupEx(hCtx, groupId, bIsIdentity);
   printf("EssDeleteGroupEx sts: %ld\n", sts);
   
   return (sts);
}