EssDeleteUserEx

Deletes a user. Similar to EssDeleteUser, but can accept a user directory specification or unique identity attribute.

Syntax

ESS_FUNC_M EssDeleteUserEx (hCtx, UserId, bIsIdentity);

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

Notes

The caller may not delete itself nor the last Administrator on the server.

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_DeleteUserEx (ESS_HCTX_T hCtx)
{
   ESS_FUNC_M sts = ESS_STS_NOERR;
   ESS_STR_T userId;
   ESS_BOOL_T bIsIdentity;
   
   userId = "IDUser3@ldap";
   bIsIdentity = ESS_FALSE;
   sts = EssDeleteUserEx(hCtx, userId, bIsIdentity);
   printf("EssDeleteUserEx sts: %ld\n", sts);

   return (sts);
}