mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
1139 lines
57 KiB
HTML
1139 lines
57 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_412) on Mon Jul 22 13:25:23 PDT 2024 -->
|
|
<title>IdnRuleUtil</title>
|
|
<meta name="date" content="2024-07-22">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="IdnRuleUtil";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev Class</li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
|
|
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">sailpoint.server</div>
|
|
<h2 title="Interface IdnRuleUtil" class="title">Interface IdnRuleUtil</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">IdnRuleUtil</span></pre>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Field and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#EQUALS_FILTER">EQUALS_FILTER</a></span></code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#STARTS_WITH_FILTER">STARTS_WITH_FILTER</a></span></code> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#accountExistsByDisplayName-java.lang.String-java.lang.String-">accountExistsByDisplayName</a></span>(java.lang.String applicationName,
|
|
java.lang.String displayName)</code>
|
|
<div class="block">Determines if an account currently exists on an application using the display name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#accountExistsByNativeIdentity-java.lang.String-java.lang.String-">accountExistsByNativeIdentity</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity)</code>
|
|
<div class="block">Determines if an account currently exists on an application using the native identity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#attrSearchCountAccounts-java.util.List-java.lang.String-java.lang.String-java.util.List-">attrSearchCountAccounts</a></span>(java.util.List<java.lang.String> sourceIds,
|
|
java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.util.List<java.lang.String> values)</code>
|
|
<div class="block">Count the accounts that match the searchable attribute and value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#attrSearchGetIdentityName-java.util.List-java.lang.String-java.lang.String-java.util.List-">attrSearchGetIdentityName</a></span>(java.util.List<java.lang.String> sourceIds,
|
|
java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.util.List<java.lang.String> values)</code>
|
|
<div class="block">Get the identity name for the account matching the specified criteria.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#countAccounts-java.lang.String-">countAccounts</a></span>(java.lang.String applicationName)</code>
|
|
<div class="block">Counts the number of accounts on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#countIdentitiesBySearchableIdentityAttribute-java.lang.String-java.lang.String-java.lang.String-">countIdentitiesBySearchableIdentityAttribute</a></span>(java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.lang.String value)</code>
|
|
<div class="block">Count and return the number of users that match the incoming attributeName, operation and value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#findAccountsByAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.Object-">findAccountsByAttribute</a></span>(java.lang.String applicationName,
|
|
java.lang.String identityName,
|
|
java.lang.String attributeName,
|
|
java.lang.Object attributeValue)</code>
|
|
<div class="block">Method that will return a list of accounts for the given Identity that matches the
|
|
attributeName and values passed to the method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="../../sailpoint/rule/Identity.html" title="interface in sailpoint.rule">Identity</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#findIdentitiesBySearchableIdentityAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">findIdentitiesBySearchableIdentityAttribute</a></span>(java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.lang.String value,
|
|
java.lang.String sortAttribute)</code>
|
|
<div class="block">Find and return the users that match the incoming attributeName, operation, value ordered by
|
|
the specified sortAttribute</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttribute-sailpoint.rule.Account-java.lang.String-">getAccountAttribute</a></span>(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the String value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttribute-java.lang.String-java.lang.String-java.lang.String-">getAccountAttribute</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the String value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttributeBool-sailpoint.rule.Account-java.lang.String-">getAccountAttributeBool</a></span>(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the boolean value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttributeBool-java.lang.String-java.lang.String-java.lang.String-">getAccountAttributeBool</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the boolean value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttributeInt-sailpoint.rule.Account-java.lang.String-">getAccountAttributeInt</a></span>(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the int value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountAttributeInt-java.lang.String-java.lang.String-java.lang.String-">getAccountAttributeInt</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the int value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountByDisplayName-java.lang.String-java.lang.String-">getAccountByDisplayName</a></span>(java.lang.String applicationName,
|
|
java.lang.String displayName)</code>
|
|
<div class="block">Gets an account on an application using the display name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAccountByNativeIdentity-java.lang.String-java.lang.String-">getAccountByNativeIdentity</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity)</code>
|
|
<div class="block">Gets an account on an application using the native identity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getAllAccounts-java.lang.String-java.lang.String-">getAllAccounts</a></span>(java.lang.String applicationName,
|
|
java.lang.String identityName)</code>
|
|
<div class="block">Given the name of the application and the identity name return the list of
|
|
Account objects found for the identity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getFirstAccount-java.lang.String-java.lang.String-">getFirstAccount</a></span>(java.lang.String applicationName,
|
|
java.lang.String identityName)</code>
|
|
<div class="block">Get the first account found for the application and identityName.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getFirstAccountNativeIdentity-java.lang.String-java.lang.String-">getFirstAccountNativeIdentity</a></span>(java.lang.String applicationName,
|
|
java.lang.String identityName)</code>
|
|
<div class="block">Get the first account for the application and identityName and return the first accounts native Identity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getFirstAccountNativeIdentityByAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.Object-">getFirstAccountNativeIdentityByAttribute</a></span>(java.lang.String applicationName,
|
|
java.lang.String identityName,
|
|
java.lang.String attributeName,
|
|
java.lang.Object attributeValue)</code>
|
|
<div class="block">Method that will find the first nativeIdentity based on the attributeName and attributeValue
|
|
being passed in.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="../../sailpoint/rule/Identity.html" title="interface in sailpoint.rule">Identity</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getIdentityById-java.lang.String-">getIdentityById</a></span>(java.lang.String id)</code>
|
|
<div class="block">Fetch an identity by the internal id.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getManagedAttributeDescription-java.lang.String-java.lang.String-java.lang.String-sailpoint.object.ManagedAttribute.Type-">getManagedAttributeDescription</a></span>(java.lang.String sourceId,
|
|
java.lang.String name,
|
|
java.lang.String value,
|
|
<a href="../../sailpoint/object/ManagedAttribute.Type.html" title="enum in sailpoint.object">ManagedAttribute.Type</a> type)</code>
|
|
<div class="block">Finds ManagedAttribute description by provided sourceId/name/value/type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="../../sailpoint/rule/ManagedAttributeDetails.html" title="class in sailpoint.rule">ManagedAttributeDetails</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getManagedAttributeDetails-java.lang.String-java.lang.String-java.lang.String-sailpoint.object.ManagedAttribute.Type-">getManagedAttributeDetails</a></span>(java.lang.String sourceId,
|
|
java.lang.String name,
|
|
java.lang.String value,
|
|
<a href="../../sailpoint/object/ManagedAttribute.Type.html" title="enum in sailpoint.object">ManagedAttribute.Type</a> type)</code>
|
|
<div class="block">Finds ManagedAttribute by sourceId/name/value/type and returns its details in ManagedAttributeDetails model.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getRawAccountAttribute-sailpoint.rule.Account-java.lang.String-">getRawAccountAttribute</a></span>(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getRawAccountAttribute-java.lang.String-java.lang.String-java.lang.String-">getRawAccountAttribute</a></span>(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</code>
|
|
<div class="block">Gets the value of an attribute from an account on an application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getSourceAttributeBySourceId-java.lang.String-java.lang.String-">getSourceAttributeBySourceId</a></span>(java.lang.String sourceId,
|
|
java.lang.String attributeName)</code>
|
|
<div class="block">Get a single Source string attribute from an Application using the applicationId</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#getSourceAttributeBySourceName-java.lang.String-java.lang.String-">getSourceAttributeBySourceName</a></span>(java.lang.String sourceName,
|
|
java.lang.String attributeName)</code>
|
|
<div class="block">Get a single Source string attribute from an Application using the applicationId</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#isUniqueAccountId-java.lang.String-java.lang.String-java.lang.String-">isUniqueAccountId</a></span>(java.lang.String identityNameOrId,
|
|
java.lang.String applicationNameOrId,
|
|
java.lang.String accountId)</code>
|
|
<div class="block">A method that will call getObject() on the connector for the Account type
|
|
and test if an account with the given accountId exists.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/server/IdnRuleUtil.html#isUniqueLDAPValue-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">isUniqueLDAPValue</a></span>(java.lang.String identityNameOrId,
|
|
java.lang.String applicationNameOrId,
|
|
java.lang.String attributeName,
|
|
java.lang.String attributeValue)</code>
|
|
<div class="block">A method that can be used to call LDAP type connectors to look for
|
|
unique values.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="STARTS_WITH_FILTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>STARTS_WITH_FILTER</h4>
|
|
<pre>static final java.lang.String STARTS_WITH_FILTER</pre>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../constant-values.html#sailpoint.server.IdnRuleUtil.STARTS_WITH_FILTER">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="EQUALS_FILTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>EQUALS_FILTER</h4>
|
|
<pre>static final java.lang.String EQUALS_FILTER</pre>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../constant-values.html#sailpoint.server.IdnRuleUtil.EQUALS_FILTER">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="accountExistsByNativeIdentity-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>accountExistsByNativeIdentity</h4>
|
|
<pre>boolean accountExistsByNativeIdentity(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Determines if an account currently exists on an application using the native identity.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the account exists, false otherwise.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="accountExistsByDisplayName-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>accountExistsByDisplayName</h4>
|
|
<pre>boolean accountExistsByDisplayName(java.lang.String applicationName,
|
|
java.lang.String displayName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Determines if an account currently exists on an application using the display name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>displayName</code> - The display name of the account.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the account exists, false otherwise.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountByNativeIdentity-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountByNativeIdentity</h4>
|
|
<pre><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> getAccountByNativeIdentity(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Gets an account on an application using the native identity.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The Account representing the account or null if not found. If more than one found then the first
|
|
Account in the exists is returned.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountByDisplayName-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountByDisplayName</h4>
|
|
<pre><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> getAccountByDisplayName(java.lang.String applicationName,
|
|
java.lang.String displayName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Gets an account on an application using the display name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>displayName</code> - The display name of the account.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The Account representing the account or null if not found. If more than one found then the first
|
|
Account in the exists is returned.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAllAccounts-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAllAccounts</h4>
|
|
<pre>java.util.List<<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a>> getAllAccounts(java.lang.String applicationName,
|
|
java.lang.String identityName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Given the name of the application and the identity name return the list of
|
|
Account objects found for the identity.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The name of the application</dd>
|
|
<dd><code>identityName</code> - The name of the identity</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>List of AccountObjects required</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirstAccount-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirstAccount</h4>
|
|
<pre><a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> getFirstAccount(java.lang.String applicationName,
|
|
java.lang.String identityName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Get the first account found for the application and identityName.
|
|
IF there is more than one account the first account will be returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The name of the application</dd>
|
|
<dd><code>identityName</code> - The name of the Identity</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The account object</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirstAccountNativeIdentity-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirstAccountNativeIdentity</h4>
|
|
<pre>java.lang.String getFirstAccountNativeIdentity(java.lang.String applicationName,
|
|
java.lang.String identityName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Get the first account for the application and identityName and return the first accounts native Identity.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The name of the application</dd>
|
|
<dd><code>identityName</code> - The name of the identity</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The first link's nativeIdentity</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirstAccountNativeIdentityByAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirstAccountNativeIdentityByAttribute</h4>
|
|
<pre>java.lang.String getFirstAccountNativeIdentityByAttribute(java.lang.String applicationName,
|
|
java.lang.String identityName,
|
|
java.lang.String attributeName,
|
|
java.lang.Object attributeValue)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Method that will find the first nativeIdentity based on the attributeName and attributeValue
|
|
being passed in. This method will iterate over the list of Accounts associated to the Identity
|
|
for the Source specified.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The name of the application</dd>
|
|
<dd><code>identityName</code> - The name of the identity we are using</dd>
|
|
<dd><code>attributeName</code> - The name of the attribute we are to match</dd>
|
|
<dd><code>attributeValue</code> - The value of the attribute we are to match</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The first non-null AND non-empty nativeIdentity that matches the passed in
|
|
identity, attributeName and attributeValue. When matching attributeValue if the values
|
|
are both null they are equal, if the value is an empty string it'll be transformed to a null.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="findAccountsByAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>findAccountsByAttribute</h4>
|
|
<pre>java.util.List<<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a>> findAccountsByAttribute(java.lang.String applicationName,
|
|
java.lang.String identityName,
|
|
java.lang.String attributeName,
|
|
java.lang.Object attributeValue)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Method that will return a list of accounts for the given Identity that matches the
|
|
attributeName and values passed to the method.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The name of the application</dd>
|
|
<dd><code>identityName</code> - The name of the identity we are using</dd>
|
|
<dd><code>attributeName</code> - The name of the attribute we are to match</dd>
|
|
<dd><code>attributeValue</code> - The value of the attribute we are to match
|
|
get</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>accounts that match the given identity, source, attribute and value, empty list if no accounts are found.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="countAccounts-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>countAccounts</h4>
|
|
<pre>int countAccounts(java.lang.String applicationName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Counts the number of accounts on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The total number of accounts.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRawAccountAttribute-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRawAccountAttribute</h4>
|
|
<pre>java.lang.Object getRawAccountAttribute(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Gets the value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or null if the attribute does not exist.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRawAccountAttribute-sailpoint.rule.Account-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRawAccountAttribute</h4>
|
|
<pre>java.lang.Object getRawAccountAttribute(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>account</code> - The account on the application.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or null if the attribute does not exist.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttribute-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttribute</h4>
|
|
<pre>java.lang.String getAccountAttribute(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Gets the String value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or null if the attribute does not exist.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttribute-sailpoint.rule.Account-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttribute</h4>
|
|
<pre>java.lang.String getAccountAttribute(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the String value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>account</code> - The account on the application.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or null if the attribute does not exist.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttributeBool-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttributeBool</h4>
|
|
<pre>boolean getAccountAttributeBool(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the boolean value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or false if the attribute does not exist.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttributeBool-sailpoint.rule.Account-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttributeBool</h4>
|
|
<pre>boolean getAccountAttributeBool(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the boolean value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>account</code> - The account on the application.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or false if the attribute does not exist.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="attrSearchCountAccounts-java.util.List-java.lang.String-java.lang.String-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>attrSearchCountAccounts</h4>
|
|
<pre>int attrSearchCountAccounts(java.util.List<java.lang.String> sourceIds,
|
|
java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.util.List<java.lang.String> values)</pre>
|
|
<div class="block">Count the accounts that match the searchable attribute and value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceIds</code> - The list of Application ids that represent the sources of the data.</dd>
|
|
<dd><code>attributeName</code> - The name of the searchable account attribute. The name parameter is required.</dd>
|
|
<dd><code>operation</code> - The operation to use when matching, it'll either be Equals or StartsWith.</dd>
|
|
<dd><code>values</code> - The list of values of that searchable attribute to match. The values parameter is required.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of accounts that match the parameters provided.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - wrapping underlying errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="attrSearchGetIdentityName-java.util.List-java.lang.String-java.lang.String-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>attrSearchGetIdentityName</h4>
|
|
<pre>java.lang.String attrSearchGetIdentityName(java.util.List<java.lang.String> sourceIds,
|
|
java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.util.List<java.lang.String> values)</pre>
|
|
<div class="block">Get the identity name for the account matching the specified criteria.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceIds</code> - The list of Application ids that represent the sources of the data</dd>
|
|
<dd><code>attributeName</code> - The name of the searchable account attribute. The name parameter is required.</dd>
|
|
<dd><code>operation</code> - The operation to use when matching, it'll either be Equals or StartsWith.</dd>
|
|
<dd><code>values</code> - The list of values of that searchable attribute to match. The values parameter is required.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The name of the Identity that matched the account that match the parameters provided.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - wrapping underlying errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttributeInt-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttributeInt</h4>
|
|
<pre>int getAccountAttributeInt(java.lang.String applicationName,
|
|
java.lang.String nativeIdentity,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the int value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>applicationName</code> - The application name.</dd>
|
|
<dd><code>nativeIdentity</code> - The native identity of the account.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or zero if the attribute does not exist.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAccountAttributeInt-sailpoint.rule.Account-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAccountAttributeInt</h4>
|
|
<pre>int getAccountAttributeInt(<a href="../../sailpoint/rule/Account.html" title="class in sailpoint.rule">Account</a> account,
|
|
java.lang.String attribute)</pre>
|
|
<div class="block">Gets the int value of an attribute from an account on an application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>account</code> - The account on the application.</dd>
|
|
<dd><code>attribute</code> - The name of the attribute to retrieve.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The attribute value or zero if the attribute does not exist.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getManagedAttributeDescription-java.lang.String-java.lang.String-java.lang.String-sailpoint.object.ManagedAttribute.Type-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getManagedAttributeDescription</h4>
|
|
<pre>java.lang.String getManagedAttributeDescription(java.lang.String sourceId,
|
|
java.lang.String name,
|
|
java.lang.String value,
|
|
<a href="../../sailpoint/object/ManagedAttribute.Type.html" title="enum in sailpoint.object">ManagedAttribute.Type</a> type)</pre>
|
|
<div class="block">Finds ManagedAttribute description by provided sourceId/name/value/type.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceId</code> - The sourceId used to query the ManagedAttribute.</dd>
|
|
<dd><code>name</code> - The name of the attribute used to query the ManagedAttribute.</dd>
|
|
<dd><code>value</code> - The value of the attribute used to query the ManagedAttribute.</dd>
|
|
<dd><code>type</code> - The type of the attribute used to query the ManagedAttribute (see enum ManagedAttribute.Type).
|
|
Defaults to Entitlement (if null provided).</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>ManagedAttribute's description if found or else null.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getManagedAttributeDetails-java.lang.String-java.lang.String-java.lang.String-sailpoint.object.ManagedAttribute.Type-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getManagedAttributeDetails</h4>
|
|
<pre><a href="../../sailpoint/rule/ManagedAttributeDetails.html" title="class in sailpoint.rule">ManagedAttributeDetails</a> getManagedAttributeDetails(java.lang.String sourceId,
|
|
java.lang.String name,
|
|
java.lang.String value,
|
|
<a href="../../sailpoint/object/ManagedAttribute.Type.html" title="enum in sailpoint.object">ManagedAttribute.Type</a> type)</pre>
|
|
<div class="block">Finds ManagedAttribute by sourceId/name/value/type and returns its details in ManagedAttributeDetails model.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceId</code> - The sourceId used to query the ManagedAttribute.</dd>
|
|
<dd><code>name</code> - The name of the attribute used to query the ManagedAttribute.</dd>
|
|
<dd><code>value</code> - The value of the attribute used to query the ManagedAttribute.</dd>
|
|
<dd><code>type</code> - The type of the attribute used to query the ManagedAttribute (see enum ManagedAttribute.Type).
|
|
Defaults to Entitlement (if null provided).</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>ManagedAttributeDetails if found or else null.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getIdentityById-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIdentityById</h4>
|
|
<pre><a href="../../sailpoint/rule/Identity.html" title="interface in sailpoint.rule">Identity</a> getIdentityById(java.lang.String id)</pre>
|
|
<div class="block">Fetch an identity by the internal id.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The id to use when fetching an identity object</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A DTO representing the Identity, will throw if identity was not found</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="findIdentitiesBySearchableIdentityAttribute-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>findIdentitiesBySearchableIdentityAttribute</h4>
|
|
<pre>java.util.List<<a href="../../sailpoint/rule/Identity.html" title="interface in sailpoint.rule">Identity</a>> findIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.lang.String value,
|
|
java.lang.String sortAttribute)</pre>
|
|
<div class="block">Find and return the users that match the incoming attributeName, operation, value ordered by
|
|
the specified sortAttribute</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>attributeName</code> - The attribute that should be searched, must be searchable and non-null</dd>
|
|
<dd><code>operation</code> - The operation to be used when searching; only Equals and StartsWith are supported</dd>
|
|
<dd><code>value</code> - The value that should match and must be non-null</dd>
|
|
<dd><code>sortAttribute</code> - The attribute that should be used while sorting
|
|
Default ordering will be on uid if not specified and this also must be searchable
|
|
Sort will always be in ascending order</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The List of users that match the passed in parameters. The max number returned values will be limited to 50.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - when attribute provided is not searchable,
|
|
when operation is not StartsWith or Equals,
|
|
the sortAttribute is not searahable,
|
|
or if there are issues during the search</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="countIdentitiesBySearchableIdentityAttribute-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>countIdentitiesBySearchableIdentityAttribute</h4>
|
|
<pre>int countIdentitiesBySearchableIdentityAttribute(java.lang.String attributeName,
|
|
java.lang.String operation,
|
|
java.lang.String value)</pre>
|
|
<div class="block">Count and return the number of users that match the incoming attributeName, operation and value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>attributeName</code> - The attribute that should be searched, must be searchable and non-null</dd>
|
|
<dd><code>operation</code> - The operation to be used when searching; only Equals and StartsWith are supported</dd>
|
|
<dd><code>value</code> - The value that should match and must be non-null</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of identities that match the parameters</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalStateException</code> - when attribute provided is not searchable,
|
|
when operation is not StartsWith or Equals,
|
|
or if there are issues during the count operation</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isUniqueLDAPValue-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isUniqueLDAPValue</h4>
|
|
<pre>boolean isUniqueLDAPValue(java.lang.String identityNameOrId,
|
|
java.lang.String applicationNameOrId,
|
|
java.lang.String attributeName,
|
|
java.lang.String attributeValue)</pre>
|
|
<div class="block">A method that can be used to call LDAP type connectors to look for
|
|
unique values. The connector is called with a specific search filter
|
|
based on the attributeName and value that is passed into this method.
|
|
If there is a value returned the values is considered to be non-unique.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>identityNameOrId</code> - The name or ID of the identity we are using</dd>
|
|
<dd><code>applicationNameOrId</code> - The name or ID of the source we are targeting</dd>
|
|
<dd><code>attributeName</code> - The name of the attribute we want to validate</dd>
|
|
<dd><code>attributeValue</code> - The value of the attribute we want to validate</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the value is unique AND false otherwise. If the application or identity can't be found an
|
|
IllegalStateException will be thrown.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSourceAttributeBySourceId-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSourceAttributeBySourceId</h4>
|
|
<pre>java.lang.String getSourceAttributeBySourceId(java.lang.String sourceId,
|
|
java.lang.String attributeName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Get a single Source string attribute from an Application using the applicationId</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceId</code> - The id of the source</dd>
|
|
<dd><code>attributeName</code> - The name/key of the attribute to return</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The value if found in the attributes</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSourceAttributeBySourceName-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSourceAttributeBySourceName</h4>
|
|
<pre>java.lang.String getSourceAttributeBySourceName(java.lang.String sourceName,
|
|
java.lang.String attributeName)
|
|
throws sailpoint.tools.GeneralException</pre>
|
|
<div class="block">Get a single Source string attribute from an Application using the applicationId</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sourceName</code> - (internal name i.e. application.getName() vs displayName of the application</dd>
|
|
<dd><code>attributeName</code> - The name/key of the attribute to return</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The value if found in the attributes</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>sailpoint.tools.GeneralException</code> - wrapping underlying DB related errors</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isUniqueAccountId-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>isUniqueAccountId</h4>
|
|
<pre>boolean isUniqueAccountId(java.lang.String identityNameOrId,
|
|
java.lang.String applicationNameOrId,
|
|
java.lang.String accountId)</pre>
|
|
<div class="block">A method that will call getObject() on the connector for the Account type
|
|
and test if an account with the given accountId exists. If the account exists the method
|
|
will return false, otherwise true.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>identityNameOrId</code> - The name or ID of the identity we are using</dd>
|
|
<dd><code>applicationNameOrId</code> - The name or ID of the source we are targeting</dd>
|
|
<dd><code>accountId</code> - The accountId we are trying to validate</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the account is unique, false otherwise</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li>Prev Class</li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
|
|
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|