Previous Topic: Operations on the DirectoryNext Topic: Directory API Reference


Operations on a Directory Entry (User)

The operations covered in this section apply to directory entries, such as users, groups and roles.

The SiteMinder Policy Server calls the directory entry (user) operation function(s) relevant to the operation performed. For example, if a user is using the SiteMinder Administrative UI to disable a user account, the SiteMinder Policy Server calls SmDirSetUserDisabledState().

Function Name

Use this function to:

SmDirAuthenticateUser()

Check the directory for the provided user name and password.

SmDirChangeUserPassword()

Change the value in the password field for the specified user.

SmDirGetLastErrMsg()

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

SmDirGetUserAttr()

Retrieve the value of the specified user attribute.

SmDirGetUserAttrMulti()

Retrieve an array of values for a single attribute.

SmDirGetUserClasses()

Get the object classes for the specified DN.

SmDirGetUserDisabledState()

For disabled user accounts, return the reason that an account is disabled. Otherwise, return enabled.

SmDirGetUserGroups()

Retrieve the groups to which a user belongs.

SmDirGetUserProperties()

Return the names of all user attributes or only required user attributes.

SmDirGetUserRoles()

Retrieve the roles to which a user belongs.

SmDirSetUserAttr()

Set the value for a user attribute.

SmDirSetUserAttrMulti()

Set an array of values for a single attribute.

SmDirSetUserDisabledState()

Enable or disable a user account.

SmDirValidateInstance()

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

SmDirValidateUserPolicy
   Relationship()

Validate the relationship between policy objects.