Previous Topic: Utility Functions

Next Topic: Operations on a Directory Entry (User)

Operations on the Directory

The Policy Server calls the directory operations function(s) to let you define directory operations tasks for your custom directory. For example, if a user is using the SiteMinder Administrative UI to search for a user, the Policy Server calls SmDirLookup(). As noted in the following table, some functions are designed to support Delegated Management Services (DMS).

Function Name

Use this function to:

SmDirAddEntry()

Insert a directory entry (user) into your custom directory. Supports DMS.

SmDirAddMemberToGroup()

Add a user or group to an existing group. Supports DMS.

SmDirAddMemberToRole()

Assign a role to a user or to a group. Supports DMS.

SmDirEnumerate()

Retrieve a list of directory entries and corresponding class names.

SmDirGetDirConnection()

Get the connection handle to the directory.

SmDirGetDirObjInfo()

Get information about the object specified in the object parameter.

SmDirGetGroupMembers()

Retrieve the members of a user group. Supports DMS.

SmDirGetLastErrMsg()

Determine which instance handle is passed, and return the associated error message. Also used with directory entry (user) operations.

SmDirGetRoleMembers()

Retrieve the directory entries assigned to a role. Supports DMS.

SmDirLookup()

Look up a pattern in the directory.

SmDirRemoveEntry()

Delete a directory entry (user) from your custom directory. Supports DMS.

SmDirRemoveMemberFromGroup()

Remove a user or group from a existing group. Supports DMS.

SmDirRemoveMemberFromRole()

Remove a user or group from an assigned role. Supports DMS.

SmDirSearch()

Search on the criteria specified in the search filter parameter.

SmDirSearchCount()

Return a count of the entries that meet the criteria specified in the parameters.

SmDirValidateInstance()

Determine which instance handle is passed, and validate that instance. Also used with directory entry (user) operations.

SmDirValidateUserDN()

Perform any needed validation on the user ID.

SmDirValidateUsername()

Convert the credentials presented by the user to a user ID for the custom directory.


Copyright © 2010 CA. All rights reserved. Email CA about this topic