Files
developer.sailpoint.com/static/rule-java-docs/sailpoint/object/Identity.html
2023-05-03 23:14:09 -04:00

588 lines
18 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_322) on Tue Nov 08 10:19:03 EST 2022 -->
<title>Identity</title>
<meta name="date" content="2022-11-08">
<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="Identity";
}
}
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};
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><a href="../../sailpoint/object/Field.ApplicationDependency.html" title="class in sailpoint.object"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/object/ProvisioningPlan.html" title="interface in sailpoint.object"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.object</div>
<h2 title="Interface Identity" class="title">Interface Identity</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Identity</span></pre>
<div class="block">Definition of a User interface available to Rule implementors.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String&nbsp;attributeName)</code>
<div class="block">Get the user's specified attribute as an object</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getAttributes--">getAttributes</a></span>()</code>
<div class="block">Get the raw attributes of the User.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getCountry--">getCountry</a></span>()</code>
<div class="block">Get the country of the user</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/object/Identity.html#getDisplayName--">getDisplayName</a></span>()</code>
<div class="block">Get the display name of the identity</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getEmail--">getEmail</a></span>()</code>
<div class="block">Get the work email of the User.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getEmployeeNumber--">getEmployeeNumber</a></span>()</code>
<div class="block">Get the user's employee number;</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getFirstName--">getFirstName</a></span>()</code>
<div class="block">Get the first name of the User.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getId--">getId</a></span>()</code>
<div class="block">Get the internal unique identifier.</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/object/Identity.html#getLastName--">getLastName</a></span>()</code>
<div class="block">Get the last name of the User.</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/object/Identity.html#getLifecycleState--">getLifecycleState</a></span>()</code>
<div class="block">Get the current lifecycle state of the User.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getManagerId--">getManagerId</a></span>()</code>
<div class="block">The internal ID of the manager for this User.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getManagerName--">getManagerName</a></span>()</code>
<div class="block">Gets the name of the user's manager.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getName--">getName</a></span>()</code>
<div class="block">Get the internal name of the User.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getPersonalEmail--">getPersonalEmail</a></span>()</code>
<div class="block">Get the personal email of the User.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getPhone--">getPhone</a></span>()</code>
<div class="block">Get the phone of the User.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getStringAttribute-java.lang.String-">getStringAttribute</a></span>(java.lang.String&nbsp;attributeName)</code>
<div class="block">Get the user's specified attribute as a string</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getUid--">getUid</a></span>()</code>
<div class="block">Get the uid of the USer;</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#getWorkPhone--">getWorkPhone</a></span>()</code>
<div class="block">Get the work phone of the User.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Identity.html#isManager--">isManager</a></span>()</code>
<div class="block">Check to see if the current user has reports and is a manager.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Get the internal name of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the internal name</dd>
</dl>
</li>
</ul>
<a name="getDisplayName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre>java.lang.String&nbsp;getDisplayName()</pre>
<div class="block">Get the display name of the identity</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The displayName</dd>
</dl>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String&nbsp;getId()</pre>
<div class="block">Get the internal unique identifier.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The id</dd>
</dl>
</li>
</ul>
<a name="getFirstName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstName</h4>
<pre>java.lang.String&nbsp;getFirstName()</pre>
<div class="block">Get the first name of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The FirstName</dd>
</dl>
</li>
</ul>
<a name="getLastName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastName</h4>
<pre>java.lang.String&nbsp;getLastName()</pre>
<div class="block">Get the last name of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The LastName</dd>
</dl>
</li>
</ul>
<a name="getPhone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPhone</h4>
<pre>java.lang.String&nbsp;getPhone()</pre>
<div class="block">Get the phone of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The phone</dd>
</dl>
</li>
</ul>
<a name="getWorkPhone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkPhone</h4>
<pre>java.lang.String&nbsp;getWorkPhone()</pre>
<div class="block">Get the work phone of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The work phone</dd>
</dl>
</li>
</ul>
<a name="getPersonalEmail--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersonalEmail</h4>
<pre>java.lang.String&nbsp;getPersonalEmail()</pre>
<div class="block">Get the personal email of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The personal email address</dd>
</dl>
</li>
</ul>
<a name="getEmail--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmail</h4>
<pre>java.lang.String&nbsp;getEmail()</pre>
<div class="block">Get the work email of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The work email</dd>
</dl>
</li>
</ul>
<a name="getLifecycleState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLifecycleState</h4>
<pre>java.lang.String&nbsp;getLifecycleState()</pre>
<div class="block">Get the current lifecycle state of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The lifecycle state</dd>
</dl>
</li>
</ul>
<a name="getAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getAttributes()</pre>
<div class="block">Get the raw attributes of the User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The map attributes derived from attribute promotion.</dd>
</dl>
</li>
</ul>
<a name="getUid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUid</h4>
<pre>java.lang.String&nbsp;getUid()</pre>
<div class="block">Get the uid of the USer;</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Uid</dd>
</dl>
</li>
</ul>
<a name="isManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isManager</h4>
<pre>boolean&nbsp;isManager()</pre>
<div class="block">Check to see if the current user has reports and is a manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the User is a manager, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getManagerId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagerId</h4>
<pre>java.lang.String&nbsp;getManagerId()</pre>
<div class="block">The internal ID of the manager for this User.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The internal ID of the manager</dd>
</dl>
</li>
</ul>
<a name="getManagerName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagerName</h4>
<pre>java.lang.String&nbsp;getManagerName()</pre>
<div class="block">Gets the name of the user's manager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the manager</dd>
</dl>
</li>
</ul>
<a name="getCountry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountry</h4>
<pre>java.lang.String&nbsp;getCountry()</pre>
<div class="block">Get the country of the user</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The country</dd>
</dl>
</li>
</ul>
<a name="getEmployeeNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmployeeNumber</h4>
<pre>java.lang.String&nbsp;getEmployeeNumber()</pre>
<div class="block">Get the user's employee number;</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The employee number</dd>
</dl>
</li>
</ul>
<a name="getStringAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringAttribute</h4>
<pre>java.lang.String&nbsp;getStringAttribute(java.lang.String&nbsp;attributeName)</pre>
<div class="block">Get the user's specified attribute as a string</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The attribute string</dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAttribute</h4>
<pre>java.lang.Object&nbsp;getAttribute(java.lang.String&nbsp;attributeName)</pre>
<div class="block">Get the user's specified attribute as an object</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The attribute object</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><a href="../../sailpoint/object/Field.ApplicationDependency.html" title="class in sailpoint.object"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../sailpoint/object/ProvisioningPlan.html" title="interface in sailpoint.object"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>