com.netegrity.sdk.policyapi
Interface SmPolicyApi

All Known Subinterfaces:

SmImsPolicyApi

All Known Implementing Classes:

SmImsPolicyApiImpl, SmPolicyApiImpl

public interface SmPolicyApi

Provides methods for creating and managing SiteMinder policy store objects.

Since:

SDK 2.0

Field Summary

static int

SMPOLICYAPI_VERSION_20 Client-supplied constant indicating that Policy Server operations should comply with version 2.0 of the Policy Server API.

Method Summary

SmApiResult	addAdmin(SmAdmin admin) Creates a SiteMinder Administrator.
SmApiResult	addAdminToDomain(java.lang.String adminName, java.lang.String domainName) Associates a SiteMinder Administrator with a domain.
SmApiResult	addAgent(SmAgent agent) Creates an Agent object.
SmApiResult	addAgentConfig(SmAgentConfig agentConfig) Creates an Agent Configuration object.
SmApiResult	addAgentType(SmAgentType agentType) Creates an AgentType object.
SmApiResult	addAgentTypeAttr(SmAgentTypeAttr agentTypeAttr) Creates an AgentTypeAttr object.
SmApiResult	addAuthAzMap(SmAuthAzMap authAzMap) Adds an authentication and authorization directory mapping object.
SmApiResult	addAuthValidateMap(SmAuthValidateMap authValidateMap) Adds an authentication and validation directory mapping object.
SmApiResult	addCertMap(SmCertMap certMap) Adds a certificate mapping object.
SmApiResult	addDomain(SmDomain domain) Creates a domain.
SmApiResult	addGroup(java.lang.String domainName, SmObject group) Creates a new group of any type (rule, response, agent).
SmApiResult	addHostConfig(SmHostConfig hostConfig) Creates a Host Configuration object.
SmApiResult	addODBCQuery(SmODBCQuery odbcQuery) Adds an ODBC query.
SmApiResult	addPasswordPolicy(SmPasswordPolicy passwordPolicy) Creates a password policy.
SmApiResult	addPolicy(SmPolicy policy) Adds a policy .
SmApiResult	addPolicy(SmPolicy policy, boolean bIsGlobal) Adds a policy object.
SmApiResult	addPolicyLink(SmPolicyLink policyLink) Adds a policy link to a policy.
SmApiResult	addPolicyLink(SmPolicyLink policyLink, boolean bIsGlobal) Adds a global PolicyLink if the boolean passed is true.
SmApiResult	addRealm(SmRealm realm) Adds a realm and associates it with a domain.
SmApiResult	addRegularExpressionToPasswordPolicy(SmPwdPolicyRegularExpression regularExpression) Adds the regular expression to password policy.
SmApiResult	addResponse(SmResponse response) Creates a response and associates it with a domain.
SmApiResult	addResponse(SmResponse response, boolean bIsGlobal) Creates a global response if bIsGlobal is true
SmApiResult	addResponseAttr(SmResponseAttr responseAttr) Creates a response attribute and associates it with a response.
SmApiResult	addResponseAttr(SmResponseAttr responseAttr, boolean bIsGlobal) Creates a global response attribute if bIsGlobal is true
SmApiResult	addRootConfig(SmRootConfig rootConfig) Creates a root configuration.
SmApiResult	addRule(SmRule rule) Adds a rule and associates it with the specified realm.
SmApiResult	addRule(SmRule Rule, boolean bIsGlobal) Adds a global rule if the boolean passed is true.
SmApiResult	addScheme(SmScheme scheme) Creates an authentication scheme.
SmApiResult	addSelfReg(SmSelfReg selfReg) Creates a self-registration object.
SmApiResult	addToGroup(int groupType, java.lang.String itemName, java.lang.String groupName, java.lang.String domainName) Adds a group member of any type (rule, response, agent) to the specified group.
SmApiResult	addTrustedHost(SmTrustedHost trustedHost) Registers a trusted host with the Policy Server.
SmApiResult	addUserDirectory(SmUserDirectory userDir) Adds a user directory.
SmApiResult	addUserDirToDomain(java.lang.String userDirName, java.lang.String domainName) Associates a user directory with a domain.
SmApiResult	addUserPolicy(SmUserPolicy userPolicy) Adds a user policy to a policy.
SmApiResult	addVariable(SmVariable variable) Adds a variable .
SmApiResult	changeDynamicKey() Changes a dynamic encryption key.
SmApiResult	changePersistentKey(java.lang.String persistentKey) Changes a persistent encryption key.
SmApiResult	changeSessionKey(java.lang.String sessionKey) Changes a session encryption key.
SmApiResult	changeSharedSecretKey() Changes a shared secret encryption key.
SmApiResult	deleteAdmin(java.lang.String adminName) Deletes a SiteMinder Administrator.
SmApiResult	deleteAgent(java.lang.String agentName) Deletes an Agent object.
SmApiResult	deleteAgentConfig(java.lang.String agentConfigName) Deletes an Agent Configuration object.
SmApiResult	deleteAgentType(java.lang.String szAgentTypeName) Deletes an AgentType object.
SmApiResult	deleteAgentTypeAttr(java.lang.String szAgentTypeAttrName) Deletes an AgentTypeAttr object.
SmApiResult	deleteAuthAzMap(SmObjId authAzMapId) Deletes an authentication and authorization directory mapping object.
SmApiResult	deleteAuthValidateMap(SmObjId authValidateMapOid) Deletes an authentication and validation directory mapping object.
SmApiResult	deleteCertMap(SmObjId certMapId) Deletes a certificate mapping object.
SmApiResult	deleteDomain(java.lang.String domainName) Deletes a domain.
SmApiResult	deleteGroup(int groupType, java.lang.String groupName, java.lang.String domainName) Deletes a group of any type (rule, response, agent).
SmApiResult	deleteHostConfig(java.lang.String hostConfigName) Deletes a Host Configuration object.
SmApiResult	deleteODBCQuery(java.lang.String odbcQueryName) Deletes an ODBC query.
SmApiResult	deletePasswordPolicy(java.lang.String passwordPolicy) Deletes a password policy.
SmApiResult	deletePolicy(SmPolicy policy) Deletes a policy.
SmApiResult	deletePolicyLink(SmObjId policyLinkOid, java.lang.String domainName) Deletes a policy link.
SmApiResult	deleteRealm(SmRealm realm) Deletes a realm.
SmApiResult	deleteResponse(SmResponse response) Deletes a response.
SmApiResult	deleteResponseAttr(SmObjId responseAttrOid, java.lang.String domainName) Deletes a response attribute.
SmApiResult	deleteRootConfig(SmObjId rootConfigId) Deletes a root configuration.
SmApiResult	deleteRule(SmRule rule) Deletes a rule that is associated with the specified realm.
SmApiResult	deleteScheme(java.lang.String schemeName) Deletes an authentication scheme.
SmApiResult	deleteSelfReg(java.lang.String selfRegName) Deletes a self-registration object.
SmApiResult	deleteTrustedHost(java.lang.String trustedHostName) Deletes a Trusted Host object.
SmApiResult	deleteUserDirectory(java.lang.String userDirName) Deletes a user directory.
SmApiResult	deleteUserPolicy(SmObjId UserPolicyOid, java.lang.String domainName) Deletes a user policy under a given domain.
SmApiResult	deleteVariable(SmVariable variable) Deletes a Variable.
SmApiResult	doExport(SmExportAttr objExportAttr) Exports policy data from a remote Policy Server.
SmApiResult	doImport(SmImportAttr objImportAttr) Imports policy data stored on a local client into remote Policy Server.
SmApiResult	flushAll() Flushes all SiteMinder caches.
SmApiResult	flushRealm(java.lang.String realmOid) Flushes a realm from the resource cache.
SmApiResult	flushRealms() Flushes all realms from the resource cache.
SmApiResult	flushUser(java.lang.String userDirectory, java.lang.String userDn) Flushes a user from the user information cache.
SmApiResult	flushUsers() Flushs the user information cache.
SmApiResult	getAdmin(java.lang.String adminName, SmAdmin admin) Gets the contents of a SiteMinder Administrator.
SmApiResult	getAdminDomains(java.lang.String szAdminName, java.util.Vector adminDomains) Gets the all UserDirectory which is added by Domain of the Administrator object
SmApiResult	getAdminUserDirs(java.lang.String adminName, java.util.Vector userDirs) Gets a list of user directories that an administrator can manage.
SmApiResult	getAgent(java.lang.String agentName, SmAgent agent) Gets the contents of an Agent object.
SmApiResult	getAgentConfig(java.lang.String agentConfigName, SmAgentConfig agentConfig) Gets the contents of an Agent Configuration object.
SmApiResult	getAgentType(java.lang.String szAgentTypeName, SmAgentType agenttype) Gets the contents of an Agent Type object.
SmApiResult	getAgentTypeAttr(java.lang.String agentTypeAttrName, SmAgentTypeAttr agenttypeattr) Gets the contents of an Agent Type object.
SmApiResult	getAgentTypeAttrs(java.lang.String szAgentTypeName, java.util.Vector agentTypeAttrs) Gets the Oids of all AgentTypeAttr objects of the specified Agent Type
SmApiResult	getAuthAzMap(SmObjId authAzMapId, SmAuthAzMap authAzMap) Gets the contents of an authentication and authorization directory mapping object.
SmApiResult	getAuthValidateMap(SmObjId authValidateMapOid, SmAuthValidateMap authValidateMap) Gets the contents of an authentication and validation directory mapping object.
SmApiResult	getCertMap(SmObjId certMapId, SmCertMap certMap) Gets the properties of a certificate mapping object.
SmApiResult	getChildren(java.lang.String szOid, java.util.Vector Children) Gets a list of OIDs of realms under a domain or gets the list of rules and realms under a realm
SmApiResult	getDirectoryContents(java.lang.String userDirName, java.util.Hashtable enumerateResult) Enumerates a user directory.
SmApiResult	getDomain(java.lang.String domainName, SmDomain domain) Gets the contents of a domain object.
SmApiResult	getDomainObject(java.lang.String objName, java.lang.String domainName, SmDomainObject obj) Gets a domain object by name or object identifier (OID).
SmApiResult	getDomainObjectNames(java.lang.String propName, java.lang.String domainName, java.util.Vector objectNames) Gets a list of domain objects within a domain.
SmApiResult	getDomainVariables(java.lang.String szDomainName, java.util.Vector variables) Gets the List of the variables present in a domain.
SmApiResult	getGlobalObjectNames(java.lang.String propName, java.util.Vector objectNames) Gets a list of global objects.
SmApiResult	getGroup(java.lang.String groupName, java.lang.String domainName, SmObject group) Gets the contents of a group of any type (rule, response, agent).
SmApiResult	getGroupMembers(int groupType, java.lang.String groupName, java.lang.String domainName, java.util.Vector names) Gets a list of groups of any type (rule, response, and agent).
SmApiResult	getHostConfig(java.lang.String hostConfigName, SmHostConfig hostConfig) Gets the contents of a Host Configuration object.
SmApiResult	getKeyManagement(java.lang.String szOid, SmKeyManagement keyManagement) Gets the contents of an SmKeyManagement object.
SmApiResult	getObject(java.lang.String objName, SmObject obj) Gets a global object by name or object identifier (OID).
SmApiResult	getODBCQuery(java.lang.String odbcQueryName, SmODBCQuery odbcQuery) Gets the contents of an ODBC query.
SmApiResult	getPasswordPolicy(java.lang.String passwordPolicyName, SmPasswordPolicy passwordPolicy) Gets the contents of a password policy.
SmApiResult	getPasswordState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState passwordstate) Gets the password state of the user which includes login failures, disabled time, last login time, last password change and previous login time.
SmApiResult	getPolicy(java.lang.String policyName, java.lang.String domainName, SmPolicy policy) Gets the contents of a policy.
SmApiResult	getPolicyLinks(java.lang.String policyName, java.lang.String domainName, java.util.Vector policyLinks) Returns all policy links for the specified policy and domain.
SmApiResult	getPolicyStoreVersion(java.lang.StringBuffer majorVersion, java.lang.StringBuffer minorVersion, java.lang.StringBuffer mode)
SmApiResult	getRealm(java.lang.String realmName, java.lang.String domainName, SmRealm realm) Gets the contents of a realm.
SmApiResult	getRealmRealms(java.lang.String realmName, java.lang.String domainName, java.util.Vector Realms) Returns all of the realms for the specified realm and domain.
SmApiResult	getRealmRules(java.lang.String realmName, java.lang.String domainName, java.util.Vector Rules) Returns all of the rules for the specified realm and domain.
SmApiResult	getRealmUserPolicies(java.lang.String realmOID, java.util.Vector userPolicyOIDs) Gets a list of user policies that can access a realm.
SmApiResult	getRegularExpressions(java.lang.String passwordPolicyName, java.util.Vector regExpressions) Gets the list of regular expression for a password policy object.
SmApiResult	getResponse(java.lang.String responseName, java.lang.String domainName, SmResponse response) Gets the contents of a response.
SmApiResult	getResponseAttrs(java.lang.String responseName, java.lang.String domainName, java.util.Map responseAttrs) Gets a list of response attributes.
SmApiResult	getResponseAttrs(java.lang.String responseName, java.lang.String domainName, java.util.Vector responseAttrs) Gets a list of response attributes that belong to a response.
SmApiResult	getRootConfig(SmObjId rootConfigId, SmRootConfig rootConfig) Gets the root configuration.
SmApiResult	getRule(java.lang.String ruleName, java.lang.String realmOid, java.lang.String domainName, SmRule rule) Gets the contents of a rule that is associated with the specified realm.
SmApiResult	getScheme(java.lang.String schemeName, SmScheme scheme) Gets the contents of an authentication scheme.
SmApiResult	getSelfReg(java.lang.String selfRegName, SmSelfReg selfReg) Gets the contents of a self-registration object.
SmApiResult	getSharedSecretPolicy(java.lang.String szOid, SmSharedSecretPolicy sharedSecretPolicy) Gets the contents of an SmSharedSecretPolicy object.
SmApiResult	getUserContext(SmObjId dirOid, java.lang.String userDn, java.lang.String sessionId, SmUserContext userContext) Returns contextual information of a given user.
SmApiResult	getUserDirectory(java.lang.String userDirName, SmUserDirectory userDir) Gets the contents of a user directory.
SmApiResult	getUserDirSearchOrder(java.lang.String domainName, java.util.Vector directoryNames) Retrieves the search order of user directories for a domain.
SmApiResult	getUserGroups(SmObjId dirOid, java.lang.String userDn, boolean recursive, java.util.Vector groups) Returns a list of groups that a user is a member of.
SmApiResult	getUserPolicies(java.lang.String policyName, java.lang.String domainName, java.util.Vector UserPolicies) Gets all user policies for a given policy.
SmApiResult	getUserState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState userstate) Gets the user state as enable/disable with the disabled reason for the disabled state, if disabled.
SmApiResult	getVariable(java.lang.String szVariableName, java.lang.String szDomainName, SmVariable variable) Gets the contents of a Variable.
SmApiResult	getVariableType(java.lang.String szVariableType, SmVariableType variableType) Gets the contents of a VariableType.
int	getVersion() Gets the Policy API version compliance level.
boolean	IsGroup(java.lang.String szOid) Returns whether the OID passed is of an group or not.
SmApiResult	lookupDirectory(java.lang.String userDirName, java.lang.String searchPattern, java.util.Hashtable lookupResult) Performs a user directory lookup.
SmApiResult	modifyAdmin(SmAdmin admin) Modifies a SiteMinder Administrator.
SmApiResult	modifyAgent(SmAgent agent) Modifies an Agent object.
SmApiResult	modifyAgentConfig(SmAgentConfig agentConfig) Modifies an Agent Configuration object.
SmApiResult	modifyAgentType(SmAgentType agentType) Modifies an AgentType object.
SmApiResult	modifyAgentTypeAttr(SmAgentTypeAttr agentTypeAttr) Modifies an AgentTypeAttr object.
SmApiResult	modifyAuthAzMap(SmAuthAzMap authAzMap) Modifies an authentication and authorization directory mapping object.
SmApiResult	modifyAuthValidateMap(SmAuthValidateMap authValidateMap) Modifies an authentication and validation directory mapping object.
SmApiResult	modifyCertMap(SmCertMap certMap) Modifies a certificate mapping object.
SmApiResult	modifyDomain(SmDomain domain) Modifies a domain.
SmApiResult	modifyGroup(java.lang.String domainName, SmObject group) Modifies a group of any type (rule, response, agent).
SmApiResult	modifyHostConfig(SmHostConfig hostConfig) Modifies a Host Configuration object.
SmApiResult	modifyKeyManagement(SmKeyManagement keyManagement) Modifies an SmKeyManagement object.
SmApiResult	modifyODBCQuery(SmODBCQuery odbcQuery) Modifies an ODBC query.
SmApiResult	modifyPasswordPolicy(SmPasswordPolicy passwordPolicy) Modifies a password policy.
SmApiResult	modifyPolicy(SmPolicy policy) Modifies a policy.
SmApiResult	modifyPolicyLink(SmPolicyLink policyLink) Modifies a policy link.
SmApiResult	modifyRealm(SmRealm realm) Modifies a realm.
SmApiResult	modifyResponse(SmResponse response) Modifies a response.
SmApiResult	modifyResponseAttr(SmResponseAttr ResponseAttr) Sets a response attribute
SmApiResult	modifyRootConfig(SmRootConfig rootConfig) Modifies a root configuration.
SmApiResult	modifyRule(SmRule rule) Modifies a rule that is associated with the specified realm.
SmApiResult	modifyScheme(SmScheme scheme) Modifies an authentication scheme.
SmApiResult	modifySelfReg(SmSelfReg selfReg) Modifies a self-registration object.
SmApiResult	modifySharedSecretPolicy(SmSharedSecretPolicy sharedSecretPolicy) Modifies an SharedSecretPolicy object.
SmApiResult	modifyUserDirectory(SmUserDirectory userDir) Modifies a user directory.
SmApiResult	modifyVariable(SmVariable variable) Modifies a variable with the properties of the variable being passed.
SmApiResult	removeAdminFromDomain(java.lang.String adminName, java.lang.String domainName) Disassociates a user directory from a domain.
SmApiResult	removeFromGroup(int groupType, java.lang.String itemName, java.lang.String groupName, java.lang.String domainName) Removes a group member of any type (rule, response, agent) from the specified group.
SmApiResult	removeRegularExpressionFromPasswordPolicy(SmPwdPolicyRegularExpression regExpression) Removes the regular expression from password policy.
SmApiResult	removeUserDirFromDomain(java.lang.String userDirName, java.lang.String domainName) Disassociates a user directory from a domain.
SmApiResult	renameObject(SmObjId objId, java.lang.String newName) Renames an object.
SmApiResult	search(SmObject searchObj, java.lang.String[] searchProps, java.util.Vector searchResults) Searches the policy store for the specified object using the specified search criteria.
void	setApiSession(SmApiSession apiSession) Sets the API session object.
SmApiResult	setPasswordState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState passwordstate) This function sets the password state of the user which includes login failures, disabled time, last login time, empty password history, last password change and previous login time.
SmApiResult	setResponseInPolicyLink(SmPolicyLink policyLink) Changes the response for a particular policy link.
SmApiResult	setUserDirSearchOrder(java.lang.String domainName, java.util.Vector directoryNames) Sets the search order of user directories for a domain.
SmApiResult	setUserState(SmObjId userDirOid, java.lang.String userDn, SmUserPasswordState userstate) Sets the user state as enable/disable with the disabled reason for the state, if state is disabled.

Field Detail

SMPOLICYAPI_VERSION_20

static final int SMPOLICYAPI_VERSION_20

Client-supplied constant indicating that Policy Server operations should comply with version 2.0 of the Policy Server API.

See Also:

Constant Field Values

Method Detail

setApiSession

void setApiSession(SmApiSession apiSession)

Sets the API session object.

Parameters:

apiSession - SiteMinder API session object.

addRootConfig

SmApiResult addRootConfig(SmRootConfig rootConfig)
                          throws SmApiException

Creates a root configuration.

Parameters:

rootConfig - The root configuration to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyRootConfig

SmApiResult modifyRootConfig(SmRootConfig rootConfig)
                             throws SmApiException

Modifies a root configuration.

Parameters:

rootConfig - The root configuration to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteRootConfig

SmApiResult deleteRootConfig(SmObjId rootConfigId)
                             throws SmApiException

Deletes a root configuration.

Parameters:

rootConfigId - The object identifier of the root configuration to delete.

Returns:

The result of the request.

Throws:

SmApiException

getRootConfig

SmApiResult getRootConfig(SmObjId rootConfigId,
                          SmRootConfig rootConfig)
                          throws SmApiException

Gets the root configuration.

Parameters:

rootConfigId - The object identifier of the root configuration to retrieve.

rootConfig - This object will be populated with the properties of the root configuration.

Returns:

result of the request.

Throws:

SmApiException

addAgent

SmApiResult addAgent(SmAgent agent)
                     throws SmApiException

Creates an Agent object.

Parameters:

agent - The Agent object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyAgent

SmApiResult modifyAgent(SmAgent agent)
                        throws SmApiException

Modifies an Agent object.

Parameters:

agent - The Agent object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAgent

SmApiResult deleteAgent(java.lang.String agentName)
                        throws SmApiException

Deletes an Agent object.
Note: You cannot delete an Agent object if that Agent object is configured as a part of the resource information in a realm.

Parameters:

agent - The Agent object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAgent

SmApiResult getAgent(java.lang.String agentName,
                     SmAgent agent)
                     throws SmApiException

Gets the contents of an Agent object.

Parameters:

agentName - The Agent object name.

agent - An object that will be populated with the properties of the Agent object.

Returns:

The result of the request.

Throws:

SmApiException

addAgentType

SmApiResult addAgentType(SmAgentType agentType)
                         throws SmApiException

Creates an AgentType object.

Parameters:

agentType - The AgentType object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyAgentType

SmApiResult modifyAgentType(SmAgentType agentType)
                            throws SmApiException

Modifies an AgentType object.

Parameters:

agentType - The AgentType object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAgentType

SmApiResult deleteAgentType(java.lang.String szAgentTypeName)
                            throws SmApiException

Deletes an AgentType object.

Parameters:

szAgentTypeName - The AgentType object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAgentType

SmApiResult getAgentType(java.lang.String szAgentTypeName,
                         SmAgentType agenttype)
                         throws SmApiException

Gets the contents of an Agent Type object.

Parameters:

szAgentTypeName - The Agent Type object name.

agenttype - An object that will be populated with the properties of AgentType object.

Returns:

The result of the request.

Throws:

SmApiException

addAgentTypeAttr

SmApiResult addAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
                             throws SmApiException

Creates an AgentTypeAttr object.

Parameters:

agentTypeAttr - The AgentTypeAttr object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyAgentTypeAttr

SmApiResult modifyAgentTypeAttr(SmAgentTypeAttr agentTypeAttr)
                                throws SmApiException

Modifies an AgentTypeAttr object.

Parameters:

agentType - The AgentTypeAttr object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAgentTypeAttr

SmApiResult deleteAgentTypeAttr(java.lang.String szAgentTypeAttrName)
                                throws SmApiException

Deletes an AgentTypeAttr object.

Parameters:

szAgentTypeAttrName - Name of AgentTypeAttr object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAgentTypeAttr

SmApiResult getAgentTypeAttr(java.lang.String agentTypeAttrName,
                             SmAgentTypeAttr agenttypeattr)
                             throws SmApiException

Gets the contents of an Agent Type object.

Parameters:

agentTypeAttrName - The Agent Type object name.

agenttypeattr - An object that will be populated with the attributes of the Agent Type object.

Returns:

The result of the request.

Throws:

SmApiException

getAgentTypeAttrs

SmApiResult getAgentTypeAttrs(java.lang.String szAgentTypeName,
                              java.util.Vector agentTypeAttrs)
                              throws SmApiException

Gets the Oids of all AgentTypeAttr objects of the specified Agent Type

Parameters:

szAgentTypeName - Name of Agent Type whose Attributes are to be retrieved

agentTypeAttrs - Vector receiving Oids of Agent Type Attributes. attributes of the Agent Type object.

Returns:

The result of the request.

Throws:

SmApiException

getAdminDomains

SmApiResult getAdminDomains(java.lang.String szAdminName,
                            java.util.Vector adminDomains)
                            throws SmApiException

Gets the all UserDirectory which is added by Domain of the Administrator object

Parameters:

szAdminName - Name of Admin whose UserDirectory are to be retrived

adminDomains - Vector receving UserDirectory Admin Domain Attributes. attributes of the Admin object.

Returns:

The result of the request.

Throws:

SmApiException

addAgentConfig

SmApiResult addAgentConfig(SmAgentConfig agentConfig)
                           throws SmApiException

Creates an Agent Configuration object.

Parameters:

agentConfig - The Agent Configuration object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyAgentConfig

SmApiResult modifyAgentConfig(SmAgentConfig agentConfig)
                              throws SmApiException

Modifies an Agent Configuration object.

Parameters:

agentConfig - The Agent Configuration object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAgentConfig

SmApiResult deleteAgentConfig(java.lang.String agentConfigName)
                              throws SmApiException

Deletes an Agent Configuration object.

Parameters:

agentConfigName - The Agent Configuration object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAgentConfig

SmApiResult getAgentConfig(java.lang.String agentConfigName,
                           SmAgentConfig agentConfig)
                           throws SmApiException

Gets the contents of an Agent Configuration object.

Parameters:

agentConfigName - The Agent Configuration object name.

agentConfig - An object that will be populated with the properties of the Agent Configuration object.

Returns:

The result of the request.

Throws:

SmApiException

addHostConfig

SmApiResult addHostConfig(SmHostConfig hostConfig)
                          throws SmApiException

Creates a Host Configuration object.

Parameters:

hostConfig - The Host Configuration object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyHostConfig

SmApiResult modifyHostConfig(SmHostConfig hostConfig)
                             throws SmApiException

Modifies a Host Configuration object.

Parameters:

hostConfig - The Host Configuration object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteHostConfig

SmApiResult deleteHostConfig(java.lang.String hostConfigName)
                             throws SmApiException

Deletes a Host Configuration object.

Parameters:

hostConfigName - The Host Configuration object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getHostConfig

SmApiResult getHostConfig(java.lang.String hostConfigName,
                          SmHostConfig hostConfig)
                          throws SmApiException

Gets the contents of a Host Configuration object.

Parameters:

hostConfigName - The Host Configuration object name.

hostConfig - An object that will be populated with the properties of the Host Configuration object.

Returns:

The result of the request.

Throws:

SmApiException

addTrustedHost

SmApiResult addTrustedHost(SmTrustedHost trustedHost)
                           throws SmApiException,
                                  java.io.IOException,
                                  java.lang.InterruptedException

Registers a trusted host with the Policy Server. Use this function to register the client as trusted host. After registration is complete, the registration tool creates the SmHost.conf file on the client and a corresponding Trusted Host object on the Policy Server.

Parameters:

trustedHost - The Trusted Host object to create.

Returns:

The result of the request.

Throws:

SmApiException

java.io.IOException

java.lang.InterruptedException

deleteTrustedHost

SmApiResult deleteTrustedHost(java.lang.String trustedHostName)
                              throws SmApiException

Deletes a Trusted Host object.

Parameters:

trustedHostName - The Trusted Host object to delete.

Returns:

The result of the request.

Throws:

SmApiException

addDomain

SmApiResult addDomain(SmDomain domain)
                      throws SmApiException

Creates a domain.

Parameters:

domain - The domain to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyDomain

SmApiResult modifyDomain(SmDomain domain)
                         throws SmApiException

Modifies a domain.

Parameters:

domain - The domain to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteDomain

SmApiResult deleteDomain(java.lang.String domainName)
                         throws SmApiException

Deletes a domain.
Note: Also deletes the domain's children (rules, responses, realms, policies).

Parameters:

domainName - The domain to delete.

Returns:

The result of the request.

Throws:

SmApiException

getDomain

SmApiResult getDomain(java.lang.String domainName,
                      SmDomain domain)
                      throws SmApiException

Gets the contents of a domain object.

Parameters:

domainName - The name of the domain.

domain - This object will be populated with the properties of the domain.

Returns:

The result of the request.

Throws:

SmApiException

addODBCQuery

SmApiResult addODBCQuery(SmODBCQuery odbcQuery)
                         throws SmApiException

Adds an ODBC query.

Parameters:

odbcQuery - The ODBC query object to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyODBCQuery

SmApiResult modifyODBCQuery(SmODBCQuery odbcQuery)
                            throws SmApiException

Modifies an ODBC query.

Parameters:

odbcQuery - The ODBC query object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteODBCQuery

SmApiResult deleteODBCQuery(java.lang.String odbcQueryName)
                            throws SmApiException

Deletes an ODBC query.

Parameters:

odbcQueryName - The ODBC query object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getODBCQuery

SmApiResult getODBCQuery(java.lang.String odbcQueryName,
                         SmODBCQuery odbcQuery)
                         throws SmApiException

Gets the contents of an ODBC query.

Parameters:

odbcQueryName - Name of the ODBC query object to retrieve.

odbcQuery - This object will be populated with the properties of the ODBC query.

Returns:

The result of the request.

Throws:

SmApiException

addUserDirectory

SmApiResult addUserDirectory(SmUserDirectory userDir)
                             throws SmApiException

Adds a user directory.

Parameters:

userDir - The SiteMinder user directory to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyUserDirectory

SmApiResult modifyUserDirectory(SmUserDirectory userDir)
                                throws SmApiException

Modifies a user directory.

Parameters:

userDir - The SiteMinder user directory to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteUserDirectory

SmApiResult deleteUserDirectory(java.lang.String userDirName)
                                throws SmApiException

Deletes a user directory.
Note: This method also removes directory users from policies.

Parameters:

userDirName - The user directory to delete.

Returns:

The result of the request.

Throws:

SmApiException

getUserDirectory

SmApiResult getUserDirectory(java.lang.String userDirName,
                             SmUserDirectory userDir)
                             throws SmApiException

Gets the contents of a user directory.

Parameters:

userDirName - The user directory to retrieve.

userDir - This object will be populated with the properties of the user directory.

Returns:

The result of the request.

Throws:

SmApiException

addUserDirToDomain

SmApiResult addUserDirToDomain(java.lang.String userDirName,
                               java.lang.String domainName)
                               throws SmApiException

Associates a user directory with a domain.

Parameters:

userDirName - The user directory to associate with a domain.

domainName - The domain to associate with the user directory.

Returns:

The result of the request.

Throws:

SmApiException

removeUserDirFromDomain

SmApiResult removeUserDirFromDomain(java.lang.String userDirName,
                                    java.lang.String domainName)
                                    throws SmApiException

Disassociates a user directory from a domain.

Parameters:

userDirName - The user directory to disassociate from the domain.

domainName - The domain to disassociate from the user directory.

Returns:

The result of the request.

Throws:

SmApiException

getUserDirSearchOrder

SmApiResult getUserDirSearchOrder(java.lang.String domainName,
                                  java.util.Vector directoryNames)
                                  throws SmApiException

Retrieves the search order of user directories for a domain.

Parameters:

domainName - The domain being searched.

directoryNames - This Vector will be populated with the list of user directory names. The order of search is determined by the element position of the Vector.

Returns:

The result of the request.

Throws:

SmApiException

setUserDirSearchOrder

SmApiResult setUserDirSearchOrder(java.lang.String domainName,
                                  java.util.Vector directoryNames)
                                  throws SmApiException

Sets the search order of user directories for a domain.

Parameters:

domainName - The domain being searched.

directoryNames - The list of user directory names. The order of search is determined by the element position of the Vector.

Returns:

The result of the request.

Throws:

SmApiException

getDirectoryContents

SmApiResult getDirectoryContents(java.lang.String userDirName,
                                 java.util.Hashtable enumerateResult)
                                 throws SmApiException

Enumerates a user directory.

Parameters:

userDirName - The user directory to enumerate.

enumerateResult - The list of distinguished names (DN) and classes in the directory. The Hashtable key will hold the DN, and the corresponding value will hold the class.

Returns:

The result of the request.

Throws:

SmApiException

lookupDirectory

SmApiResult lookupDirectory(java.lang.String userDirName,
                            java.lang.String searchPattern,
                            java.util.Hashtable lookupResult)
                            throws SmApiException

Performs a user directory lookup.

The value of the searchPattern parameter is determined by the directory namespace:

• LDAP namespaces
  
  The search in an LDAP user directory can be based on an attribute-value pair or on an LDAP search expression. For an attribute-value pair, the format of searchPattern is:
  
  attribute-name=value
  
  For example if attribute-name is disabled and value is 0, the LDAP search filter is:
  
  Base:'o=airius.com',
  Filter: '(&(|(objectclass=organizationalPerson)(objectclass=inetOrgPerson)(objectclass=organization)(objectclass=organizationalUnit)(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=group))(disabled=0))'
  
  If the search uses an LDAP search expression, searchPattern will hold the LDAP search expression. For example, if the search expression is 'uid=user1111', the LDAP search filter is:
  
  Base:'o=airius.com',
  Filter: '(&(|(objectclass=organizationalPerson)(objectclass=inetOrgPerson)(objectclass=organization)(objectclass=organizationalUnit)(objectclass=groupOfNames)(objectclass=groupOfUniqueNames)(objectclass=group))(uid=user1111))'

• ODBC, WinNT, and Custom namespaces
  
  You can search in an ODBC user directory for users, groups, or both. The search is based on attribute-value pairs. The format of searchPattern is:
  
  [ class= ] value
  
  In the format example:
  • class is an empty-string or user or group. An empty-string implies user and group.
  • value is a wildcard string.

Parameters:

userDirName - The user directory to search.

searchPattern - The search pattern.

enumerateResult - The list of distinguished names (DN) and classes in the directory. The Hashtable key will hold the DN, and the corresponding value will hold the class.

Returns:

The result of the request.

Throws:

SmApiException

getUserGroups

SmApiResult getUserGroups(SmObjId dirOid,
                          java.lang.String userDn,
                          boolean recursive,
                          java.util.Vector groups)
                          throws SmApiException

Returns a list of groups that a user is a member of.

Parameters:

dirOid - The user's directory OID.

userDn - The user's distinguished name.

recursive - Specifies whether to search for groups recursively.

groups - Output parameter for returned groups.

Returns:

The result of the request.

Throws:

SmApiException

getUserContext

SmApiResult getUserContext(SmObjId dirOid,
                           java.lang.String userDn,
                           java.lang.String sessionId,
                           SmUserContext userContext)
                           throws SmApiException

Returns contextual information of a given user.

Parameters:

dirOid - The user's directory OID.

userDn - The user's distinguished name.

sessionId - The A unique identifier of the session. After a successful login, the session ID can be extracted from the spec member of the SessionDef class instance. If the session ID is not known, assign null to this parameter.

userContext - The user's context SmUserContext

Returns:

The result of the request.

Throws:

SmApiException

addAdmin

SmApiResult addAdmin(SmAdmin admin)
                     throws SmApiException

Creates a SiteMinder Administrator.

Parameters:

admin - The SiteMinder Administrator to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyAdmin

SmApiResult modifyAdmin(SmAdmin admin)
                        throws SmApiException

Modifies a SiteMinder Administrator.

Parameters:

admin - The SiteMinder Administrator to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAdmin

SmApiResult deleteAdmin(java.lang.String adminName)
                        throws SmApiException

Deletes a SiteMinder Administrator.

Parameters:

adminName - The SiteMinder Administrator to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAdmin

SmApiResult getAdmin(java.lang.String adminName,
                     SmAdmin admin)
                     throws SmApiException

Gets the contents of a SiteMinder Administrator.

Parameters:

adminName - The SiteMinder Administrator to retrieve.

admin - This object will be populated with the properties of the SiteMinder Administrator.

Returns:

The result of the request.

Throws:

SmApiException

addAdminToDomain

SmApiResult addAdminToDomain(java.lang.String adminName,
                             java.lang.String domainName)
                             throws SmApiException

Associates a SiteMinder Administrator with a domain.

Parameters:

adminName - The SiteMinder Administrator to associate with a domain.

domainName - The domain to associate with the SiteMinder Administrator.

Returns:

The result of the request.

Throws:

SmApiException

removeAdminFromDomain

SmApiResult removeAdminFromDomain(java.lang.String adminName,
                                  java.lang.String domainName)
                                  throws SmApiException

Disassociates a user directory from a domain.

Parameters:

adminName - The SiteMinder Administrator to disassociate from the domain.

domainName - The domain to disassociate from the SiteMinder Administrator.

Returns:

The result of the request.

Throws:

SmApiException

getAdminUserDirs

SmApiResult getAdminUserDirs(java.lang.String adminName,
                             java.util.Vector userDirs)
                             throws SmApiException

Gets a list of user directories that an administrator can manage.

Parameters:

adminName - Distinguished name of the administrator.

userDirs - This Vector will be populated with the list of user directory names (String).

Throws:

SmApiException

addScheme

SmApiResult addScheme(SmScheme scheme)
                      throws SmApiException

Creates an authentication scheme.

Parameters:

scheme - The authentication scheme to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyScheme

SmApiResult modifyScheme(SmScheme scheme)
                         throws SmApiException

Modifies an authentication scheme.

Parameters:

scheme - The authentication scheme to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteScheme

SmApiResult deleteScheme(java.lang.String schemeName)
                         throws SmApiException

Deletes an authentication scheme.

Parameters:

schemeName - The authentication scheme to delete.

Returns:

The result of the request.

Throws:

SmApiException

getScheme

SmApiResult getScheme(java.lang.String schemeName,
                      SmScheme scheme)
                      throws SmApiException

Gets the contents of an authentication scheme.

Parameters:

schemeName - The authentication scheme to retrieve.

scheme - This object will be populated with the properties of the authentication scheme.

Returns:

The result of the request.

Throws:

SmApiException

addPasswordPolicy

SmApiResult addPasswordPolicy(SmPasswordPolicy passwordPolicy)
                              throws SmApiException

Creates a password policy.

Parameters:

domain - The password policy to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyPasswordPolicy

SmApiResult modifyPasswordPolicy(SmPasswordPolicy passwordPolicy)
                                 throws SmApiException

Modifies a password policy.

Parameters:

passwordPolicy - The password policy to modify.

Returns:

The result of the request.

Throws:

SmApiException

deletePasswordPolicy

SmApiResult deletePasswordPolicy(java.lang.String passwordPolicy)
                                 throws SmApiException

Deletes a password policy.

Parameters:

passwordPolicy - The password policy to delete.

Returns:

The result of the request.

Throws:

SmApiException

getPasswordPolicy

SmApiResult getPasswordPolicy(java.lang.String passwordPolicyName,
                              SmPasswordPolicy passwordPolicy)
                              throws SmApiException

Gets the contents of a password policy.

Parameters:

passwordPolicyName - The password policy to retrieve.

passwordPolicy - This object will be populated with the properties of the password policy.

Returns:

The result of the request.

Throws:

SmApiException

addRegularExpressionToPasswordPolicy

SmApiResult addRegularExpressionToPasswordPolicy(SmPwdPolicyRegularExpression regularExpression)
                                                 throws SmApiException

Adds the regular expression to password policy.

Parameters:

regExpression - The regular expression object to add

Returns:

The result of the request

Throws:

SmApiException

removeRegularExpressionFromPasswordPolicy

SmApiResult removeRegularExpressionFromPasswordPolicy(SmPwdPolicyRegularExpression regExpression)
                                                      throws SmApiException

Removes the regular expression from password policy.

Parameters:

regExpression - The regular expression object to remove

Returns:

The result of the request.

Throws:

SmApiException

getRegularExpressions

SmApiResult getRegularExpressions(java.lang.String passwordPolicyName,
                                  java.util.Vector regExpressions)
                                  throws SmApiException

Gets the list of regular expression for a password policy object.

Parameters:

passwordPolicyName - The password policy whose regular expressions are retrieved.

regExpressions - This vector will be populated with the list of regular expressions.

Returns:

The result of the request.

Throws:

SmApiException

getUserState

SmApiResult getUserState(SmObjId userDirOid,
                         java.lang.String userDn,
                         SmUserPasswordState userstate)
                         throws SmApiException

Gets the user state as enable/disable with the disabled reason for the disabled state, if disabled.

Parameters:

userDirOid - User Directory object identifier

userDn - User Distiniguished name

userstate - This object will be populated with User state.

Returns:

The result of the request.

Throws:

SmApiException

setUserState

SmApiResult setUserState(SmObjId userDirOid,
                         java.lang.String userDn,
                         SmUserPasswordState userstate)
                         throws SmApiException

Sets the user state as enable/disable with the disabled reason for the state, if state is disabled.

Parameters:

userDirOid - User Directory object identfier.

userDn - User Distinguished name.

userstate - This object sets the user state using its property.

Returns:

The result of the request.

Throws:

SmApiException

getPasswordState

SmApiResult getPasswordState(SmObjId userDirOid,
                             java.lang.String userDn,
                             SmUserPasswordState passwordstate)
                             throws SmApiException

Gets the password state of the user which includes login failures, disabled time, last login time, last password change and previous login time.

Parameters:

userDirOid - User directory object identifier.

userDn - User distinguished name

passwordstate - The object that will be poulated with the password state.

Returns:

The result of the request.

Throws:

SmApiException

setPasswordState

SmApiResult setPasswordState(SmObjId userDirOid,
                             java.lang.String userDn,
                             SmUserPasswordState passwordstate)
                             throws SmApiException

This function sets the password state of the user which includes login failures, disabled time, last login time, empty password history, last password change and previous login time.

Parameters:

userDirOid - User directory object identifier.

userDn - User distinguished name.

passwordstate - This object sets the password state using its properties.

Returns:

The result of the request.

Throws:

SmApiException

addSelfReg

SmApiResult addSelfReg(SmSelfReg selfReg)
                       throws SmApiException

Creates a self-registration object.

Parameters:

selfReg - The self-registration object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifySelfReg

SmApiResult modifySelfReg(SmSelfReg selfReg)
                          throws SmApiException

Modifies a self-registration object.

Parameters:

selfReg - The self-registration object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteSelfReg

SmApiResult deleteSelfReg(java.lang.String selfRegName)
                          throws SmApiException

Deletes a self-registration object.

Parameters:

selfReg - The self-registration object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getSelfReg

SmApiResult getSelfReg(java.lang.String selfRegName,
                       SmSelfReg selfReg)
                       throws SmApiException

Gets the contents of a self-registration object.

Parameters:

selfRegName - The self-registration object to retrieve.

selfReg - This object will be populated with the properties of the self-registration object.

Returns:

The result of the request.

Throws:

SmApiException

addAuthAzMap

SmApiResult addAuthAzMap(SmAuthAzMap authAzMap)
                         throws SmApiException

Adds an authentication and authorization directory mapping object.

Parameters:

authAzMap - The authentication and authorization mapping object to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyAuthAzMap

SmApiResult modifyAuthAzMap(SmAuthAzMap authAzMap)
                            throws SmApiException

Modifies an authentication and authorization directory mapping object.

Parameters:

authAzMap - The authentication and authorization mapping object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAuthAzMap

SmApiResult deleteAuthAzMap(SmObjId authAzMapId)
                            throws SmApiException

Deletes an authentication and authorization directory mapping object.

Parameters:

authAzMapId - Object identifier of the authentication and authorization mapping object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAuthAzMap

SmApiResult getAuthAzMap(SmObjId authAzMapId,
                         SmAuthAzMap authAzMap)
                         throws SmApiException

Gets the contents of an authentication and authorization directory mapping object.

Parameters:

authAzMapId - The object identifier of the authentication and authorization mapping object to retreive.

authAzMap - This object will be populated with the properties of the authentication and authorization mapping object.

Returns:

The result of the request.

Throws:

SmApiException

addCertMap

SmApiResult addCertMap(SmCertMap certMap)
                       throws SmApiException

Adds a certificate mapping object.

Parameters:

certMap - The certificate mapping object to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyCertMap

SmApiResult modifyCertMap(SmCertMap certMap)
                          throws SmApiException

Modifies a certificate mapping object.

Parameters:

certMap - The certificate mapping object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteCertMap

SmApiResult deleteCertMap(SmObjId certMapId)
                          throws SmApiException

Deletes a certificate mapping object.

Parameters:

certMapId - The object identifier of the certificate mapping object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getCertMap

SmApiResult getCertMap(SmObjId certMapId,
                       SmCertMap certMap)
                       throws SmApiException

Gets the properties of a certificate mapping object.

Parameters:

certMapId - The object identifier of the certificate mapping object to retrieve.

certMap - This object will be populated with the properties of the certificate mapping object.

Returns:

The result of the request.

Throws:

SmApiException

addRealm

SmApiResult addRealm(SmRealm realm)
                     throws SmApiException

Adds a realm and associates it with a domain.

Parameters:

realm - The realm to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyRealm

SmApiResult modifyRealm(SmRealm realm)
                        throws SmApiException

Modifies a realm.

Parameters:

realm - The realm to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteRealm

SmApiResult deleteRealm(SmRealm realm)
                        throws SmApiException

Deletes a realm.
Note: You cannot delete a realm if any existing rules are linked to it.

Parameters:

realm - The realm to delete.

Returns:

The result of the request.

Throws:

SmApiException

getRealm

SmApiResult getRealm(java.lang.String realmName,
                     java.lang.String domainName,
                     SmRealm realm)
                     throws SmApiException

Gets the contents of a realm.

Parameters:

domainName - The domain where the realm is located.

realmName - The realm name or object identifier.

realm - This object will be populated with the properties of the realm.

Returns:

The result of the request.

Throws:

SmApiException

getRealmRules

SmApiResult getRealmRules(java.lang.String realmName,
                          java.lang.String domainName,
                          java.util.Vector Rules)
                          throws SmApiException

Returns all of the rules for the specified realm and domain.

Parameters:

domainName - The domain where the realm is located.

realmName - The realm name or object identifier.

rules - This object will be populated with the list of SmRule objects.

Returns:

The result of the request.

Throws:

SmApiException

getRealmRealms

SmApiResult getRealmRealms(java.lang.String realmName,
                           java.lang.String domainName,
                           java.util.Vector Realms)
                           throws SmApiException

Returns all of the realms for the specified realm and domain.

Parameters:

domainName - The domain where the realm is located.

realmName - The realm name or object identifier.

realms - This object will be populated with the list of realm objects.

Returns:

The result of the request.

Throws:

SmApiException

addRule

SmApiResult addRule(SmRule rule)
                    throws SmApiException

Adds a rule and associates it with the specified realm.

Parameters:

rule - The rule and its properties that are being added.

Returns:

The result of the request.

Throws:

SmApiException

addRule

SmApiResult addRule(SmRule Rule,
                    boolean bIsGlobal)
                    throws SmApiException

Adds a global rule if the boolean passed is true.

Parameters:

rule - The rule and its properties that are being added.

bIsGlobal - If bIsGlobal is true, a global rule is created If bIsGlobal is false, a domain rule is created

Returns:

The result of the request.

Throws:

SmApiException

modifyRule

SmApiResult modifyRule(SmRule rule)
                       throws SmApiException

Modifies a rule that is associated with the specified realm.

Parameters:

rule - The rule and its properties that are being modified.

Returns:

The result of the request.

Throws:

SmApiException

deleteRule

SmApiResult deleteRule(SmRule rule)
                       throws SmApiException

Deletes a rule that is associated with the specified realm.

Parameters:

rule - The rule to delete.

Throws:

SmApiException

getRule

SmApiResult getRule(java.lang.String ruleName,
                    java.lang.String realmOid,
                    java.lang.String domainName,
                    SmRule rule)
                    throws SmApiException

Gets the contents of a rule that is associated with the specified realm.

Parameters:

ruleName - Name of the rule whose properties are being retrieved.

domainName - Name of the domain where the rule is located.

realmOid - Object indentifier of the realm that is associated with the rule.

rule - This object will be populated with the properties of the rule.

Returns:

The result of the request.

Throws:

SmApiException

addResponse

SmApiResult addResponse(SmResponse response)
                        throws SmApiException

Creates a response and associates it with a domain.

Parameters:

response - The response object to add.

Returns:

The result of the request.

Throws:

SmApiException

addResponse

SmApiResult addResponse(SmResponse response,
                        boolean bIsGlobal)
                        throws SmApiException

Creates a global response if bIsGlobal is true

Parameters:

response - The response object to add.

bIsGlobal - If bIsGlobal is true, a global response is created. If bIsGlobal is false, a domain rule is created.

Returns:

The result of the request.

Throws:

SmApiException

modifyResponse

SmApiResult modifyResponse(SmResponse response)
                           throws SmApiException

Modifies a response.

Parameters:

response - The response object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteResponse

SmApiResult deleteResponse(SmResponse response)
                           throws SmApiException

Deletes a response.
Note: This method deletes any related response attributes.

Parameters:

response - The response to delete.

Returns:

The result of the request.

Throws:

SmApiException

getResponse

SmApiResult getResponse(java.lang.String responseName,
                        java.lang.String domainName,
                        SmResponse response)
                        throws SmApiException

Gets the contents of a response.

Parameters:

domainName - The domain where response is located.

responseName - The response to retrieve.

response - This object will be populated with the properties of the resopnse.

Returns:

The result of the request.

Throws:

SmApiException

addResponseAttr

SmApiResult addResponseAttr(SmResponseAttr responseAttr)
                            throws SmApiException

Creates a response attribute and associates it with a response.

Parameters:

responseAttr - The response attribute object to create.

Returns:

The result of the request.

Throws:

SmApiException

addResponseAttr

SmApiResult addResponseAttr(SmResponseAttr responseAttr,
                            boolean bIsGlobal)
                            throws SmApiException

Creates a global response attribute if bIsGlobal is true

Parameters:

responseAttr - The response attribute object to create.

bIsGlobal - If bIsGlobal is true, a global ResponseAttr is created If bIsGlobal is false, a domain ResponseAttr is created

Returns:

The result of the request.

Throws:

SmApiException

deleteResponseAttr

SmApiResult deleteResponseAttr(SmObjId responseAttrOid,
                               java.lang.String domainName)
                               throws SmApiException

Deletes a response attribute.

Parameters:

domainName - The domain where the response attribute is located.

responseAttrOid - The object identifier of the response attribute to delete.

Returns:

The result of the request.

Throws:

SmApiException

getResponseAttrs

SmApiResult getResponseAttrs(java.lang.String responseName,
                             java.lang.String domainName,
                             java.util.Vector responseAttrs)
                             throws SmApiException

Gets a list of response attributes that belong to a response.

Parameters:

domainName - Name of the domain where the response is located.

responseName - The response whose atributes are being retrieved.

responseAttrs - This Vector will be populated with the list of response attributes (SmResponseAttr).

Returns:

The result of the request.

Throws:

SmApiException

getResponseAttrs

SmApiResult getResponseAttrs(java.lang.String responseName,
                             java.lang.String domainName,
                             java.util.Map responseAttrs)
                             throws SmApiException

Gets a list of response attributes.

Parameters:

responseName - The response whose atributes are being retrieved.

responseAttrs - This Map will be populated with the list of response attributes OIDs and values (SmResponseAttr).

Returns:

The result of the request.

Throws:

SmApiException

modifyResponseAttr

SmApiResult modifyResponseAttr(SmResponseAttr ResponseAttr)
                               throws SmApiException

Sets a response attribute

Parameters:

responseAttr - The response attribute and its properties that are being modified.

Returns:

The result of the request.

Throws:

SmApiException

addPolicy

SmApiResult addPolicy(SmPolicy policy)
                      throws SmApiException

Adds a policy .

Parameters:

policy - The policy and its properties that are being added.

Returns:

The result of the request.

Throws:

SmApiException

addPolicy

SmApiResult addPolicy(SmPolicy policy,
                      boolean bIsGlobal)
                      throws SmApiException

Adds a policy object.

Parameters:

policy - The policy and its properties that are being added.

bIsGlobal - If bIsGlobal is true, a global policy is created If bIsGlobal is false, a domain policy is created

Returns:

The result of the request.

Throws:

SmApiException

modifyPolicy

SmApiResult modifyPolicy(SmPolicy policy)
                         throws SmApiException

Modifies a policy.

Parameters:

policy - The policy and its properties that are being modified.

Returns:

The result of the request.

Throws:

SmApiException

deletePolicy

SmApiResult deletePolicy(SmPolicy policy)
                         throws SmApiException

Deletes a policy.
Note: This method deletes all related policy links and user policies.

Parameters:

policy - The policy to delete.

Returns:

The result of the request.

Throws:

SmApiException

getPolicy

SmApiResult getPolicy(java.lang.String policyName,
                      java.lang.String domainName,
                      SmPolicy policy)
                      throws SmApiException

Gets the contents of a policy.

Parameters:

policyName - The policy whose properties are being retrieved.

domainName - The domain where the policy is located.

policy - This object will be populated with the properties of the policy.

Returns:

The result of the request.

Throws:

SmApiException

addVariable

SmApiResult addVariable(SmVariable variable)
                        throws SmApiException

Adds a variable .

Parameters:

variable - The variable and its properties that are being added.

Returns:

The result of the request.

Throws:

SmApiException

getVariable

SmApiResult getVariable(java.lang.String szVariableName,
                        java.lang.String szDomainName,
                        SmVariable variable)
                        throws SmApiException

Gets the contents of a Variable.

Parameters:

VariableName - The variable whose properties are being retrieved.

domainName - The domain where the variable is located.

variable - This object will be populated with the properties of the variable.

Returns:

The result of the request.

Throws:

SmApiException

getDomainVariables

SmApiResult getDomainVariables(java.lang.String szDomainName,
                               java.util.Vector variables)
                               throws SmApiException

Gets the List of the variables present in a domain.

Parameters:

szDomainName - The name of the domain

variables - The vector which will be populated by the object variables

Returns:

The result of the request.

Throws:

SmApiException

modifyVariable

SmApiResult modifyVariable(SmVariable variable)
                           throws SmApiException

Modifies a variable with the properties of the variable being passed.

Parameters:

variable - The variable and its properties that are being modified.

Returns:

The result of the request.

Throws:

SmApiException

deleteVariable

SmApiResult deleteVariable(SmVariable variable)
                           throws SmApiException

Deletes a Variable.

Parameters:

variable - The variable to delete.

Returns:

The result of the request.

Throws:

SmApiException

getVariableType

SmApiResult getVariableType(java.lang.String szVariableType,
                            SmVariableType variableType)
                            throws SmApiException

Gets the contents of a VariableType.

Parameters:

szVariableType - The VariableType whose properties are being retrieved.

variableType - This object will be populated with the properties of the variableType.

Returns:

The result of the request.

Throws:

SmApiException

addPolicyLink

SmApiResult addPolicyLink(SmPolicyLink policyLink)
                          throws SmApiException

Adds a policy link to a policy.

Parameters:

policyLink - The policy link object to add to the policy.

Returns:

The result of the request.

Throws:

SmApiException

addPolicyLink

SmApiResult addPolicyLink(SmPolicyLink policyLink,
                          boolean bIsGlobal)
                          throws SmApiException

Adds a global PolicyLink if the boolean passed is true.

Parameters:

policyLink - The policyLink and its properties that are being added.

bIsGlobal - If bIsGlobal is true, a global policyLink is created If bIsGlobal is false, a domain policyLink is created

Returns:

The result of the request.

Throws:

SmApiException

modifyPolicyLink

SmApiResult modifyPolicyLink(SmPolicyLink policyLink)
                             throws SmApiException

Modifies a policy link.

Parameters:

policyLink - The policy link object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deletePolicyLink

SmApiResult deletePolicyLink(SmObjId policyLinkOid,
                             java.lang.String domainName)
                             throws SmApiException

Deletes a policy link.

Parameters:

policyLinkOid - Object identifier of the policy link to delete.

domainName - The domain where the policy link is located.

Returns:

The result of the request.

Throws:

SmApiException

getPolicyLinks

SmApiResult getPolicyLinks(java.lang.String policyName,
                           java.lang.String domainName,
                           java.util.Vector policyLinks)
                           throws SmApiException

Returns all policy links for the specified policy and domain.

Parameters:

policyName - The policy where the policy links are located.

domainName - The domain where the policy links are located.

policyLinks - This Vector will be populated with SmPolicyLink objects.

Returns:

The result of the request.

Throws:

SmApiException

setResponseInPolicyLink

SmApiResult setResponseInPolicyLink(SmPolicyLink policyLink)
                                    throws SmApiException

Changes the response for a particular policy link.

Parameters:

policyLink - The policy link object containing the response being changed.

Returns:

The result of the request.

Throws:

SmApiException

addUserPolicy

SmApiResult addUserPolicy(SmUserPolicy userPolicy)
                          throws SmApiException

Adds a user policy to a policy.

Parameters:

userPolicy - The user policy object to add.

Returns:

The result of the request.

Throws:

SmApiException

deleteUserPolicy

SmApiResult deleteUserPolicy(SmObjId UserPolicyOid,
                             java.lang.String domainName)
                             throws SmApiException

Deletes a user policy under a given domain.

Parameters:

userPolicy - The user policy object to delete.

domainName - The domain that contains the user policy to delete.

Returns:

The result of the request.

Throws:

SmApiException

getUserPolicies

SmApiResult getUserPolicies(java.lang.String policyName,
                            java.lang.String domainName,
                            java.util.Vector UserPolicies)
                            throws SmApiException

Gets all user policies for a given policy.

Parameters:

policyName - The policy where the user policies are located.

domainName - The domain where the user policy are located.

userPolicies - This Vector will be populated with the retrieved user policy objects (SmUserPolicy).

Returns:

The result of the request.

Throws:

SmApiException

getRealmUserPolicies

SmApiResult getRealmUserPolicies(java.lang.String realmOID,
                                 java.util.Vector userPolicyOIDs)
                                 throws SmApiException

Gets a list of user policies that can access a realm.

Parameters:

realmOID - Object identifier of the realm.

userPolicyOIDs - This Vector of Strings will be populated with the list of user policy object identifiers that a user can access.

Returns:

The result of the request.

Throws:

SmApiException

addGroup

SmApiResult addGroup(java.lang.String domainName,
                     SmObject group)
                     throws SmApiException

Creates a new group of any type (rule, response, agent).

Parameters:

domainName - The domain that contains the group to create. For agent groups, this parameter will be empty.

group - The group object to create.

Returns:

The result of the request.

Throws:

SmApiException

modifyGroup

SmApiResult modifyGroup(java.lang.String domainName,
                        SmObject group)
                        throws SmApiException

Modifies a group of any type (rule, response, agent).

Parameters:

domainName - The domain that contains the group to create. For agent groups, this parameter will be empty.

group - The group object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteGroup

SmApiResult deleteGroup(int groupType,
                        java.lang.String groupName,
                        java.lang.String domainName)
                        throws SmApiException

Deletes a group of any type (rule, response, agent).

Parameters:

groupType - The type of the group to delete.

domainName - The domain where the group is located. For agent groups, this name will be empty.

groupName - Name of the group to delete.

Returns:

The result of the request.

Throws:

SmApiException

getGroup

SmApiResult getGroup(java.lang.String groupName,
                     java.lang.String domainName,
                     SmObject group)
                     throws SmApiException

Gets the contents of a group of any type (rule, response, agent).

Parameters:

domainName - The domain where the group is located. For agent groups, this name will be empty.

groupName - Name of the group to retrieve.

group - This object will be populated with the properties of the group object.

Returns:

The result of the request.

Throws:

SmApiException

getGroupMembers

SmApiResult getGroupMembers(int groupType,
                            java.lang.String groupName,
                            java.lang.String domainName,
                            java.util.Vector names)
                            throws SmApiException

Gets a list of groups of any type (rule, response, and agent).

Parameters:

groupType - One of the group types specified in SmGroup.

groupName - The group to retrieve.

domainName - The domain where the group is located. For agent groups, this name will be empty.

names - This Vector will be populated with the list of group members.

Returns:

The result of the request.

Throws:

SmApiException

addToGroup

SmApiResult addToGroup(int groupType,
                       java.lang.String itemName,
                       java.lang.String groupName,
                       java.lang.String domainName)
                       throws SmApiException

Adds a group member of any type (rule, response, agent) to the specified group.

Parameters:

groupType - One of the group types specified in SmGroup.

itemName - The member to add to the group. The member being added must be of the same type as the group.

groupName - The group to contain the new member.

domainName - The domain where the group is located. For agent groups, this name will be empty.

Returns:

The result of the request.

Throws:

SmApiException

removeFromGroup

SmApiResult removeFromGroup(int groupType,
                            java.lang.String itemName,
                            java.lang.String groupName,
                            java.lang.String domainName)
                            throws SmApiException

Removes a group member of any type (rule, response, agent) from the specified group.

Parameters:

groupType - One of the group types specified in SmGroup.

itemName - The member to be removed from the group.

groupName - The group where the item is currently a member.

domainName - The domain where the group is located. For agent groups, this name will be empty.

Returns:

The result of the request.

Throws:

SmApiException

search

SmApiResult search(SmObject searchObj,
                   java.lang.String[] searchProps,
                   java.util.Vector searchResults)
                   throws SmApiException

Searches the policy store for the specified object using the specified search criteria.

Parameters:

searchObj - The object to search for.

searchProps - One or more search criteria. Valid search criteria values are constants that:

• Begin with Prop and that are defined in the class of the object you are searching for.
  
  
• Are documented as being searchable properties.

For example, you can use PropPolicy to search for SmUserPolicy objects, and PropIpAddr to search for SmAgent objects.

searchResults - This Vector will be populated with the search results.

Returns:

An SmApiResult object for the search.

Throws:

SmApiException

getObject

SmApiResult getObject(java.lang.String objName,
                      SmObject obj)
                      throws SmApiException

Gets a global object by name or object identifier (OID).

Parameters:

objName - Name or object identifier of the SiteMinder global object.

obj - This object will be populated with the retrieved object.

Returns:

The result of the request.

Throws:

SmApiException

getDomainObject

SmApiResult getDomainObject(java.lang.String objName,
                            java.lang.String domainName,
                            SmDomainObject obj)
                            throws SmApiException

Gets a domain object by name or object identifier (OID).

Parameters:

domainName - Name or object identifier of the SiteMinder domain object.

obj - This object will be populated with the retrieved object.

Returns:

The result of the request.

Throws:

SmApiException

getDomainObjectNames

SmApiResult getDomainObjectNames(java.lang.String propName,
                                 java.lang.String domainName,
                                 java.util.Vector objectNames)
                                 throws SmApiException

Gets a list of domain objects within a domain.

Parameters:

propName - Property name of the domain object.

domainName - Name or object identifier of the SiteMinder domain object.

objectNames - This Vector will be populated with the retrieved list of domain objects.

Returns:

The result of the request.

Throws:

SmApiException

getGlobalObjectNames

SmApiResult getGlobalObjectNames(java.lang.String propName,
                                 java.util.Vector objectNames)
                                 throws SmApiException

Gets a list of global objects.

Parameters:

propName - Property name of the global object.

objectNames - This Vector will be populated with the retrieved list of global objects.

Returns:

The result of the request.

Throws:

SmApiException

flushAll

SmApiResult flushAll()
                     throws SmApiException

Flushes all SiteMinder caches. This method flushes policy store cache, resource cache, and user information cache.

Returns:

The result of the request.

Throws:

SmApiException

flushUsers

SmApiResult flushUsers()
                       throws SmApiException

Flushs the user information cache.

Returns:

The result of the request.

Throws:

SmApiException

flushUser

SmApiResult flushUser(java.lang.String userDirectory,
                      java.lang.String userDn)
                      throws SmApiException

Flushes a user from the user information cache.

Parameters:

userDirectory - The user directory where the user is located.

userDn - Distinguished name of the user being flushed.

Returns:

The result of the request.

Throws:

SmApiException

flushRealms

SmApiResult flushRealms()
                        throws SmApiException

Flushes all realms from the resource cache.

Returns:

The result of the request.

Throws:

SmApiException

flushRealm

SmApiResult flushRealm(java.lang.String realmOid)
                       throws SmApiException

Flushes a realm from the resource cache.

Parameters:

realmOid - Object identifier of the realm being flushed.

Returns:

The result of the request.

Throws:

SmApiException

changeDynamicKey

SmApiResult changeDynamicKey()
                             throws SmApiException

Changes a dynamic encryption key.

Before you change a dynamic key through the Java API, the Agent Key setting in the Policy Server Key Management dialog box must be set to Use dynamic Agent Key. To access this dialog box in the Policy Server UI, click Tools > Manage Keys. Then, in the Agent Key tab, select Use dynamic Agent Key.

Returns:

The result of the request.

Throws:

SmApiException

changePersistentKey

SmApiResult changePersistentKey(java.lang.String persistentKey)
                                throws SmApiException

Changes a persistent encryption key.

Parameters:

persistentKey - The persistent key to change. If persistentKey is empty, the persistent key is randomly generated.

Returns:

The result of the request.

Throws:

SmApiException

changeSessionKey

SmApiResult changeSessionKey(java.lang.String sessionKey)
                             throws SmApiException

Changes a session encryption key.

Parameters:

sessionKey - The session key to change. If sessionKey is empty, the session key is randomly generated.

Returns:

The result of the request.

Throws:

SmApiException

changeSharedSecretKey

SmApiResult changeSharedSecretKey()
                                  throws SmApiException

Changes a shared secret encryption key. The shared Secret key is randomly generated.

Returns:

The result of the request.

Throws:

SmApiException

renameObject

SmApiResult renameObject(SmObjId objId,
                         java.lang.String newName)
                         throws SmApiException

Renames an object. You can only rename objects that have a name property.

Parameters:

objId - Object identifier of the object being renamed.

newName - The new name for the object.

Returns:

The result of the API request.

Throws:

SmApiException

getVersion

int getVersion()

Gets the Policy API version compliance level.

Returns:

The Policy API version compliance level.

getPolicyStoreVersion

SmApiResult getPolicyStoreVersion(java.lang.StringBuffer majorVersion,
                                  java.lang.StringBuffer minorVersion,
                                  java.lang.StringBuffer mode)
                                  throws SmApiException

Throws:

SmApiException

doImport

SmApiResult doImport(SmImportAttr objImportAttr)
                     throws SmApiException

Imports policy data stored on a local client into remote Policy Server.

doImport() imports an entire policy store or a single policy domain from .smdif and .config files on the client’s local file system onto a remote policy server.

Functionally, the policy data import behaves in the same manner as the smobjimport utility). For more information about this tool, see the CA eTrust SiteMinder Policy Server Installation Guide.

Policy data to be imported is sent over the tunnel connection in 20kb chunks from the local files specified by smImportAttr.setFileName(). doImport() manages data transfer over the tunnel connection until completion. However, it will not resume transfer after a connection failure.

Parameters:

objImportAttr - Policy data import attributes.

Returns:

The result of the API request.

Throws:

SmApiException

Since:

SDK 6.0 SP2

doExport

SmApiResult doExport(SmExportAttr objExportAttr)
                     throws SmApiException

Exports policy data from a remote Policy Server.

doExport() exports an entire policy store or a single policy domain from a remote policy server and writes the output .smdif and .config files on the client’s local file system.

Functionally, the policy data export behaves in the same manner as the smobjexport utility. For more information about this tool, see the Policy Server Installation Guide.

Exported policy data is returned over the tunnel connection in 20kb chunks and written to the local files specified by smExportAttr.setFileName() or, if that method is not called, to stdout.smdif and stdout.cfg. doExport() manages data transfer over the tunnel connection until completion. However, it will not resume transfer after a connection failure.

Parameters:

objExportAttr - Policy data export attributes.

Returns:

The result of the API request.

Throws:

SmApiException

Since:

SDK 6.0 SP2

addAuthValidateMap

SmApiResult addAuthValidateMap(SmAuthValidateMap authValidateMap)
                               throws SmApiException

Adds an authentication and validation directory mapping object.

Parameters:

authValidateMap - The authentication and validation mapping object to add.

Returns:

The result of the request.

Throws:

SmApiException

modifyAuthValidateMap

SmApiResult modifyAuthValidateMap(SmAuthValidateMap authValidateMap)
                                  throws SmApiException

Modifies an authentication and validation directory mapping object.

Parameters:

authValidateMap - The authentication and validation mapping object to modify.

Returns:

The result of the request.

Throws:

SmApiException

deleteAuthValidateMap

SmApiResult deleteAuthValidateMap(SmObjId authValidateMapOid)
                                  throws SmApiException

Deletes an authentication and validation directory mapping object.

Parameters:

authValidateMapOid - Object identifier of the authentication and validation mapping object to delete.

Returns:

The result of the request.

Throws:

SmApiException

getAuthValidateMap

SmApiResult getAuthValidateMap(SmObjId authValidateMapOid,
                               SmAuthValidateMap authValidateMap)
                               throws SmApiException

Gets the contents of an authentication and validation directory mapping object.

Parameters:

authValidateMapOid - The object identifier of the authentication and validation mapping object to retreive.

authValidateMap - This object will be populated with the retrieved object.

Returns:

The result of the request.

Throws:

SmApiException

getChildren

SmApiResult getChildren(java.lang.String szOid,
                        java.util.Vector Children)
                        throws SmApiException

Gets a list of OIDs of realms under a domain or gets the list of rules and realms under a realm

Parameters:

szOID - - Object identifier of the SiteMinder domain object / realm object.

Children - - This object will be populated with the list of OIDs a) With top level realms, if the OID is of a domain b) With top level realms and rules OIDs if the OID passed is of a realm.

Returns:

The result of the request.

Throws:

SmApiException

IsGroup

boolean IsGroup(java.lang.String szOid)
                throws SmApiException

Returns whether the OID passed is of an group or not. i.e. rulegroup, responsegroup or agent group

Parameters:

szOID - - Object Identifier of the SiteMinder Object

Returns:

true if the object is a group and false otherwise.

Throws:

SmApiException

getSharedSecretPolicy

SmApiResult getSharedSecretPolicy(java.lang.String szOid,
                                  SmSharedSecretPolicy sharedSecretPolicy)
                                  throws SmApiException

Gets the contents of an SmSharedSecretPolicy object.

Parameters:

szOid - The Object Identifier of the Shared Secret Policy Object

sharedSecretPolicy - An object that will be populated with the properties of the SmSharedSecretPolicy object.

Returns:

The result of the request.

Throws:

SmApiException

modifySharedSecretPolicy

SmApiResult modifySharedSecretPolicy(SmSharedSecretPolicy sharedSecretPolicy)
                                     throws SmApiException

Modifies an SharedSecretPolicy object.

Parameters:

sharedSecretPolicy - The SharedSecretPolicy object to modify.

Returns:

The result of the request.

Throws:

SmApiException

getKeyManagement

SmApiResult getKeyManagement(java.lang.String szOid,
                             SmKeyManagement keyManagement)
                             throws SmApiException

Gets the contents of an SmKeyManagement object.

Parameters:

szOid - The Object Identifier of the KeyManagement Object

keymanagement - An object that will be populated with the properties of the SmKeyManagement object.

Returns:

The result of the request.

Throws:

SmApiException

modifyKeyManagement

SmApiResult modifyKeyManagement(SmKeyManagement keyManagement)
                                throws SmApiException

Modifies an SmKeyManagement object.

Parameters:

keymanagement - The Key Management object to modify.

Returns:

The result of the request.

Throws:

SmApiException