com.netegrity.sdk.dmsapi
Class SmDmsRole

java.lang.Object
  |
  +--com.netegrity.sdk.dmsapi.SmDmsObject
        |
        +--com.netegrity.sdk.dmsapi.SmDmsRole

public class SmDmsRole

extends SmDmsObject

Represents a DMS role object within an organization.

A role describes a user’s function in an organization. This allows the user to be managed with other users who have the same privileges. For example, a user who can order items online and view an inventory list may have the role buyer.

Roles are linked to SiteMinder policies to grant access privileges to protected resources. Therefore, role assignment saves administrators from moving individual users in and out of SiteMinder policies. For example, you can create a policy that allows users with the role buyer to access the protected resource orderform.html.

Since:

SDK 2.0

Field Summary

Fields inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

DMSOBJECT_CLASS_DIRECTORY, DMSOBJECT_CLASS_GROUP, DMSOBJECT_CLASS_ORGANIZATION, DMSOBJECT_CLASS_ROLE, DMSOBJECT_CLASS_UNKNOWN, DMSOBJECT_CLASS_USER

Method Summary

SmApiResult

getMembers(java.util.Vector members) Gets the members associated with a role.

Methods inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

addObject, addToGroup, clearAttributes, deleteObject, getApiSession, getAttribute, getAttributes, getClassId, getDmsConfig, getDn, getGroups, getGroups, getObject, getObject, getOrganizationDn, getRealm, getUserDirectory, getVersion, isActiveDir, modifyObject, modifyObjectClass, newDmsObject, readAttributes, removeFromGroup, setActiveDir, setAttribute, setAttributes, setClassId, toString, writeAttributes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getMembers

public SmApiResult getMembers(java.util.Vector members)
                       throws SmApiException

Gets the members associated with a role.

This method requires an organization administrator session or higher.

Parameters:

members - Vector output parameter containing the distinguished names of role members (String).

SmApiException