mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
20 lines
39 KiB
HTML
20 lines
39 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-idn docs-doc-id-docs/identity-now/docs">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.2.0">
|
||
<title data-rh="true">IdentityNow | SailPoint Developer Community</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://developer.sailpoint.com/idn/docs"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-idn-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-idn-current"><meta data-rh="true" property="og:title" content="IdentityNow | SailPoint Developer Community"><meta data-rh="true" name="description" content="This is the intoduction documentation to development on the IdentityNow platform."><meta data-rh="true" property="og:description" content="This is the intoduction documentation to development on the IdentityNow platform."><meta data-rh="true" name="keywords" content="IdentityNow,development,developer,portal,getting started,docs,documentation"><link data-rh="true" rel="icon" href="/img/SailPoint-Logo-Icon.ico"><link data-rh="true" rel="canonical" href="https://developer.sailpoint.com/idn/docs"><link data-rh="true" rel="alternate" href="https://developer.sailpoint.com/idn/docs" hreflang="en"><link data-rh="true" rel="alternate" href="https://developer.sailpoint.com/idn/docs" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://TB01H1DFAM-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-TSD78J",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script><link rel="stylesheet" href="/assets/css/styles.227fd7a0.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.94e2c36e.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.ea79317c.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script>
|
||
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-TSD78J" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" role="banner"><div class="announcementBarPlaceholder_vyr4"></div><div class="content_knG7 announcementBarContent_xLdY">Checkout our latest announcement in the SailPoint Developer Community Forum: <a target="_blank" rel="noopener noreferrer" href="https://developer.sailpoint.com/discuss/t/rule-java-docs-now-available-on-the-sailpoint-developer-community/10787">Introducing Rules Java Docs for IdentityNow!</a> 🎉</div><button type="button" aria-label="Close" class="clean-btn close closeButton_CVFx announcementBarClose_gvF7"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/SailPoint-Developer-Community-Lockup.png" alt="SailPoint Developer Community" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/SailPoint-Developer-Community-Inverse-Lockup.png" alt="SailPoint Developer Community" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">IdentityNow</a><ul class="dropdown__menu"><li><a href="#" class="dropdown__link navbar__section">API Specifications</a></li><li><a class="dropdown__link indent" href="/idn/api/v3">V3 APIs</a></li><li><a class="dropdown__link indent" href="/idn/api/beta">Beta APIs</a></li><li><a href="#" class="dropdown__link navbar__section">Documentation</a></li><li><a aria-current="page" class="dropdown__link indent dropdown__link--active" href="/idn/docs">IDN Documentation</a></li><li><a href="#" class="dropdown__link navbar__section">Tools</a></li><li><a class="dropdown__link indent" href="/idn/tools/cli">CLI</a></li><li><a class="dropdown__link indent" href="/idn/tools/sdk">SDKs</a></li><li><a href="#" class="dropdown__link navbar__section">External Links</a></li><li><a href="https://documentation.sailpoint.com" target="_blank" rel="noopener noreferrer" class="dropdown__link indent">Product Documentation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003041/true/xxemptyxx/" target="_blank" rel="noopener noreferrer" class="dropdown__link indent">IdentityNow Certifications<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">IdentityIQ</a><ul class="dropdown__menu"><li><a href="#" class="dropdown__link navbar__section">API Specifications</a></li><li><a class="dropdown__link indent" href="/iiq/api">IIQ APIs</a></li><li><a href="#" class="dropdown__link navbar__section">External Links</a></li><li><a href="https://documentation.sailpoint.com" target="_blank" rel="noopener noreferrer" class="dropdown__link indent">Product Documentation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003042/true/xxemptyxx/" target="_blank" rel="noopener noreferrer" class="dropdown__link indent">IdentityIQ Certifications<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">NERM</a><ul class="dropdown__menu"><li><a href="#" class="dropdown__link navbar__section">API Specifications</a></li><li><a class="dropdown__link indent" href="/nerm/api">NERM APIs</a></li><li><a href="#" class="dropdown__link navbar__section">External Links</a></li><li><a href="https://documentation.sailpoint.com" target="_blank" rel="noopener noreferrer" class="dropdown__link indent">Product Documentation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><a class="navbar__item navbar__link" href="/blog">Blog</a><a href="https://ideas.sailpoint.com" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Ideas</a><a href="https://developer.sailpoint.com/discuss/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Discuss</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Support</a><ul class="dropdown__menu"><li><a href="https://support.sailpoint.com/csm?id=sc_cat_item&sys_id=a78364e81bec151050bcc8866e4bcb5c&referrer=popular_items" target="_blank" rel="noopener noreferrer" class="dropdown__link">Submit Support Ticket<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://community.sailpoint.com" target="_blank" rel="noopener noreferrer" class="dropdown__link">Compass<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://status.sailpoint.com/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Platform Status<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><a href="https://github.com/sailpoint-oss" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="SailPoint Open-source GitHub"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item IdentityNow"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--active" aria-current="page" href="/idn/docs">IdentityNow</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed transforms"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/idn/docs/transforms">Transforms</a><button aria-label="Toggle the collapsible sidebar category 'Transforms'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed rules"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/idn/docs/rules">Rules</a><button aria-label="Toggle the collapsible sidebar category 'Rules'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed eventTriggers"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/idn/docs/event-triggers">Event Triggers</a><button aria-label="Toggle the collapsible sidebar category 'Event Triggers'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item saasConfiguration"><a class="menu__link" tabindex="0" href="/idn/docs/saas-configuration">SaaS Configuration</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed saasConnectivity"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/idn/docs/saas-connectivity">SaaS Connectivity</a><button aria-label="Toggle the collapsible sidebar category 'SaaS Connectivity'" type="button" class="clean-btn menu__caret"></button></div></li></ul></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_PEFL"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_kv0_"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_BDYx"><div class="docItemContainer_oq1c"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">IdentityNow</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><div class="row"><div class="col col--12"><p>🧭 There are many different ways in which you are able to extend the IdentityNow platform beyond what comes out of the box. Please, explore our documentation and see what is possible! This documentation assumes that you are a current customer or partner and already have access to the IdentityNow application.</p><div class="theme-admonition theme-admonition-info alert alert--info admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Are you a partner?</div><div class="admonitionContent_S0QG"><p>Looking to become a partner? If you are interested in becoming a partner, be it an ISV or Channel/Implementation partner, <a href="https://www.sailpoint.com/partners/become-partner/" target="_blank" rel="noopener noreferrer">click here</a>.</p></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="before-you-get-started">Before You Get Started<a class="hash-link" href="#before-you-get-started" title="Direct link to heading"></a></h2><p>Please read this introduction carefully, as it contains recommendations and need-to-know information pertaining to all features of the IdentityNow platform.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="authentication">Authentication<a class="hash-link" href="#authentication" title="Direct link to heading"></a></h3><p>Many of the interactions you have through our various features will have you interacting with our APIs either directly or indirectly. It would be valuable to familiarize yourself with <a href="/idn/api/authentication">Authentication</a> on our platform.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="understanding-json">Understanding JSON<a class="hash-link" href="#understanding-json" title="Direct link to heading"></a></h3><p>JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. JSON is at the heart of every API and development feature that SailPoint offers in IdentityNow—usually either inputs or outputs to/from a system. <a href="https://www.w3schools.com/js/js_json_intro.asp" target="_blank" rel="noopener noreferrer">Learn more about JSON here</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="understanding-webhooks">Understanding Webhooks<a class="hash-link" href="#understanding-webhooks" title="Direct link to heading"></a></h3><p>A webhook in web development is a method of augmenting or altering the behavior of a web page or web application with custom callbacks. These callbacks may be maintained, modified, and managed by third-party users and developers who may not necessarily be affiliated with the originating website or application. Our <a href="/idn/docs/event-triggers">Event Triggers</a> are a form of webhook, for example. <a href="https://zapier.com/blog/what-are-webhooks/" target="_blank" rel="noopener noreferrer">Learn more about webhooks here</a>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="recommended-technologies">Recommended Technologies<a class="hash-link" href="#recommended-technologies" title="Direct link to heading"></a></h2><p>While you can use whichever development tools you are most comfortable with or find most useful, we will recommend tools here for those that are new to development.</p><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_S0QG"><p>Our team, when developing documentation, example code/applications, videos, etc. will almost always use one of the tools listed below. We will soon add programming languages to this list!</p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="ides-integrated-development-environments">IDEs (Integrated Development Environments)<a class="hash-link" href="#ides-integrated-development-environments" title="Direct link to heading"></a></h3><p>IDEs are great for consolidating different aspects of programming into one tool. They're great for not only writing code, but managing your code as well. While you can use any IDE you feel is best fit for you and the task, here is what we use:</p><div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Windows</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Mac</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Linux</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><table><thead><tr><th>IDE</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">VS Code</a></td><td>VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like <a href="https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow" target="_blank" rel="noopener noreferrer">this one</a>!</td></tr><tr><td><a href="https://www.jetbrains.com/idea/" target="_blank" rel="noopener noreferrer">IntelliJ</a></td><td>If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>IDE</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">VS Code</a></td><td>VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like <a href="https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow" target="_blank" rel="noopener noreferrer">this one</a>!</td></tr><tr><td><a href="https://www.jetbrains.com/idea/" target="_blank" rel="noopener noreferrer">IntelliJ</a></td><td>If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>IDE</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">VS Code</a></td><td>VS Code is a lightweight IDE that we believe is perfect for development on our IdentityNow platform. We also have great plug-in support from our community, like <a href="https://marketplace.visualstudio.com/items?itemName=yannick-beot-sp.vscode-sailpoint-identitynow" target="_blank" rel="noopener noreferrer">this one</a>!</td></tr><tr><td><a href="https://www.jetbrains.com/idea/" target="_blank" rel="noopener noreferrer">IntelliJ</a></td><td>If you happen to be writing in Java or developing Rules on our platform, we typically recommend IntelliJ. While Java development can be done in VS Code, you will have an easier time using an IDE that was purpose-built for Java.</td></tr></tbody></table></div></div></div><hr><h3 class="anchor anchorWithStickyNavbar_LWe7" id="cli-environments">CLI Environments<a class="hash-link" href="#cli-environments" title="Direct link to heading"></a></h3><p>When interacting with our platform or writing code related to IdentityNow, we often use the CLI. While you can use any CLI that you feel is best fit for you and your job, here are the CLI environments we use and recommend:</p><div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Windows</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Mac</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Linux</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><table><thead><tr><th>CLI Tool</th><th>Description</th></tr></thead><tbody><tr><td>Windows PowerShell</td><td>Windows PowerShell is a modern terminal on windows (also available on Mac/Linux) that offers versatile CLI, task automation, and configuration management options.</td></tr><tr><td><a href="https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-us&gl=us" target="_blank" rel="noopener noreferrer">Windows Terminal</a></td><td>The Windows Terminal is a modern, fast, efficient, powerful, and productive terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and WSL. Its main features include multiple tabs, panes, Unicode and UTF-8 character support, a GPU accelerated text rendering engine, and custom themes, styles, and configurations. Terminal is just a more beautiful version of PowerShell 😁</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>CLI Tool</th><th>Description</th></tr></thead><tbody><tr><td>Mac Terminal (default)</td><td>On Mac, we recommend using the default terminal.</td></tr></tbody></table></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><table><thead><tr><th>CLI Tool</th><th>Description</th></tr></thead><tbody><tr><td>Linux Terminal (default)</td><td>On Linux, we recommend using the default terminal.</td></tr></tbody></table></div></div></div><hr><h3 class="anchor anchorWithStickyNavbar_LWe7" id="version-control">Version Control<a class="hash-link" href="#version-control" title="Direct link to heading"></a></h3><p>Writing code typically requires version control to adequately track changes in sets of files. While you can use any version control that you feel is best fit for you and your job, here are the version control tools that we use and recommend:</p><table><thead><tr><th>Version Control Tool</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://git-scm.com/" target="_blank" rel="noopener noreferrer">git</a></td><td>Git is a free and open-source, distributed version control system designed to handle everything from small to very large projects. Git runs locally on your machine.</td></tr><tr><td><a href="https://github.com" target="_blank" rel="noopener noreferrer">GitHub</a></td><td>GitHub is an internet hosting service for managing git in the cloud. We use GitHub on our team to collaborate amongst the other developers on our team, as well as with our community.</td></tr></tbody></table><hr><h3 class="anchor anchorWithStickyNavbar_LWe7" id="api-clients">API Clients<a class="hash-link" href="#api-clients" title="Direct link to heading"></a></h3><p>API clients make it easy to call APIs without having to first write code. API clients are great for testing and getting familiar with APIs to get a better understanding of what the inputs/outputs are and how they work.</p><table><thead><tr><th>API Client</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://www.postman.com/downloads/" target="_blank" rel="noopener noreferrer">Postman</a></td><td>Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="glossary">Glossary<a class="hash-link" href="#glossary" title="Direct link to heading"></a></h2><p>Identity is a complex topic and there are many terms used, and quite often! Please <a href="https://documentation.sailpoint.com/saas/help/common/glossary.html" target="_blank" rel="noopener noreferrer">refer to our glossary</a> whenever possible if you aren't sure what something means.</p></div></div></div><div class="col col--12"><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-tags-row row margin-bottom--sm"><div class="col"><b>Tags:</b><ul class="tags_jXut padding--none margin-left--sm"><li class="tag_QGVx"><a class="tag_zVej tagRegular_sFm0" href="/idn/tags/introduction">Introduction</a></li><li class="tag_QGVx"><a class="tag_zVej tagRegular_sFm0" href="/idn/tags/getting-started">Getting Started</a></li></ul></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/sailpoint-oss/developer-community-site/edit/main/products/idn/docs/identity-now/index.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Something wrong? Click here to edit this page.</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2023-07-24T14:01:45.000Z">Jul 24, 2023</time></b> by <b>Colin McKibben</b></span></div></div></footer></div></article><div class="col col--12"><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--next" href="/idn/docs/transforms"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Transforms</div></a></nav></div></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#before-you-get-started" class="table-of-contents__link toc-highlight">Before You Get Started</a><ul><li><a href="#authentication" class="table-of-contents__link toc-highlight">Authentication</a></li><li><a href="#understanding-json" class="table-of-contents__link toc-highlight">Understanding JSON</a></li><li><a href="#understanding-webhooks" class="table-of-contents__link toc-highlight">Understanding Webhooks</a></li></ul></li><li><a href="#recommended-technologies" class="table-of-contents__link toc-highlight">Recommended Technologies</a><ul><li><a href="#ides-integrated-development-environments" class="table-of-contents__link toc-highlight">IDEs (Integrated Development Environments)</a></li><li><a href="#cli-environments" class="table-of-contents__link toc-highlight">CLI Environments</a></li><li><a href="#version-control" class="table-of-contents__link toc-highlight">Version Control</a></li><li><a href="#api-clients" class="table-of-contents__link toc-highlight">API Clients</a></li></ul></li><li><a href="#glossary" class="table-of-contents__link toc-highlight">Glossary</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">IdentityNow</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/idn/api/getting-started">Your First API Call</a></li><li class="footer__item"><a class="footer__link-item" href="/idn/docs/transforms/guides/your-first-transform">Build A Transform</a></li><li class="footer__item"><a class="footer__link-item" href="/idn/docs/saas-connectivity">Build A SaaS Connector</a></li><li class="footer__item"><a href="https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003041/true/xxemptyxx/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Get Certified<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">IdentityIQ</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://documentation.sailpoint.com/identityiq/help/plugins/identityiq_plugins.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Build A Plugin</a></li><li class="footer__item"><a href="https://university.sailpoint.com/Saba/Web_spf/NA10P1PRD075/guest/categorydetail/categ000000000003042/true/xxemptyxx/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Get Certified<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://developer.sailpoint.com/discuss" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discuss</a></li><li class="footer__item"><a href="https://developer-sailpoint.ideas.aha.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Submit an Idea</a></li><li class="footer__item"><a href="https://developer.sailpoint.com/discuss/new-message?groupname=developer_relations" target="_blank" rel="noopener noreferrer" class="footer__link-item">Contact Our Team</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://medium.com/sailpointtechblog" target="_blank" rel="noopener noreferrer" class="footer__link-item">Engineering Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/sailpoint-oss" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/sailpoint" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Company</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.sailpoint.com/company/" target="_blank" rel="noopener noreferrer" class="footer__link-item">The SailPoint Story</a></li><li class="footer__item"><a href="https://www.sailpoint.com/company/diversity-inclusion-and-belonging/" target="_blank" rel="noopener noreferrer" class="footer__link-item">The SailPoint Way</a></li><li class="footer__item"><a href="https://www.sailpoint.com/company/#h-our-leadership" target="_blank" rel="noopener noreferrer" class="footer__link-item">Leadership Team</a></li><li class="footer__item"><a href="https://www.sailpoint.com/partners/become-partner/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Become A Partner</a></li></ul></div><div class="col footer__col"><div class="footer__title">Legal</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://developer.sailpoint.com/discuss/tos" target="_blank" rel="noopener noreferrer" class="footer__link-item">Terms & Conditions</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://developer.sailpoint.com" rel="noopener noreferrer" class="footerLogoLink_BH7S"><img src="/img/SailPoint-Developer-Community-Lockup.png" alt="SailPoint Developer Community Logo" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/SailPoint-Developer-Community-Inverse-Lockup.png" alt="SailPoint Developer Community Logo" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></a></div><div class="footer__copyright">Copyright © 2023 SailPoint Technologies, Inc. All Rights Reserved.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.94e2c36e.js"></script>
|
||
<script src="/assets/js/main.ea79317c.js"></script>
|
||
</body>
|
||
</html> |