Administration Guide
Configure and operate a running OpenIAM deployment — identities, access, connected applications, lifecycle, requests, governance, authentication, federation and day-to-day operations.
Applies to: OpenIAM 2026.8.1
What this is, and when you need it
OpenIAM is an identity and access management platform. It keeps one record per person, attaches entitlements to that record through container objects — roles, groups, organizations and resources — and then makes the outside world match by provisioning accounts to managed systems through connectors. Authentication decides who someone is; access decides what their record entitles them to; lifecycle delivers it; governance proves it was right. This guide is for the administrator or IAM engineer who configures and operates that platform once it is installed and healthy: someone who works in the Webconsole and SelfService, reads logs and audit records, writes the Groovy the product expects at its extension points, and edits property values. Almost everything you configure is one of four things — a property, a policy, a metadata type, or a Groovy script attached to an extension point — and most pages here are telling you which of the four you are editing.
Choose your outcome
Sign in for the first time and find out what my account may administer
Create, find, entitle, delegate or bulk-change users
Register, govern and approve non-human identities — service accounts, keys, bots, cloud workloads and AI agents
Model roles, groups, organizations, resources and entitlements
Connect an application, import identities, provision accounts or reconcile drift
Write a Groovy script, or put work on a schedule
Make access requestable, and decide who approves it
Open, update and close Jira or ServiceNow tickets when requests, users, provisioning or non-human identities change
Run certification campaigns — user access reviews, recertification, attestation — or segregation of duties
Score access for risk — tune the factors and policies, narrow a campaign by risk, read the reviewer badges
Give reviewers the context behind each line — who the person is, what the entitlement grants, what revoking it would do — and read an item's audit trail
Build a report from the Data Catalog, run it to CSV or Excel, schedule it and e-mail the file
Configure authentication, MFA, password policy or recovery
Let people sign in with no password at all — passwordless, phishing-resistant sign-in
Set up SAML, OAuth 2.0 or OpenID Connect with a SaaS application or another organization
Put an application that speaks no federation protocol behind OpenIAM sign-in
Get single sign-on into an application that has only a login form — form fill, credential injection, password vaulting
Configure mail, SMS, system settings, localization or configuration promotion
Capture and evidence a user's agreement to a policy — consent, privacy notice acceptance, consent withdrawal
Register purposes and lawful bases, publish privacy notices, record and look up consent per purpose, or make access depend on consent
Investigate a failure, find audit evidence, or run a maintenance operation
Ask a question in my own words
Look up an exact error message, log line or UI message
Look up a property key, an enumerated value or a shipped object
Stop a leaver's access: terminate them, deprovision their accounts, revoke what they hold and end their sessions
Or start from a symptom
The table above is written for somebody configuring something. If what you have is a symptom, start here instead.
A user cannot sign in, and all I have is their name
Somebody has left and their access has to stop, everywhere
One person's live sessions have to stop working now
I have the exact error message, log line or screen text
I saved a change and it had no effect
An operation reported success and nothing happened
Search cannot find a user who is definitely there
Membership is right and the user's effective access disagrees
Every scheduled task stopped at the same moment
A value I mapped never reaches the managed system
A request through the Access Gateway fails, loops or returns 404
A certification campaign is stuck and nobody can act on it
Audit and log timestamps are out by a whole number of hours
Start here
If you are new to OpenIAM, read these four, in this order, before you change anything.
Sign in and confirm your context — what your own account is actually allowed to administer, and which product and schema version you are on.
The OpenIAM object model — the object names every other page in this guide uses.
Where settings live — why a setting can be saved and still have no effect. This one page prevents most of the confusion new administrators run into.
Change configuration safely — the guide's single change, test and rollback standard, which task pages link to rather than restate.
Which release this describes
This guide describes OpenIAM 2026.8.1. Every page carries the release it was written and checked against, and the date a human last confirmed it, on its last line:
Applies to OpenIAM 2026.8.1. Last reviewed 3 September 2026.
Read that line before you act on a page whose values matter. If the release named there is behind the one you are running, the page is not necessarily wrong — it means nobody has re-confirmed it against your release, so treat its shipped defaults as claims to verify rather than facts to rely on. Where a specific behavior changed in a known release, the page says so at the point it matters — "ships disabled since 4.2.1.5", "renamed in 4.2.1.1", "deprecated as of 4.2.2" — and that inline statement is more precise than the page's own stamp.
Which guide owns the task
This guide owns Webconsole configuration and operation. Where a task belongs elsewhere, a page names the other guide as a prerequisite rather than duplicating it.
Install, upgrade or tune the platform, restart a service, change a container image or an orchestrator manifest
Install and register a connector, grant it permissions on the target, look up connector-specific fields and limits
Connector Configuration Guide
Complete the reviewer's or the employee's own click path
SelfService Guide
Author extension code against the Java APIs, build a compiled extension, or integrate through REST
Developer Guide
Select an installed connector, configure the managed system and policy map, run synchronization and provisioning, verify the target
This guide — Connect applications and automate lifecycle
How to tell a procedure worked
A Save message proves the configuration was accepted. It does not prove the outcome. An OpenIAM operation crosses a browser, a UI service, the ESB, a message broker, a connector and an external managed system, and each layer keeps its own record. Consequential procedures in this guide therefore name the evidence that proves the real result — the value read back, the audit action constant, the workflow or reconciliation history, the connector reply, or the account in the managed system — and where a result is asynchronous they name the terminal state to wait for rather than telling you to retry.
Last updated
Was this helpful?