mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 12:27:46 +00:00
837 lines
31 KiB
HTML
837 lines
31 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 Thu May 04 14:44:34 EDT 2023 -->
|
|
<title>Endpoint</title>
|
|
<meta name="date" content="2023-05-04">
|
|
<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="Endpoint";
|
|
}
|
|
}
|
|
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};
|
|
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><a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices"><span class="typeNameLink">Next Class</span></a></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>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </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.connector.webservices</div>
|
|
<h2 title="Interface Endpoint" class="title">Interface Endpoint</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">Endpoint</span></pre>
|
|
</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"> </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>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#addHeader-java.lang.String-java.lang.String-">addHeader</a></span>(java.lang.String entry,
|
|
java.lang.String value)</code>
|
|
<div class="block">Use this method to add a header value to the existing http header map for the request</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAfterRule--">getAfterRule</a></span>()</code>
|
|
<div class="block">Use this method to get the name of the rule to run after the webservice request completes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAttribute-java.lang.String-">getAttribute</a></span>(java.lang.String name)</code>
|
|
<div class="block">Use this method to get the value of an attribute</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>sailpoint.object.Attributes</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getAttributes--">getAttributes</a></span>()</code>
|
|
<div class="block">Use this method to get all the available attributes</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBaseUrl--">getBaseUrl</a></span>()</code>
|
|
<div class="block">Use this method to get the base url (endpoint) of the operation that is to be performed for the particular operation</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBeforeRule--">getBeforeRule</a></span>()</code>
|
|
<div class="block">Use this method to get the name of the rule to run before the webservice request completes</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getBody--">getBody</a></span>()</code>
|
|
<div class="block">Use this method to get the http payload information as a map.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getContextUrl--">getContextUrl</a></span>()</code>
|
|
<div class="block">Use this method to get the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getFullUrl--">getFullUrl</a></span>()</code>
|
|
<div class="block">Use this method to get the complete url (endpoint) of the operation that is to be performed for the particular operation</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getHeader--">getHeader</a></span>()</code>
|
|
<div class="block">Use this method to get the header values for the request</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getHttpMethodType--">getHttpMethodType</a></span>()</code>
|
|
<div class="block">Use this method to get the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getOperationType--">getOperationType</a></span>()</code>
|
|
<div class="block">Use this method to get the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getResMappingObj--">getResMappingObj</a></span>()</code>
|
|
<div class="block">Use this method to get the response mapping for the response attributes returned from the JSON response of the managed source.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getResponseCode--">getResponseCode</a></span>()</code>
|
|
<div class="block">Use this method to get the value of successful response codes as a list (200,201,299).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getRootPath--">getRootPath</a></span>()</code>
|
|
<div class="block">Use this method to get the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
|
|
<br>
|
|
Example root path for the json below: <code>$.results </code></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getSequenceNumberForEndpoint--">getSequenceNumberForEndpoint</a></span>()</code>
|
|
<div class="block">Use this method to get the sequence number for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#getUniqueNameForEndPoint--">getUniqueNameForEndPoint</a></span>()</code>
|
|
<div class="block">Use this method to get the unique operation name for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setBaseUrl-java.lang.String-">setBaseUrl</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the base url (endpoint) of the operation that is to be performed for the particular operation</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setBody-java.util.Map-">setBody</a></span>(java.util.Map value)</code>
|
|
<div class="block">Use this method to set the http payload information as a map.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setContextUrl-java.lang.String-">setContextUrl</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setFullUrl-java.lang.String-">setFullUrl</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the complete url (endpoint) of the operation that is to be performed for the particular operation</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setHeader-java.util.Map-">setHeader</a></span>(java.util.Map value)</code>
|
|
<div class="block">Use this method to set the header values for the request</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setHttpMethodType-java.lang.String-">setHttpMethodType</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setOperationType-java.lang.String-">setOperationType</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setResMappingObj-java.util.Map-">setResMappingObj</a></span>(java.util.Map value)</code>
|
|
<div class="block">Use this method to set the response mapping for the response attributes returned from the JSON response of the managed source.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setResponseCode-java.util.List-">setResponseCode</a></span>(java.util.List value)</code>
|
|
<div class="block">Use this method to set the value of successful response codes as a list (200,201,299).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../sailpoint/connector/webservices/Endpoint.html#setRootPath-java.lang.String-">setRootPath</a></span>(java.lang.String value)</code>
|
|
<div class="block">Use this method to set the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
|
|
<br>
|
|
Example root path for the json below: <code>$.results </code></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="getAfterRule--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAfterRule</h4>
|
|
<pre>void getAfterRule()</pre>
|
|
<div class="block">Use this method to get the name of the rule to run after the webservice request completes.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getBeforeRule--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBeforeRule</h4>
|
|
<pre>void getBeforeRule()</pre>
|
|
<div class="block">Use this method to get the name of the rule to run before the webservice request completes</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setContextUrl-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setContextUrl</h4>
|
|
<pre>void setContextUrl(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the name of the context url</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getContextUrl--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getContextUrl</h4>
|
|
<pre>void getContextUrl()</pre>
|
|
<div class="block">Use this method to get the context url for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setHttpMethodType-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setHttpMethodType</h4>
|
|
<pre>void setHttpMethodType(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the name of the http method type [get, post, put, patch, delete]</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getHttpMethodType--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHttpMethodType</h4>
|
|
<pre>void getHttpMethodType()</pre>
|
|
<div class="block">Use this method to get the http method type (put, post, get, patch, delete) for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setOperationType-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setOperationType</h4>
|
|
<pre>void setOperationType(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the name of the operation type</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getOperationType--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOperationType</h4>
|
|
<pre>void getOperationType()</pre>
|
|
<div class="block">Use this method to get the operation type (Account Aggregation, Group Aggregation, Create Account, etc...) for the particular operation record (create user, update user, account aggregation, etc...)</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setRootPath-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRootPath</h4>
|
|
<pre>void setRootPath(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
|
|
<br>
|
|
Example root path for the json below: <code>$.results </code>
|
|
<pre>
|
|
{
|
|
"results": [
|
|
{
|
|
"id": "12345",
|
|
"name": "John Doe"
|
|
"email": "john.doe@sailpoint.com"
|
|
},
|
|
{
|
|
"id": "54321",
|
|
"name": "Jane Doe",
|
|
"email": "jane.doe@sailpoint.com"
|
|
}
|
|
]
|
|
}
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the name of the root of the JSON response results</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRootPath--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRootPath</h4>
|
|
<pre>void getRootPath()</pre>
|
|
<div class="block">Use this method to get the root of the JSON response returned from the managed source for the particular operation (create user, update user, account aggregation, etc...)
|
|
<br>
|
|
Example root path for the json below: <code>$.results </code>
|
|
<pre>
|
|
{
|
|
"results": [
|
|
{
|
|
"id": "12345",
|
|
"name": "John Doe"
|
|
"email": "john.doe@sailpoint.com"
|
|
},
|
|
{
|
|
"id": "54321",
|
|
"name": "Jane Doe",
|
|
"email": "jane.doe@sailpoint.com"
|
|
}
|
|
]
|
|
}
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="setFullUrl-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setFullUrl</h4>
|
|
<pre>void setFullUrl(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the complete url (endpoint) of the operation that is to be performed for the particular operation
|
|
<pre>
|
|
Example full url for Airtable Get Users call
|
|
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg/Users
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the full url as a string</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFullUrl--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFullUrl</h4>
|
|
<pre>void getFullUrl()</pre>
|
|
<div class="block">Use this method to get the complete url (endpoint) of the operation that is to be performed for the particular operation
|
|
<pre>
|
|
Example full url for Airtable Get Users call
|
|
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg/Users
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="setBaseUrl-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBaseUrl</h4>
|
|
<pre>void setBaseUrl(java.lang.String value)</pre>
|
|
<div class="block">Use this method to set the base url (endpoint) of the operation that is to be performed for the particular operation
|
|
<pre>
|
|
Example base url for Airtable Get Users call
|
|
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the base url as a string</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBaseUrl--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBaseUrl</h4>
|
|
<pre>void getBaseUrl()</pre>
|
|
<div class="block">Use this method to get the base url (endpoint) of the operation that is to be performed for the particular operation
|
|
<pre>
|
|
Example base url for Airtable Get Users call
|
|
ex: https://api.airtable.com/v0/appe0bVnLjyV97hyg
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="getSequenceNumberForEndpoint--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSequenceNumberForEndpoint</h4>
|
|
<pre>void getSequenceNumberForEndpoint()</pre>
|
|
<div class="block">Use this method to get the sequence number for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getUniqueNameForEndPoint--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUniqueNameForEndPoint</h4>
|
|
<pre>void getUniqueNameForEndPoint()</pre>
|
|
<div class="block">Use this method to get the unique operation name for the particular operation (create user, update user, account aggregation, etc...)</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setResMappingObj-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setResMappingObj</h4>
|
|
<pre>void setResMappingObj(java.util.Map value)</pre>
|
|
<div class="block">Use this method to set the response mapping for the response attributes returned from the JSON response of the managed source.
|
|
<br>
|
|
The key would be the attribute name from the source account schema and the value would be the JSON path after the root path.
|
|
<pre>
|
|
{
|
|
"results": [
|
|
{
|
|
"fields": {
|
|
"id": "12345",
|
|
"name": "John Doe"
|
|
"email": "john.doe@sailpoint.com"
|
|
}
|
|
},
|
|
{
|
|
"fields": {
|
|
"id": "54321",
|
|
"name": "Jane Doe",
|
|
"email": "jane.doe@sailpoint.com"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
</pre>
|
|
Root path: $.results
|
|
<br>
|
|
Response Map
|
|
<pre>
|
|
{
|
|
"id": "fields.id",
|
|
"name": "fields.name",
|
|
"email": "fields.email"
|
|
}
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the mapping of account schema attribute to the JSON path value in the JSON response</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getResMappingObj--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getResMappingObj</h4>
|
|
<pre>void getResMappingObj()</pre>
|
|
<div class="block">Use this method to get the response mapping for the response attributes returned from the JSON response of the managed source.
|
|
<br>
|
|
The key would be the attribute name from the source account schema and the value would be the JSON path after the root path.
|
|
<pre>
|
|
{
|
|
"results": [
|
|
{
|
|
"fields": {
|
|
"id": "12345",
|
|
"name": "John Doe"
|
|
"email": "john.doe@sailpoint.com"
|
|
}
|
|
},
|
|
{
|
|
"fields": {
|
|
"id": "54321",
|
|
"name": "Jane Doe",
|
|
"email": "jane.doe@sailpoint.com"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
</pre>
|
|
Root path: $.results
|
|
<br>
|
|
Response Map
|
|
<pre>
|
|
{
|
|
"id": "fields.id",
|
|
"name": "fields.name",
|
|
"email": "fields.email"
|
|
}
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="setHeader-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setHeader</h4>
|
|
<pre>void setHeader(java.util.Map value)</pre>
|
|
<div class="block">Use this method to set the header values for the request
|
|
<pre>
|
|
//Set Header Content-Type
|
|
Map headerMap = requestEndPoint.getHeader();
|
|
headerMap.put("Content-Type", "application/json");
|
|
requestEndPoint.setHeader(headerMap);
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the map of http headers to send with the request</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getHeader--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHeader</h4>
|
|
<pre>void getHeader()</pre>
|
|
<div class="block">Use this method to get the header values for the request
|
|
<pre>
|
|
//Set Header Content-Type
|
|
Map headerMap = requestEndPoint.getHeader();
|
|
headerMap.put("Content-Type", "application/json");
|
|
requestEndPoint.setHeader(headerMap);
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="addHeader-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addHeader</h4>
|
|
<pre>void addHeader(java.lang.String entry,
|
|
java.lang.String value)</pre>
|
|
<div class="block">Use this method to add a header value to the existing http header map for the request
|
|
<pre>
|
|
requestEndPoint.addHeader("Authorization", "Bearer " + accessToken);
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>entry</code> - the key for the header</dd>
|
|
<dd><code>value</code> - the value for the header</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBody-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBody</h4>
|
|
<pre>void setBody(java.util.Map value)</pre>
|
|
<div class="block">Use this method to set the http payload information as a map.
|
|
<br>
|
|
The map must contain three keys <code>bodyFormat, bodyFormData, jsonBody</code>. The bodyFormat value can be <code>raw</code>
|
|
<br>
|
|
which means the user has provided values as a raw JSON string, otherwise the user has provided the value in the key,value format that must be converted into JSON</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the http payload map</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBody--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBody</h4>
|
|
<pre>void getBody()</pre>
|
|
<div class="block">Use this method to get the http payload information as a map.
|
|
<br>
|
|
The map contains three keys <code>bodyFormat, bodyFormData, jsonBody</code>.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setResponseCode-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setResponseCode</h4>
|
|
<pre>void setResponseCode(java.util.List value)</pre>
|
|
<div class="block">Use this method to set the value of successful response codes as a list (200,201,299). This will be respected by the connector.
|
|
<br>
|
|
If any other response codes are returned this would be considered as a request failure.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - the list of successful response code values</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getResponseCode--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getResponseCode</h4>
|
|
<pre>void getResponseCode()</pre>
|
|
<div class="block">Use this method to get the value of successful response codes as a list (200,201,299).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getAttributes--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAttributes</h4>
|
|
<pre>sailpoint.object.Attributes getAttributes()</pre>
|
|
<div class="block">Use this method to get all the available attributes</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAttribute-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getAttribute</h4>
|
|
<pre>java.lang.Object getAttribute(java.lang.String name)</pre>
|
|
<div class="block">Use this method to get the value of an attribute</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name of the attribute</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
</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><a href="../../../sailpoint/connector/webservices/WebServicesClient.html" title="interface in sailpoint.connector.webservices"><span class="typeNameLink">Next Class</span></a></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>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </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>
|