Programming Guides › Programming Guide for C › Directory API Guidance › Directory API Reference › SmDirRemoveEntry()

SmDirRemoveEntry()

The SiteMinder Policy Server calls SmDirRemoveEntry() so that you can delete a directory entry (user) from your custom directory.

Examples of directory entries are users, groups and roles. For example, if you are using an SQL database and need to remove a group, you could use SmDirRemoveEntry() to delete the relevant record from the groups table (and all related tables) for the database.

If your directory is hierarchical, as with an LDAP directory, you need to handle the process of deleting relevant data at different levels of the hierarchy. It may be helpful to look at the attributes of the entry, such as object class in LDAP.

Syntax

int SM_EXTERN SmDirRemoveEntry (
   const Sm_Api_Context_t*       lpApiContext,
   void*                         pHandle,
   void*                         pInstanceHandle,
   const Sm_PolicyResolution_t   nEntryType,
   const char*                   lpszEntryDN
);

Returns

Returns 0 if successful or -1 if not successful.

Remarks

This function is called when Delegated Management Services is used to delete directory entries, including groups or roles.