SailPoint Reference hub

Where the concept and how-to modules teach, the reference module documents. It links out to the detailed object pages, API topics and syntax references so you can quickly confirm an attribute, a method or an endpoint.

The practical difference between a reference page and a lesson is what you arrive with. A lesson assumes you do not yet know the concept and builds it. A reference page assumes you do, and answers a narrow question quickly: what is this attribute called, what does this rule type receive, what does this element mean in an export. Reading reference material to learn a subject is slow and frustrating, and looking up a detail in a tutorial is worse.

• Links to every object page (Identity, Role, Application and more).
• Links to the API reference topics (REST, filtering, errors).
• Pointers to rule and XML syntax examples.
• A consistent place to look things up mid-build.

The pages themselves, so this hub is usable rather than descriptive:

• Objects, the identity, application, role, entitlement and certification objects and their attributes.
• Rules, the rule types, when each one runs and what is in scope inside it.
• XML, the object representation you will read and edit when configuration is exported.
• Java API, the classes and methods available from rules and custom code.
• Tasks, the scheduled tasks and what each one does.
• System configuration, the settings that apply across the installation.

Use reference material alongside the tutorials: learn a concept in its lesson, then come here (or to the linked object/API pages) to look up the exact detail while you build.

One caution that applies to all of it. Reference material describes what exists, not what your installation is configured to use. An attribute documented on the identity object may be empty in your system because nothing populates it, and a rule type that exists may not be in use anywhere. Checking your own configuration alongside the reference is the habit that stops a lookup becoming an incorrect assumption. See the identity concept for the model these pages document.

Reference material is only fast if you know which page to open, and the four most common questions each have one answer.

What attribute holds this? The object pages. Identity attributes, application attributes and entitlement attributes are all named there, and the name is what everything else refers to.

Why did this fire, or not fire? The rule reference. Each rule type runs at a defined point with a defined set of objects available to it, and most rule problems are a rule of the wrong type rather than wrong logic inside it.

What does this exported file mean? The XML reference. Configuration moves between environments as XML, so reading it is not optional once you are past a single instance.

How do I do this from code? The Java API reference, and the discipline here is to check whether the platform already does it before writing anything.

• Reading reference like a tutorial, start with the concept lessons first.
• Relying on memory for exact attributes when you can look them up.
• Ignoring version differences between IdentityIQ and Identity Security Cloud.

Version note: the third pitfall above deserves emphasis, because it is the one that wastes the most time. IdentityIQ and the cloud offering share vocabulary and do not share implementation, so an object name, a rule type or an API class documented for one frequently does not exist in the other. Establish which product you are working with before opening any reference page, and treat material that does not say which one it describes as unreliable.