# OpenIAM Documentation portal

## OpenIAM Documentation portal

- [OpenIAM Documentation](https://docs.openiam.com/readme.md): Product documentation for the OpenIAM identity platform — deploying it, designing with it, administering it, extending it, and using it.
- [Glossary](https://docs.openiam.com/glossary.md): Plain-English definitions of the terms and acronyms used across the OpenIAM documentation.
- [Getting started with OpenIAM](https://docs.openiam.com/getting-started-guide/getting-started.md): Take OpenIAM from two empty virtual machines to a working, verified identity-lifecycle proof of concept.
- [Prepare your lab](https://docs.openiam.com/getting-started-guide/prepare-your-lab.md): What to provision before installing: VM sizing, the Active Directory test area, and the service account.
- [Install OpenIAM from RPM](https://docs.openiam.com/getting-started-guide/install-openiam-rpm.md): Install the full OpenIAM stack on a single Linux VM with the RPM installer.
- [Enable HTTPS](https://docs.openiam.com/getting-started-guide/enable-https.md): Put a valid TLS certificate in front of OpenIAM and serve the portals over HTTPS.
- [Verify health and log in](https://docs.openiam.com/getting-started-guide/verify-and-first-login.md): Confirm every service is healthy, sign in for the first time, and create a break-glass administrator.
- [Identity lifecycle POC](https://docs.openiam.com/getting-started-guide/lifecycle.md): What the lifecycle proof of concept builds, its safety rules, and what must be true before you start.
- [Install the AD connector](https://docs.openiam.com/getting-started-guide/lifecycle/install-ad-connector.md): Install the Active Directory PowerShell connector on Windows and connect it to OpenIAM.
- [Connect OpenIAM to Active Directory](https://docs.openiam.com/getting-started-guide/lifecycle/connect-to-ad.md): Create the managed system that connects OpenIAM to your Active Directory test organizational unit.
- [Import AD groups](https://docs.openiam.com/getting-started-guide/lifecycle/import-groups.md): Import Active Directory groups into OpenIAM as entitlements.
- [Import users and group memberships](https://docs.openiam.com/getting-started-guide/lifecycle/import-users-and-memberships.md): Import existing Active Directory users and their group memberships into OpenIAM.
- [Provision a test account to AD](https://docs.openiam.com/getting-started-guide/lifecycle/provision-test-account.md): Create a user in OpenIAM and watch it provision out to Active Directory.
- [Deprovision by disabling](https://docs.openiam.com/getting-started-guide/lifecycle/deprovision-disable.md): Remove access by disabling the Active Directory account instead of deleting it.
- [POC checklist and cleanup](https://docs.openiam.com/getting-started-guide/lifecycle/poc-checklist-and-cleanup.md): Verify the lifecycle proof of concept end to end, then clean up the test objects.
- [Authentication and self-service](https://docs.openiam.com/getting-started-guide/authentication.md): How content providers, authentication providers, policies, and rules fit together.
- [Require MFA for one URL](https://docs.openiam.com/getting-started-guide/authentication/mfa-for-one-url.md): Require a one-time passcode on a single URL pattern without changing any other login.
- [Password policy and self-service reset](https://docs.openiam.com/getting-started-guide/authentication/password-policy-and-sspr.md): Set a password policy and let users reset their own password.
- [Federation](https://docs.openiam.com/getting-started-guide/federation.md): Choose a federation journey: OpenIAM as the identity provider, or as the service provider.
- [OpenIAM as IdP for Microsoft Entra ID](https://docs.openiam.com/getting-started-guide/federation/openiam-idp-entra.md): Make OpenIAM the identity provider for Microsoft Entra ID using SAML 2.0.
- [OpenIAM as IdP for Google Workspace](https://docs.openiam.com/getting-started-guide/federation/openiam-idp-google.md): Make OpenIAM the identity provider for Google Workspace using SAML 2.0.
- [Entra ID as IdP for OpenIAM](https://docs.openiam.com/getting-started-guide/federation/openiam-sp-entra.md): Let users sign in to OpenIAM with their Microsoft Entra ID credentials.
- [Google as IdP for OpenIAM](https://docs.openiam.com/getting-started-guide/federation/openiam-sp-google.md): Let users sign in to OpenIAM with their Google Workspace credentials.
- [Federation troubleshooting and recovery](https://docs.openiam.com/getting-started-guide/federation/troubleshooting.md): Diagnose and recover from a broken SAML federation, including lockout recovery.
- [Brand the portals](https://docs.openiam.com/getting-started-guide/brand-the-portals.md): Apply your own CSS to the OpenIAM login, Webconsole, and SelfService portals.
- [Where to go next](https://docs.openiam.com/getting-started-guide/where-to-go-next.md): Where to go after the proof of concept: production planning and the deeper guides.
- [Installation Guide](https://docs.openiam.com/installation/installation.md): Build an OpenIAM deployment — choose a route, provision for it, install, and verify.
- [Choose your route](https://docs.openiam.com/installation/choose-your-route.md): Pick the deployment route that matches your infrastructure, and see the pages it uses in order.
- [Scope and availability](https://docs.openiam.com/installation/scope-and-availability.md): What this release of the guide covers, what each deployment shape protects against, and what is out of scope.
- [Quick start — one host](https://docs.openiam.com/installation/one-host.md): Stand up a complete OpenIAM deployment on one host in an afternoon — the shortest path from a bare Enterprise Linux server to a console you can sign in to.
- [Quick start — Kubernetes](https://docs.openiam.com/installation/cluster.md): Deploy OpenIAM into a Kubernetes cluster you already run — the shortest Helm path from a prepared cluster to a console you can sign in to.
- [What you need](https://docs.openiam.com/installation/what-you-need.md): Hosts, operating system, memory, disk, network and the decisions to have ready before you begin.
- [Obtain the software](https://docs.openiam.com/installation/obtain-the-software.md): Get the package and its components onto the host, online or in an air-gapped environment.
- [RPM](https://docs.openiam.com/installation/rpm.md): Install OpenIAM from RPM packages — the three shapes available, and how to choose between them.
- [Single node](https://docs.openiam.com/installation/rpm/rpm-single-node.md): A complete OpenIAM deployment on one host — what it includes, when to choose it, and the order of the pages.
- [Prepare the host](https://docs.openiam.com/installation/rpm/rpm-single-node/prepare-the-host.md): Confirm the host meets the requirements and the prerequisites are in place, before anything is installed.
- [Use a remote database](https://docs.openiam.com/installation/rpm/rpm-single-node/use-a-remote-database.md): Run OpenIAM against your own database server — what to provision, what privileges are needed, and what changes in the installation.
- [Install](https://docs.openiam.com/installation/rpm/rpm-single-node/install.md): Install the package, configure the deployment, and run the initialization that builds every tier.
- [Install on a separate partition](https://docs.openiam.com/installation/rpm/rpm-single-node/separate-partition.md): OpenIAM installs into /usr/local/openiam on the root filesystem — how to put it on a different partition instead, and what the free-space check still reads.
- [Start and verify](https://docs.openiam.com/installation/rpm/rpm-single-node/start-and-verify.md): Confirm every tier is running and the console is reachable, so you can hand the deployment over with confidence.
- [Enable HTTPS](https://docs.openiam.com/installation/rpm/rpm-single-node/enable-https.md): Put your own certificate in front of the deployment and serve it over HTTPS.
- [First sign-in](https://docs.openiam.com/installation/rpm/rpm-single-node/first-sign-in.md): Sign in for the first time, set the administrator password, and tell OpenIAM the address it is published on — for a single node, three nodes or Kubernetes.
- [Configure](https://docs.openiam.com/installation/rpm/rpm-single-node/configure.md): The settings to review once the deployment is running, grouped by whether you must set them, should review them, or should leave them alone.
- [Add a connector](https://docs.openiam.com/installation/rpm/rpm-single-node/add-a-connector.md): Install and start a connector so OpenIAM can manage accounts in a target system.
- [Configure the reverse proxy](https://docs.openiam.com/installation/rpm/rpm-single-node/configure-the-reverse-proxy.md): How the bundled reverse proxy routes requests, the two directives that matter, and how to point it at services on other hosts.
- [Back up and restore](https://docs.openiam.com/installation/rpm/rpm-single-node/back-up-and-restore.md): What to back up beyond the database, how to back it up, and how to restore.
- [Ports](https://docs.openiam.com/installation/rpm/rpm-single-node/ports.md): What must be reachable on a single-node deployment — two ports for users, and everything else internal to the host.
- [Troubleshoot](https://docs.openiam.com/installation/rpm/rpm-single-node/troubleshoot.md): Symptom, meaning and action for the issues that come up during and after a single-node installation.
- [Three nodes](https://docs.openiam.com/installation/rpm/rpm-ha.md): A three-node OpenIAM cluster — what it gives you, what sits where, and the order of the pages.
- [Prepare the hosts](https://docs.openiam.com/installation/rpm/rpm-ha/prepare-the-hosts.md): Three hosts, name resolution, the inter-node firewall rules and the trust relationship the installation uses.
- [Install](https://docs.openiam.com/installation/rpm/rpm-ha/install.md): Install a three-node OpenIAM cluster from the first node — the cluster tooling, infra.conf, and the run that builds all three hosts.
- [The clustered tiers](https://docs.openiam.com/installation/rpm/rpm-ha/form-the-clusters.md): What the cluster build produced, tier by tier — how each is clustered, where it is configured, and the one command that confirms it.
- [Component load balancing](https://docs.openiam.com/installation/rpm/rpm-ha/component-load-balancing.md): HAProxy on every node — what each front end fronts, how the health checks work, how to change a port, and how to read the state when a backend is marked down.
- [Start and verify](https://docs.openiam.com/installation/rpm/rpm-ha/start-and-verify.md): Confirm all three nodes are serving, every tier is genuinely clustered, and the platform survives the loss of a node.
- [Configure the load balancer](https://docs.openiam.com/installation/rpm/rpm-ha/load-balancer.md): What to put in front of the three hosts, how to health-check them, and the session behavior to configure.
- [Ports](https://docs.openiam.com/installation/rpm/rpm-ha/ports.md): What must be reachable on a three-node deployment — two ports at the load balancer, and the matrix between the three hosts.
- [Troubleshoot](https://docs.openiam.com/installation/rpm/rpm-ha/troubleshoot.md): Symptom, meaning and action for a three-node cluster — including the checks that compare the three hosts against each other.
- [On AWS, Azure and OCI](https://docs.openiam.com/installation/rpm/cloud.md): What changes when you build OpenIAM on AWS, Azure or OCI, what stays the same, and which services you hand to the provider.
- [AWS](https://docs.openiam.com/installation/rpm/cloud/aws.md): Provision EC2 instances, storage, networking and a load balancer for an OpenIAM RPM deployment — single node or three nodes.
- [Azure](https://docs.openiam.com/installation/rpm/cloud/azure.md): Provision Azure virtual machines, storage, networking and a load balancer for an OpenIAM RPM deployment — single node or three nodes.
- [Managed databases](https://docs.openiam.com/installation/rpm/cloud/managed-databases.md): Which managed database services OpenIAM runs against on AWS, Azure and OCI, the parameters to set before you install, and how to answer the installation's prompts.
- [Upgrading OpenIAM on RPM](https://docs.openiam.com/installation/rpm/rpm-upgrade.md): Decide whether you are doing a minor or a major upgrade, then take the checks that apply to both before you start.
- [Minor upgrade](https://docs.openiam.com/installation/rpm/rpm-upgrade/minor-upgrade.md): A point upgrade inside your current release line — set two variables, run one command, with an offline route for hosts without internet access.
- [Major upgrade](https://docs.openiam.com/installation/rpm/rpm-upgrade/major-upgrade.md): Crossing from the 4.2.1 line onto the 2026 line — a supported upgrade with a database migration script, run against a single node or a three-node cluster — with the pre-checks, the go decision and the
- [Release-specific steps](https://docs.openiam.com/installation/rpm/rpm-upgrade/release-specific-steps.md): Releases that need more than the standard procedure — a database to provision, a service to deploy, an Oracle grant to make, or Groovy imports to update.
- [After a major upgrade](https://docs.openiam.com/installation/rpm/rpm-upgrade/after-a-major-upgrade.md): What to put right once a major upgrade completes — Groovy scripts now live in the database, certification schedules were renamed, and customizations need reapplying.
- [Kubernetes](https://docs.openiam.com/installation/kubernetes.md): Deploy OpenIAM to Kubernetes — which route to take, what the deployment includes, and what it does and does not protect against.
- [Prepare the cluster](https://docs.openiam.com/installation/kubernetes/prepare-the-cluster.md): What any Kubernetes cluster must provide before OpenIAM is deployed into it — capacity, storage, node settings, egress and the database.
- [Deploy with Helm](https://docs.openiam.com/installation/kubernetes/deploy-with-helm.md): Deploy OpenIAM into a prepared Kubernetes cluster with Helm — settings, credentials, storage, the deployment run, the published entry point and safe re-runs.
- [Amazon EKS](https://docs.openiam.com/installation/kubernetes/amazon-eks.md): Create and prepare an Amazon EKS cluster for OpenIAM — node sizing, EBS and EFS storage, node settings, and the entry point.
- [Azure AKS](https://docs.openiam.com/installation/kubernetes/azure-aks.md): Create and prepare an Azure AKS cluster for OpenIAM — node sizing, disk and file storage, node settings, and the entry point.
- [Amazon EKS with Terraform](https://docs.openiam.com/installation/kubernetes/terraform-eks.md): Provision an EKS cluster, a managed database and an OpenIAM deployment on AWS with Terraform — the recommended route for a new AWS environment.
- [Azure AKS with Terraform](https://docs.openiam.com/installation/kubernetes/terraform-aks.md): Provision an AKS cluster, a managed database and an OpenIAM deployment on Azure with Terraform — the recommended route for a new Azure environment.
- [Add a connector](https://docs.openiam.com/installation/kubernetes/add-a-connector.md): Turn on a connector in a Kubernetes deployment so OpenIAM can manage accounts in a target system.
- [Verify a Kubernetes deployment](https://docs.openiam.com/installation/kubernetes/verify.md): Confirm a Kubernetes deployment is genuinely running — releases, pods, jobs, storage, every tier, and the published address.
- [Back up and restore](https://docs.openiam.com/installation/kubernetes/back-up-and-restore.md): Back up a Kubernetes deployment and restore it — the database, the deployment secret, the secret store, the volumes and the configuration, with the commands for each.
- [Troubleshoot](https://docs.openiam.com/installation/kubernetes/troubleshoot.md): Symptom, meaning and action for an OpenIAM deployment on Kubernetes.
- [Upgrading OpenIAM in Kubernetes](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade.md): Decide whether you are doing a minor or a major upgrade of a Kubernetes deployment, then take the checks that apply to both before you start.
- [Minor upgrade](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade/minor-upgrade.md): A point upgrade inside your current release line — set the version, check out the matching tag, and re-run the deployment.
- [Major upgrade](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade/major-upgrade.md): Crossing from the 4.2.1 line onto the 2026 line on Kubernetes, by building a new environment beside the old one and restoring into it — with the verification, the cut-over gate and the sign-off for ru
- [Release-specific steps](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade/release-specific-steps.md): Releases that need more than the standard redeploy — a database to provision before you start, a one-shot migration flag, an Oracle grant to make, or Groovy imports to update.
- [After a major upgrade](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade/after-a-major-upgrade.md): What to put right once a major upgrade completes — Groovy scripts now live in the database, certification schedules were renamed, and customizations need reapplying.
- [System requirements](https://docs.openiam.com/installation/system-requirements.md): Supported operating systems, CPU, memory and disk per deployment shape, supported database platforms, and the component versions OpenIAM ships.
- [Settings](https://docs.openiam.com/installation/settings.md): Every setting the installation procedures use, what it controls, and whether it can change after the deployment is built.
- [Configuration tuning reference](https://docs.openiam.com/installation/tuning.md): The cache, batch, pool and rate-limit properties OpenIAM exposes for tuning, with their shipped defaults and the property file each one lives in.
- [Commands](https://docs.openiam.com/installation/commands.md): The openiam-cli command surface, plus the systemd units and log locations behind it.
- [Diagnostics](https://docs.openiam.com/installation/diagnostics.md): Establish what is wrong before you ask anyone — a health snapshot, a symptom index, and the one script that collects everything a support case needs.
- [Solution Architecture and Design Guide](https://docs.openiam.com/solution-architecture/solution-architecture.md): Choose how OpenIAM fits the estate you already have — authoritative sources, identity correlation, where authentication lives, how access is governed, and how OpenIAM coexists with a platform you are
- [Frame](https://docs.openiam.com/solution-architecture/frame.md): What OpenIAM is made of, why it is made of several parts, and which deployment shape fits the estate you are designing for.
- [The OpenIAM architecture](https://docs.openiam.com/solution-architecture/frame/architecture.md): What OpenIAM is made of, what each component holds and serves, which components hold a system of record, and exactly what degrades versus what stops when one of them is unavailable.
- [Deployment shapes at a glance](https://docs.openiam.com/solution-architecture/frame/deployment-shapes.md): The three families of OpenIAM deployment — single node, high availability, and high availability with distributed or managed services — and the thresholds that move a design from one to the next.
- [Identity foundation](https://docs.openiam.com/solution-architecture/identity.md): The decisions that settle what a person is in your estate — which feeds may assert a person exists, what value links their accounts, what identifier the enterprise uses, and which populations the desi
- [Choosing your authoritative sources](https://docs.openiam.com/solution-architecture/identity/authoritative-sources.md): Decide which systems are allowed to assert that a person exists, has changed or has left — one HR system or several, what happens when two sources disagree, and who owns the populations HR does not.
- [Identity correlation: choosing a matching key](https://docs.openiam.com/solution-architecture/identity/correlation-key.md): Choose the value that links a person's accounts across every directory, application and feed — why it is a trusted workforce identifier and never a username, what OpenIAM can actually match on, and wh
- [Choosing the enterprise unique identifier](https://docs.openiam.com/solution-architecture/identity/unique-identifier.md): Decide what the enterprise identifier actually is — a payroll employee number, a synthetic identifier you mint, or a composite — why large organizations invent their own, and why identifiers need not
- [One person, many accounts](https://docs.openiam.com/solution-architecture/identity/one-person-many-accounts.md): Decide how a person's several accounts are represented — one identity with an account per managed system, separate records linked as related accounts for privileged access, and where service and non-h
- [Designing for every population](https://docs.openiam.com/solution-architecture/identity/populations.md): Design for every population the estate actually contains — employees, contractors, seasonal returners, contractor-to-employee conversions, partners, customers and non-human identities — on the basis t
- [Authentication and access](https://docs.openiam.com/solution-architecture/access.md): The decisions that settle how people prove who they are and how they reach applications — where authentication lives, what happens to passwords, how each application is integrated, and where a user st
- [Where authentication should live](https://docs.openiam.com/solution-architecture/access/where-authentication-lives.md): Decide who verifies the credential when a user signs in — OpenIAM itself, an existing federation service such as ADFS, or the directory itself — and why delegating each sign-in back to Active Director
- [Password strategy](https://docs.openiam.com/solution-architecture/access/password-strategy.md): Decide whether passwords are synchronized, federated or both — which direction they travel, what the Active Directory password filter costs you, and which accounts are in scope.
- [Choosing an SSO approach per application](https://docs.openiam.com/solution-architecture/access/sso-approach-per-application.md): Choose an integration per application — a modern protocol, an existing federation service, the Access Gateway, form fill — and recognize the applications this release cannot integrate directly.
- [Entry points and the user's experience](https://docs.openiam.com/solution-architecture/access/entry-points.md): Decide where a user starts — a portal, a bookmark or a deep link — and whether sign-in is initiated at the application or at OpenIAM, on the principle that the design should work the way users already
- [Governance design](https://docs.openiam.com/solution-architecture/governance.md): The programme decisions behind governance — what a role is for and how deep the catalog goes, which mechanism grants which access, which rules belong at request time instead, what a certification pr
- [Designing the role model](https://docs.openiam.com/solution-architecture/governance/role-model.md): Which OpenIAM object should carry which idea — role, group, organization or resource — how deep a hierarchy is defensible, when not to build a role at all, and what designing a catalog costs in a re
- [How access gets granted](https://docs.openiam.com/solution-architecture/governance/how-access-is-granted.md): The four ways access reaches a person in OpenIAM — birthright, role-derived, rule-driven and requested — what each costs to design and to run, the two scheduled jobs that decide whether the design is
- [Deciding access at request time](https://docs.openiam.com/solution-architecture/governance/request-time-policy.md): Whether any of your access rules belong at request time rather than in the entitlement model — what a policy can express that a role cannot, what it costs to run, and what this release decides with on
- [Designing a certification programme](https://docs.openiam.com/solution-architecture/governance/certification-programme.md): Designing an access certification programme — which campaign types to run, on what cadence, over what scope, resolved to which reviewers, and what the resulting evidence has to prove to somebody who w
- [Designing a segregation-of-duties programme](https://docs.openiam.com/solution-architecture/governance/sod-programme.md): Starting a segregation-of-duties programme — which conflicts to encode first, the draft-shadow-enforce progression that keeps it from blocking the business, how thresholds and risk classification actu
- [Coexistence and migration](https://docs.openiam.com/solution-architecture/coexistence.md): Running OpenIAM alongside a governance platform you are not replacing yet — who writes, who only reads, where a request lives, how lifecycle crosses the boundary, and how the arrangement ends.
- [Coexisting with an incumbent IGA](https://docs.openiam.com/solution-architecture/coexistence/coexisting-with-an-incumbent-iga.md): The single-writer rule — exactly one platform decides and executes for a given application at a time. What that buys, what it forbids, and how to decide which platform owns which application during th
- [The enterprise view without duplicate governance](https://docs.openiam.com/solution-architecture/coexistence/the-enterprise-view.md): Read-only synchronization of another platform's access data — what a unified view can answer, what OpenIAM can actually ingest and represent, and how to stop visibility becoming a second set of govern
- [Where a request lives when two catalogs exist](https://docs.openiam.com/solution-architecture/coexistence/where-a-request-lives.md): When two catalogs exist, the request stays with the application owner — the user crosses the federation bridge, the request does not. One catalog, one approval policy, one connector, one provision
- [Lifecycle events across a governance boundary](https://docs.openiam.com/solution-architecture/coexistence/lifecycle-across-a-governance-boundary.md): Leavers and transfers when two platforms govern two halves of an estate — who detects, who acts, what the other platform mirrors, and the mutations a joiner-and-leaver design will not survive.
- [Cross-organization federation](https://docs.openiam.com/solution-architecture/coexistence/cross-organization-federation.md): Trust between two identity providers — why each direction is a separate decision, why the identifiers on the two sides need not match, and why synchronization is the basis for the identity with just-i
- [Planning a wave migration](https://docs.openiam.com/solution-architecture/coexistence/planning-a-wave-migration.md): Choosing the order applications migrate in, what a wave contains, how to validate one, how write ownership actually moves for a single application, and how the incumbent is retired.
- [Integration: reaching the estate](https://docs.openiam.com/solution-architecture/integration.md): How OpenIAM reaches each system in the estate — which integrate through a shipped connector, which through a generic one, which through a human task, and where the connector processes physically run w
- [Connector strategy: how each system is reached](https://docs.openiam.com/solution-architecture/integration/connector-strategy.md): How each system in the estate integrates — what to inventory before choosing anything, when a shipped connector, a scripted connector, a custom source adapter or a human task is the right answer, and
- [Connector placement](https://docs.openiam.com/solution-architecture/integration/connector-placement.md): Where connector processes physically run — how one deployment reaches several networks, what a cloud-hosted platform needs in order to reach on-premise targets, which integrations genuinely need a Win
- [Deployment architecture, scale and environments](https://docs.openiam.com/solution-architecture/deployment.md): The deployment decisions that come before anyone builds anything — which of the nine shipped topologies fits, what your cloud platform will and will not run for you, where the network boundaries fall,
- [Choosing a topology](https://docs.openiam.com/solution-architecture/deployment/choosing-a-topology.md): The nine shipped OpenIAM topologies, what each one costs and buys, and what moves a design from one to the next — availability target first, batch profile second, and why population is not the thresho
- [RPM topologies](https://docs.openiam.com/solution-architecture/deployment/rpm-topologies.md): The four packaged-Linux topologies — single instance, small HA, medium HA with distributed services, and large HA with a separated console tier — and what each one separates from what.
- [Topologies using cloud platform services](https://docs.openiam.com/solution-architecture/deployment/platform-service-topologies.md): The three topologies that substitute cloud platform services for part of OpenIAM's stateful tier — which components you hand away, what that changes, and what you still operate yourself.
- [Kubernetes topologies](https://docs.openiam.com/solution-architecture/deployment/kubernetes-topologies.md): The two shipped Kubernetes shapes — a single-worker non-production cluster and a three-worker production cluster — what each assumes, what OpenShift adds, and what Kubernetes does not buy you.
- [Platform support matrix](https://docs.openiam.com/solution-architecture/deployment/platform-support-matrix.md): What AWS, Azure and Google Cloud will run for you and what you still operate yourself — built from the shipped infrastructure modules, including the three gaps that change a design.
- [Network zones and traffic flow](https://docs.openiam.com/solution-architecture/deployment/network-design.md): Where each component sits relative to your network boundaries and what may reach it from where — the one thing that may be published, the things that must never be, the broker's genuine judgement call
- [Sizing](https://docs.openiam.com/solution-architecture/deployment/sizing.md): What actually drives load in an OpenIAM deployment, what to measure before committing to node sizes, and how to read the published reference figures — including which of them are guarantees and which
- [Where load lands](https://docs.openiam.com/solution-architecture/deployment/where-load-lands.md): Which components carry each workload, which work partitions across replicas and which is cluster-serialised by design, what the shipped scheduled work actually is, and what saturation looks like when
- [Availability and recovery](https://docs.openiam.com/solution-architecture/deployment/availability-and-recovery.md): What each topology survives, what it does not, and what a recoverable backup has to cover — including the one component holding state that a database restore will not bring back.
- [Environments and tenancy](https://docs.openiam.com/solution-architecture/deployment/environments-and-tenancy.md): How many environments a programme needs, what moves between them and what must never move — and when to use a virtual tenant, with what organization scoping does and does not isolate.
- [Taking a new release](https://docs.openiam.com/solution-architecture/deployment/upgrade-strategy.md): How this estate takes a new release — the two upgrade paths and how they differ, what the downtime honestly is, why the rollback plan is a database backup nothing takes for you, and what an upgrade do
- [Programme and sequencing](https://docs.openiam.com/solution-architecture/programme.md): The decisions about order rather than architecture — why identity lifecycle is established before single sign-on, what belongs in a first phase and what should be deferred, and how the platform's evid
- [Sequence: lifecycle before SSO](https://docs.openiam.com/solution-architecture/programme/sequence.md): Why identity lifecycle and governance are established before single sign-on, what goes wrong when the order is inverted, and the four situations where federating first is genuinely the right call.
- [Phasing a rollout](https://docs.openiam.com/solution-architecture/programme/phasing-a-rollout.md): What belongs in the first phase of an OpenIAM rollout, how to choose the applications that go in it, what to defer without leaving the phase incoherent, and how to tell whether the phase actually fini
- [Operating in a regulated environment](https://docs.openiam.com/solution-architecture/programme/regulated-environments.md): What OpenIAM genuinely provides towards a regulated organization's controls — audit trail, certification evidence, approval records, SoD detection — and what the organization must do itself, stated as
- [Reference architectures](https://docs.openiam.com/solution-architecture/reference-architectures.md): Three worked designs — several Active Directory forests, coexistence with an incumbent IGA, and federation between two organizations — each a starting point to adapt rather than a prescription to foll
- [One organization, several Active Directory forests](https://docs.openiam.com/solution-architecture/reference-architectures/single-organization-multi-forest.md): One organization whose people and applications are spread across several Active Directory forests, with OpenIAM as the identity provider — the correlation key, per-forest accounts, and how a user in o
- [Coexistence with an incumbent IGA](https://docs.openiam.com/solution-architecture/reference-architectures/coexistence-with-incumbent-iga.md): OpenIAM running alongside an incumbent identity governance platform through a phased migration — the single-writer rule, read-only synchronization for the enterprise view, and migrating applications i
- [Cross-organization federation](https://docs.openiam.com/solution-architecture/reference-architectures/cross-organization-federation.md): Two organizations that stay separate, each with its own identity provider, federated in both directions — which platform authenticates, which authorizes, and what a federation assertion does and does
- [Administration Guide](https://docs.openiam.com/administration-guide/admin.md): Configure and operate a running OpenIAM deployment — identities, access, connected applications, lifecycle, requests, governance, authentication, federation and day-to-day operations.
- [Start administering OpenIAM](https://docs.openiam.com/administration-guide/start.md): Route yourself into the guide — confirm what your account may administer, learn the object names, find out where a setting's value comes from, and adopt the change standard.
- [Sign in and confirm your context](https://docs.openiam.com/administration-guide/start/first-login.md): Sign in to the Webconsole, establish what your account can actually administer, and confirm the version and configuration layer before your first change.
- [The OpenIAM object model](https://docs.openiam.com/administration-guide/start/object-model.md): The objects OpenIAM administration is made of — users, identities, resources, roles, groups, organizations, entitlements, managed systems, content providers, policies and metadata — each anchored to t
- [Where settings live](https://docs.openiam.com/administration-guide/start/where-settings-live.md): The four places an OpenIAM setting can come from, which one wins, and how to find the effective value.
- [Change configuration safely](https://docs.openiam.com/administration-guide/start/change-safely.md): The change, test and rollback standard every procedure in this guide assumes — stated once, here.
- [Manage identities](https://docs.openiam.com/administration-guide/identities.md): Create, find, change the state of, entitle and delegate administration of users — and shape the forms and rules that govern how identities are captured.
- [Create a user](https://docs.openiam.com/administration-guide/identities/create-a-user.md): Create a user record in the Webconsole on either of the two creation routes, and confirm the user has an identity and is findable in search.
- [Find a user](https://docs.openiam.com/administration-guide/identities/find-a-user.md): Search for a user in the Webconsole, diagnose the case where the user exists but search cannot find them, and change which columns and criteria the search screen offers.
- [Run a user lifecycle action](https://docs.openiam.com/administration-guide/identities/user-lifecycle-actions.md): Deactivate, delete, enable, disable, activate, terminate, mark deceased or put a user on leave — immediately or on a future date — and prove the change reached the managed systems.
- [Grant and revoke access](https://docs.openiam.com/administration-guide/identities/grant-and-revoke-access.md): Grant or revoke a role, group, resource or organization on a user from the Webconsole, and prove the change reached the managed system.
- [Manage related accounts](https://docs.openiam.com/administration-guide/identities/related-accounts.md): Link a privileged or non-production user record to the person who owns it.
- [Resolve orphan accounts](https://docs.openiam.com/administration-guide/identities/resolve-orphan-accounts.md): Triage the orphan accounts a reconciliation found on a managed system — link them to a user, convert them to a new user, or delete them deliberately.
- [Scope a delegated administrator](https://docs.openiam.com/administration-guide/identities/delegated-administration.md): Scope an administrator to a population with delegation filters, and understand the three other mechanisms — organization scope, subordinate checks and association types — that decide what they can rea
- [Impersonate a user](https://docs.openiam.com/administration-guide/identities/impersonate-a-user.md): Start a Webconsole session as another user to see exactly what they see, and grant that ability with the PBAC policy it now requires.
- [Grant access to user administration](https://docs.openiam.com/administration-guide/identities/grant-user-administration.md): Grant administrators access to a user's profile, challenge responses, related accounts, IT policy consent history and delegation filter in Webconsole, with the PBAC policy those screens now require.
- [Change many users at once](https://docs.openiam.com/administration-guide/identities/bulk-operations.md): Run a bulk operation over a searched population of users, knowing exactly which accounts are protected, what select-all really selects, and why there is no undo.
- [Build a page template](https://docs.openiam.com/administration-guide/identities/page-templates-and-custom-fields.md)
- [Page template reference](https://docs.openiam.com/administration-guide/identities/page-templates-and-custom-fields/page-template-reference.md): The page-template and custom-field objects, the six template types, the eleven field types, the eight conditional-rule actions, pre-population from the requester, the data-model settings and the three
- [Add a custom user page to SelfService](https://docs.openiam.com/administration-guide/identities/add-a-selfservice-user-page.md): Give one audience a purpose-built SelfService page that edits a slice of the user record, on its own URI pattern, visible only to the role you entitle.
- [Configure self-registration](https://docs.openiam.com/administration-guide/identities/self-registration.md): Build a multi-step self-registration workflow with a page template per step, split the shipped template so internal fields are not exposed publicly, and replace the accept-everybody sponsor validator.
- [Convert a user's type](https://docs.openiam.com/administration-guide/identities/convert-a-user-type.md): Convert a user from one user type to another — optionally merging a second record's access in the same operation — and replace the shipped conversion script that does nothing.
- [Manage non-human identities](https://docs.openiam.com/administration-guide/nhi.md): Manage non-human identities — service accounts, API keys, bots, cloud workloads and AI agents — in one governed inventory: register them, give each a human owner and an expiry, take them through an ap
- [Browse the inventory](https://docs.openiam.com/administration-guide/nhi/inventory.md): Browse, search and filter every non-human identity in the tenant from one server-paged table, and read the health and expiry summary at the top.
- [Register a non-human identity](https://docs.openiam.com/administration-guide/nhi/register-an-nhi.md): Create a non-human identity as a Draft — choose its type, name a human owner, set an expiry, declare its purpose, and fill the fields the type requires.
- [Lifecycle and status](https://docs.openiam.com/administration-guide/nhi/lifecycle.md): The five statuses a non-human identity moves through — Draft, Pending Approval, Active, Suspended, Decommissioned — the transitions allowed between them, and what an identity must have before it can g
- [Request and approve registration](https://docs.openiam.com/administration-guide/nhi/request-and-approval.md): Send a Draft non-human identity through an approval workflow — how a request is routed to an approver, and how an approver reviews the identity and approves or rejects it.
- [Configure approver routing](https://docs.openiam.com/administration-guide/nhi/approver-routing.md): Decide who approves a non-human identity registration, by environment and type — add, edit and delete approver routes, and set the default that catches everything else.
- [Synchronize from a data source](https://docs.openiam.com/administration-guide/nhi/csv-synchronization.md): Load and enrich many non-human identities from a data source using OpenIAM's synchronization engine, with Non-Human Identity as the object type.
- [Access policies for NHIs](https://docs.openiam.com/administration-guide/nhi/access-policies.md): Control who may register, activate, re-scope or retire a non-human identity with policy-based access control — the NHI resource, its management actions, and how the enforcement fails closed.
- [Health and governance](https://docs.openiam.com/administration-guide/nhi/governance.md): How a non-human identity's health score is calculated, what the scheduled governance jobs do — auto-suspend at expiry, dormancy and expiry warnings, critical-health alerts — and where to read an ident
- [Model and grant access](https://docs.openiam.com/administration-guide/access.md): Entitlement management in OpenIAM — model access with roles, groups, organizations and resources, grant it automatically with business rules, and route requests with content providers.
- [The access model](https://docs.openiam.com/administration-guide/access/access-model.md): How OpenIAM represents access — roles, groups, organizations, resources, access rights, entitlements and the authorization graph — with the real type identifiers.
- [Create a role](https://docs.openiam.com/administration-guide/access/create-a-role.md): Create a role on the shipped form, set its owner, parent and limits, and prove one test user gains the access before you activate it.
- [Manage roles and groups](https://docs.openiam.com/administration-guide/access/manage-roles-and-groups.md): Add and remove members, nest roles and groups, set effective dates that actually take effect, and compare two roles before you change one.
- [Role and group field reference](https://docs.openiam.com/administration-guide/access/manage-roles-and-groups/role-and-group-reference.md): Every field on the shipped role and group forms, which template flags the forms actually honour, and the 23-column entitlement CSV header.
- [Role engineering and maintenance](https://docs.openiam.com/administration-guide/access/role-engineering.md): Build and maintain a role catalog using the tools OpenIAM actually ships — role compare, entitlement CSV import, bulk operations, membership tags, risk scoring and business rules.
- [Business roles](https://docs.openiam.com/administration-guide/access/business-roles.md): Business roles — a named business function that bundles IT roles, groups and resources, has an accountable business owner, is versioned and published by administrators directly or after the owner appr
- [Resources and organizations](https://docs.openiam.com/administration-guide/access/resources-and-organizations.md): The 19 shipped resource types with their real hierarchy, search and provisioning flags, and the organization model with its containment rules and seven shipped properties.
- [Import an organization hierarchy from CSV](https://docs.openiam.com/administration-guide/access/resources-and-organizations/import-organizations-from-csv.md): Load a whole organization hierarchy from one CSV file using the shipped CSV ORG Example configuration, including the PARENT column the sample header leaves out.
- [Build a business rule](https://docs.openiam.com/administration-guide/access/business-rules.md): Build a business rule end to end, with three complete worked rules you can adapt and the recalculation that ships disabled.
- [Business rule reference](https://docs.openiam.com/administration-guide/access/business-rules/business-rule-reference.md): The business-rule object, every condition attribute and operator, what each of the 27 actions actually does, the Groovy contracts and six worked patterns.
- [Content providers and URI patterns](https://docs.openiam.com/administration-guide/access/content-providers-and-uri-patterns.md): How OpenIAM decides which content provider and URI pattern answer a request, what the entitlement check really checks, and the three inheritance rules that surprise people.
- [Content provider and URI pattern reference](https://docs.openiam.com/administration-guide/access/content-providers-and-uri-patterns/content-provider-reference.md): Every field on the content provider and URI pattern screens, the shipped defaults, the DEFAULT\_CP seed with its 29 URI patterns, and the menu root properties.
- [Connect applications and automate lifecycle](https://docs.openiam.com/administration-guide/lifecycle.md): Connect an application to OpenIAM and automate the identity lifecycle — joiner, mover and leaver processing, account creation, attribute updates, imports, drift detection and retirement — in the order
- [Choose an onboarding pattern](https://docs.openiam.com/administration-guide/lifecycle/onboarding-patterns.md): Choose between connected provisioning, manual fulfilment, SSO-only and authoritative-source onboarding by what each pattern actually requires in OpenIAM.
- [Connectors and managed systems](https://docs.openiam.com/administration-guide/lifecycle/connectors-and-managed-systems.md): How a connector package, a connector definition and a managed system relate — the queue naming, the dynamic-field mechanism, and how to tell a runtime fault from a configuration fault.
- [Configure a managed system](https://docs.openiam.com/administration-guide/lifecycle/configure-managed-system.md): Create a managed system — which connector, the fields that matter, the credential, save, activate, then capture the first operation before anything reaches the target.
- [Verify connectivity to the target](https://docs.openiam.com/administration-guide/lifecycle/verify-connection.md): Prove a connector can actually reach its target — read the connector status, then the reply, then the target itself, and know what a green chip does not prove.
- [Build a policy map](https://docs.openiam.com/administration-guide/lifecycle/policy-map.md): Map the attributes a managed system needs, test one against a disposable user, and save.
- [Policy map reference](https://docs.openiam.com/administration-guide/lifecycle/policy-map/policy-map-reference.md): How OpenIAM evaluates a policy-map row, the script contract, the worked Active Directory map, and the connector behavior behind a row that does not arrive.
- [Configure provisioning](https://docs.openiam.com/administration-guide/lifecycle/configure-provisioning.md): Configure the chain that turns a saved identity change into a target account, prove each outcome from the audit log, and recover a failed request.
- [Attach a provisioning processor](https://docs.openiam.com/administration-guide/lifecycle/provisioning-processors.md): Attach a Groovy pre- or post-processor to one managed system, prove it ran, and take it off again.
- [Provisioning processor reference](https://docs.openiam.com/administration-guide/lifecycle/provisioning-processors/provisioning-processor-reference.md): The provisioning processor contract — the nine methods, what a processor may read, operation routing, the global scripts, the mutation rules and the user save lock.
- [Configure reconciliation](https://docs.openiam.com/administration-guide/lifecycle/configure-reconciliation.md): Run a reconciliation between OpenIAM and a managed system report-only first, read the CSV it produces, and only then let it act.
- [Reconciliation scripts](https://docs.openiam.com/administration-guide/lifecycle/reconciliation-scripts.md): The real Groovy contracts for reconciliation — population, query, match, custom command and pre/post-processor — with the signatures and packages that actually compile.
- [Set up a synchronization](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data.md): Create a synchronization configuration for an HR, directory, database or custom source, run it once against a disposable test scope, and read the evidence it leaves.
- [Import users from a CSV file](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data/import-users-from-csv.md): Load a user CSV into OpenIAM from the shipped example configuration — two test records first, then the file you were given.
- [Import roles, groups, organizations and entitlement memberships](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data/import-roles-groups-and-memberships.md): Load roles, groups, organizations and resources from CSV, then grant memberships — in the fixed order OpenIAM requires.
- [Import from two authoritative sources without overwriting](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data/import-from-two-authoritative-sources.md): Run an AD import and an Entra import against the same people without either one overwriting what the other owns.
- [Schedule an incremental synchronization](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data/incremental-synchronization.md): Move a proven synchronization onto a cron, switch it to INCREMENTAL, and confirm the batch task it creates.
- [How a synchronization matches and processes a record](https://docs.openiam.com/administration-guide/lifecycle/synchronize-and-import-data/synchronization-matching-and-processing.md): How a synchronization decides which OpenIAM object a source record is, what it creates when nothing matches, and how a run is divided into parts.
- [Simulation mode](https://docs.openiam.com/administration-guide/lifecycle/simulation-mode.md): Hold connector requests for human review before they reach a target, then apply or discard them.
- [Grant birthright access](https://docs.openiam.com/administration-guide/lifecycle/birthright-access.md): Grant baseline access from identity attributes with no request, worked twice end to end, with the four mechanisms that do it and the removal behavior of each.
- [Offboard a leaver end to end](https://docs.openiam.com/administration-guide/lifecycle/offboard-a-leaver.md): The five things that have to happen when somebody leaves, which page owns each one, and the parts OpenIAM does not automate at all.
- [Disable leavers automatically on their end date](https://docs.openiam.com/administration-guide/lifecycle/disable-leavers-automatically.md): LEAVER\_PROCESS ships enabled at 17:00 daily and, with an empty Parameter 1, selects nobody. Give it a window and a script that skips service accounts.
- [Decommission a managed system](https://docs.openiam.com/administration-guide/lifecycle/decommission-a-managed-system.md): Retire a managed system in the order the product enforces — three blocking dependencies, two silent unlinks, and the references nothing cleans up for you.
- [Advanced lifecycle patterns](https://docs.openiam.com/administration-guide/lifecycle/advanced-lifecycle-patterns.md): Future starts, contractors, leave, transfers, protected populations, termination, rehire and two HR sources — each connected to the transform return code, batch task or business-rule action that imple
- [Customize and automate](https://docs.openiam.com/administration-guide/automation.md): Attach a Groovy script to an OpenIAM extension point, put work on a schedule, and find the contract and the shipped example for each.
- [Create a Groovy script](https://docs.openiam.com/administration-guide/automation/manage-groovy-scripts.md): Create, compile, version, test, promote and roll back a Groovy script in Groovy Manager, and control which version each caller actually runs.
- [Edit a synchronization transformation script](https://docs.openiam.com/administration-guide/automation/synchronization-scripts.md): Copy a shipped transformation script to your own versioned path, change it, attach it and prove it on three records — with the email and UPN removal worked end to end.
- [Create a batch task](https://docs.openiam.com/administration-guide/automation/batch-tasks.md): Create, parameterize, test and schedule a batch task — the Groovy bindings, the Spring-bean route, the real validation errors and the two timers that decide when it runs.
- [Run a synchronization on a schedule](https://docs.openiam.com/administration-guide/automation/batch-tasks/schedule-a-synchronization.md): Put an existing synchronization or reconciliation on a cron schedule with the shipped batch script, passing its configuration ID as Parameter 1.
- [Restart batch tasks that have all stopped](https://docs.openiam.com/administration-guide/automation/batch-tasks/diagnose-stalled-batch-tasks.md): Every enabled batch task stopped at the same moment with no failed audit record. Find the task whose schedule backlog aborted the cycle, clear it and confirm recovery.
- [Configure requests and approvals](https://docs.openiam.com/administration-guide/requests.md): How a request becomes access in OpenIAM — the catalog that offers it, the approval flow that decides it, and the fulfilment that delivers it.
- [Approval flows](https://docs.openiam.com/administration-guide/requests/approval-flows.md): Change who approves a request, understand the shipped defaults that route every approval to sysadmin, and diagnose a request that has stopped.
- [Approver associations and the shipped flow shape](https://docs.openiam.com/administration-guide/requests/approval-flows/approver-association-reference.md): Every APPROVER\_ASSOC column, the fifteen approver and notifier entity types and where each is offered, how definitions reach the engine, and what the shipped entitlement flow does step by step.
- [Raise a ServiceNow incident from an approval](https://docs.openiam.com/administration-guide/requests/approval-flows/raise-a-servicenow-incident.md): Attach a customer-owned Groovy script to a request's target resource so an approved request raises exactly one ServiceNow incident, and make its failures visible.
- [The request catalog and questionnaires](https://docs.openiam.com/administration-guide/requests/request-catalog.md): Make roles, groups and resources appear in the SelfService request catalog, and attach questionnaires that reach the approver.
- [Requesting for other users](https://docs.openiam.com/administration-guide/requests/request-for-others.md): Control who can start an access request for another user from the SelfService header and the Create Request page.
- [Manual fulfilment](https://docs.openiam.com/administration-guide/requests/fulfilment.md): Route access in a system OpenIAM cannot provision to a human fulfiller — the Manual flag, the manualTask process, who it is assigned to, what the fulfiller sees, and how completion is recorded.
- [Ticket integration with Jira, ServiceNow and Freshservice](https://docs.openiam.com/administration-guide/ticketing.md): Ticket integration — OpenIAM opens, updates and closes tickets in Jira, ServiceNow or Freshservice when requests, users, provisioning or non-human identities change, and reads their status back.
- [How ticket integration works](https://docs.openiam.com/administration-guide/ticketing/overview.md): How OpenIAM turns an event into a Jira, ServiceNow or Freshservice ticket — rules, triggers, trigger groups, one ticket per subject, delivery states and the status read back from the ticketing system.
- [Connect a ticketing system](https://docs.openiam.com/administration-guide/ticketing/connect-a-ticketing-system.md): Deploy the Ticket Connector, create the managed system that represents Jira, ServiceNow or Freshservice, enter the site and the credential, and prove the connection before any rule fires.
- [Write a ticket rule](https://docs.openiam.com/administration-guide/ticketing/ticket-rules.md): Create, change, duplicate and delete ticket rules — the Ticket rules list and the four cards of the rule editor, from the trigger to the ticket's content and the live preview.
- [Triggers and conditions](https://docs.openiam.com/administration-guide/ticketing/ticket-rules/triggers-and-conditions.md): Every ticket rule trigger — when it fires, which ticket it shares, whether it can usefully create, update or close — and every condition the IF card offers.
- [Template placeholders](https://docs.openiam.com/administration-guide/ticketing/ticket-rules/placeholders.md): Every ${…} placeholder a ticket rule template can use, the triggers that fill it, and how values are rendered into the ticket's summary, description, comment and additional fields.
- [How fields reach Jira, ServiceNow and Freshservice](https://docs.openiam.com/administration-guide/ticketing/jira-and-servicenow.md): What each ticket field becomes in Jira, ServiceNow and Freshservice — projects, tables and workspaces, issue types and categories, priorities, labels and tags, transitions and statuses, additional fie
- [Track tickets](https://docs.openiam.com/administration-guide/ticketing/tickets.md): The Tickets screen of a ticketing managed system — every ticket OpenIAM raised, its delivery state and status, retry and discard of failed deliveries, the ticket details and audit trail, and the Ticke
- [The TICKET policy map and ticket synchronization](https://docs.openiam.com/administration-guide/ticketing/policy-map-and-sync.md): The TICKET policy map that carries ticket fields to the connector — its eight read-only standard rows and the extra fields you can add to every ticket — and the ticket synchronization that reads statu
- [Review tickets before they are sent](https://docs.openiam.com/administration-guide/ticketing/review-before-sending.md): Hold the tickets a ticketing managed system would create, update or close in simulation mode, read and edit each captured request, rebuild it after changing a rule, and apply it when it is right.
- [Operate ticket integration](https://docs.openiam.com/administration-guide/ticketing/operate-ticketing.md): For operators — the services and queues behind ticket integration, how deliveries are retried and deferred, every property with its default, the audit actions, which log answers which question, troubl
- [Govern access](https://docs.openiam.com/administration-guide/governance.md): OpenIAM's identity governance surface — access certification campaigns and segregation of duties, two independent subsystems that share a data model only at the edges.
- [Access certification](https://docs.openiam.com/administration-guide/governance/certification.md): Access certification in OpenIAM — the two campaign types, the preview-then-promote launch model, what reviewers see, and the evidence a campaign leaves behind.
- [The certification model](https://docs.openiam.com/administration-guide/governance/certification/certification-model.md): The certification object model mapped onto the tables that store it — five objects, the separate database, and the two things both called "decision source".
- [Plan and scope a campaign](https://docs.openiam.com/administration-guide/governance/certification/plan-and-scope-a-campaign.md): Choose the campaign type, configure the definition and scope it — the two types, why risk is a filter rather than a type, and the fields that decide whether anyone is ever notified.
- [Create a user campaign](https://docs.openiam.com/administration-guide/governance/certification/create-a-user-campaign.md): Scope a USER\_CERTIFICATION — the six user selection modes, what each stores, why a frozen user list goes stale, and the schedule values.
- [Create an application campaign](https://docs.openiam.com/administration-guide/governance/certification/create-an-application-campaign.md): Scope an APPLICATION\_CERTIFICATION — which managed systems, which entitlements, the three entitlement selection modes, and why an allow-list silently stops covering new access.
- [Review entitlements that live inside an application](https://docs.openiam.com/administration-guide/governance/certification/review-application-entitlements.md): Onboard an application that is not Active Directory, import its roles and assignments, and certify them — the ordering rule, the Application column, and what nesting will and will not do.
- [Configure the review workflow](https://docs.openiam.com/administration-guide/governance/certification/configure-the-review-workflow.md): Configure who reviews a campaign, in what order, how long they get, what happens when the time runs out — and enable the two batch tasks without which no reminder is ever sent.
- [Preview and launch a campaign](https://docs.openiam.com/administration-guide/governance/certification/preview-and-launch.md): Run a preview, read the three numbers that decide whether the scope is right, then promote it into a live campaign — plus every preview status and every exclusion reason.
- [Operate a live campaign](https://docs.openiam.com/administration-guide/governance/certification/operate-a-live-campaign.md): Operate a launched campaign — watch the right run, extend or expire it, understand exactly what a revoke decision does to access, and close it with evidence intact.
- [What your reviewers see](https://docs.openiam.com/administration-guide/governance/certification/the-reviewer-experience.md): What your reviewers actually see — the decision cart, bulk gates, comparison, the SoD block and the submit disclaimer — and which of your settings changes it.
- [Campaign history and evidence](https://docs.openiam.com/administration-guide/governance/certification/campaign-history-and-evidence.md): Produce the certification evidence pack — the three report types, the 39 columns they all share, what they leave out, and the History tab that covers the gap.
- [Membership tags](https://docs.openiam.com/administration-guide/governance/certification/membership-tags.md): Understand the five shipped membership-origin tags, verify each assignment path, create a custom tag, and know what certification and risk scoring do with them.
- [Operate certification services](https://docs.openiam.com/administration-guide/governance/certification/operate-certification-services.md): How the certification subsystem is put together — its own service, database and queues, the ephemeral preview store, what schedules a certification, and the retention position you inherit.
- [Diagnose a stalled campaign](https://docs.openiam.com/administration-guide/governance/certification/diagnose-a-stalled-campaign.md): Work a campaign that has stopped moving from the outside in — service health, queue consumers, preview state, item rows, then Activiti — and tell a stuck queue from a stuck preview from a stuck campai
- [Segregation of duties](https://docs.openiam.com/administration-guide/governance/sod.md): Segregation of duties in OpenIAM — policies, segments, rule sets, mitigating controls and mitigations, with the tables behind them and where detected violations actually live.
- [SoD policies and rule sets](https://docs.openiam.com/administration-guide/governance/sod/sod-policies-and-rule-sets.md): What a segregation-of-duties policy and a rule set are, why an organization needs them, the difference between preventive and detective control, what you can simulate before you commit, and the Inacti
- [Create an SoD policy](https://docs.openiam.com/administration-guide/governance/sod/sod-policies-and-rule-sets/create-an-sod-policy.md): Build a segregation-of-duties policy by hand — segments, thresholds, mitigating controls and the manager group — and test both directions before you activate it.
- [Activate an SoD rule set](https://docs.openiam.com/administration-guide/governance/sod/sod-policies-and-rule-sets/activate-an-sod-rule-set.md): Turn a rule set into live SoD policies — read the activation preview as a mapping sheet, land it in Shadow, take the backlog count, then enforce and handle version drift.
- [SoD detection and violations](https://docs.openiam.com/administration-guide/governance/sod/sod-detection-and-violations.md): Schedule the SoD detection sweep and its violation digest — the un-seeded batch task, the cron presets, the snapshot that makes "new" and "resolved" mean anything, how detection runs alongside a sweep
- [Work an SoD violation to closure](https://docs.openiam.com/administration-guide/governance/sod/sod-triage-remediation-and-evidence.md): Triage an SoD violation to its authoritative source, remove or mitigate it, read SoD context in a certification review, and produce evidence an auditor will accept.
- [Mitigate an SoD violation](https://docs.openiam.com/administration-guide/governance/sod/mitigations.md): Accept one user's SoD violation under the policy's mitigating controls — who can mitigate what, how coverage is worked out, the status model, approval of requests from SelfService, periodic review, an
- [SAP role and SoD analysis](https://docs.openiam.com/administration-guide/governance/sod/sap-sod-analysis.md): Activate OpenIAM's shipped SAP SoD content against real SAP entitlement data — the readiness check, the transaction-code naming gap that makes activation match nothing, and what the analysis can and c
- [Risk management](https://docs.openiam.com/administration-guide/risk.md): Risk scoring in OpenIAM — what a score is, every factor and policy field explained for administrators, how certification uses it, and how reviewers should read it.
- [Risk management overview](https://docs.openiam.com/administration-guide/risk/overview.md): What a risk score is, why certification needs one, how OpenIAM produces it, what it is attached to, where it appears, and what it is not.
- [Risk factor reference](https://docs.openiam.com/administration-guide/risk/factors.md): What each built-in risk factor measures, why it is a warning sign, what its settings do, and which level of risk it feeds.
- [Risk policies](https://docs.openiam.com/administration-guide/risk/policies.md): How the risk policy turns factor scores into one number and one band, what every field on the policy screen does, and a recommended starting configuration.
- [Access certification and risk](https://docs.openiam.com/administration-guide/risk/certification.md): How a certification uses risk — the Risk tab, the membership risk threshold, the auto-certify rule, and what an auto-certified item is.
- [Reading risk on the reviewer screen](https://docs.openiam.com/administration-guide/risk/reviewer-experience.md): For reviewers — what the risk pill, the critical and high counts and the risk explanation mean, and how to work through a review queue in the time you have.
- [Caddie — Access Review Assistant](https://docs.openiam.com/administration-guide/caddie.md)
- [Caddie — Access Review Assistant overview](https://docs.openiam.com/administration-guide/caddie/overview.md): What Caddie — Access Review Assistant is, the four questions it answers for a reviewer, the seven blocks at a glance, where it appears, what it deliberately does not do, and where its data comes from.
- [Enable Caddie — Access Review Assistant](https://docs.openiam.com/administration-guide/caddie/enable-caddie.md): Switch Caddie — Access Review Assistant on for a certification — the two switches on the Risk tab, how the value reaches a campaign, what to check after launch, and the system properties that tune eac
- [Reviewer details templates](https://docs.openiam.com/administration-guide/caddie/reviewer-details-templates.md): Choose which user, role and group details reviewers see in a certification's campaigns — the Reviewer details templates section, the three shipped defaults field by field, how to build your own, and w
- [Reviewer column templates](https://docs.openiam.com/administration-guide/caddie/reviewer-column-templates.md): Choose the columns reviewers see in a campaign's User View and Entitlement View — the two column templates a certification names, the shipped defaults, every built-in field, custom attributes as colum
- [The Caddie panel](https://docs.openiam.com/administration-guide/caddie/the-caddie-panel.md): For reviewers — the Caddie — Access Review Assistant button and when it appears, the panel and its header, the User information and Entitlement information blocks, how blocks load, and what the panel
- [Certification history](https://docs.openiam.com/administration-guide/caddie/certification-history.md): For reviewers — the two blocks of Caddie — Access Review Assistant that answer "has this been decided before?": this person's past decisions on this exact access, and how the same entitlement has fare
- [Peer comparison](https://docs.openiam.com/administration-guide/caddie/peer-comparison.md): For reviewers — the Peer comparison block, which turns the Peer Rarity risk factor into one sentence saying how many people in the same organization unit or team hold the same access, what the cohort
- [What happens if I revoke this?](https://docs.openiam.com/administration-guide/caddie/revocation-impact.md): For reviewers — the Caddie — Access Review Assistant block "What happens if I revoke this?", which predicts a revocation before it is made: when the access would end, which resources would be lost and
- [Ask for help](https://docs.openiam.com/administration-guide/caddie/ask-for-help.md): For reviewers and administrators — the Ask for help block: whom a reviewer can write to about one review item, the message OpenIAM drafts, who it is sent from, the mail template behind it, and what is
- [Audit trail for a review item](https://docs.openiam.com/administration-guide/caddie/item-audit-trail.md): The History column on the reviewer's tables and the audit trail sheet it opens — everything already recorded against one review item, who may open it, every event it can show, what it deliberately doe
- [Caddie troubleshooting](https://docs.openiam.com/administration-guide/caddie/troubleshooting.md): For administrators and reviewers — why a Caddie — Access Review Assistant block reads "cannot identify any user", "not enough certification history" or "not enough peer data", and what to change so it
- [Report builder](https://docs.openiam.com/administration-guide/reports.md): The report builder — browse the Data Catalog, build a report from entities or a view, filter and group it, run it to CSV or Excel, schedule and e-mail it, and manage the files it produces.
- [Report builder overview](https://docs.openiam.com/administration-guide/reports/overview.md): What the report builder is made of — entities, backends, data sources, reports, runs, schedules and retention — the rules every report obeys, the limits, and who sees what. No settings on this page.
- [Browse the Data Catalog](https://docs.openiam.com/administration-guide/reports/data-catalog.md): Browse the entities and views reports can read — the cards and their access badges, the Database and OpenSearch backends, the entity sheet with fields and relationships, and how to start a view from a
- [Create a report](https://docs.openiam.com/administration-guide/reports/create-a-report.md): Build a new report with the ten-step wizard — name it, pick entities or a view, choose fields, filter and group the rows, set the file format, schedule it, choose how the file is delivered and how lon
- [Filters and parameters](https://docs.openiam.com/administration-guide/reports/filters-and-parameters.md): The condition editor behind the wizard, the designer and the view builder — match modes and custom logic, every operator by field type, related-record conditions, the "Ask when running" switch, and wh
- [Design a report](https://docs.openiam.com/administration-guide/reports/design-a-report.md): The report designer — change a report's data source, fields, calculated fields, grouping, totals and file naming after it exists, and what Save checks before it writes.
- [Name the output files](https://docs.openiam.com/administration-guide/reports/output-file-names.md): How a report names each file it produces — the File name pattern, its placeholders, the default, the "type an example" helper, the limits, and the folder the files land in.
- [Views and SQL data sources](https://docs.openiam.com/administration-guide/reports/views-and-sql-sources.md): Build a reusable view with the visual builder — primary entity, related entities, joins, filters, validation — or, as a super administrator, publish a vetted SQL statement as a data source.
- [Manage reports](https://docs.openiam.com/administration-guide/reports/manage-reports.md): The Reports list and the report details page — find a report, read its cards, clone it, delete it, and reach everything else from its row menu.
- [Run a report and download the file](https://docs.openiam.com/administration-guide/reports/run-and-download.md): Run a report on demand or export it once, preview it before you commit, read Run history, collect files from the Download Center, and understand when a file expires.
- [Schedule and deliver a report](https://docs.openiam.com/administration-guide/reports/schedule-and-deliver.md): Make a report run by itself — the schedule sheet, frequencies and time zones, the planned next runs, delivery by e-mail to groups, users or addresses or by upload to SFTP servers, and what happens eac
- [Job Monitor](https://docs.openiam.com/administration-guide/reports/job-monitor.md): The Job Monitor — what is running and queued across all users, what failed in the last day, how the queue orders runs, and how a super administrator cancels, retries and spots a lost worker.
- [Access and permissions](https://docs.openiam.com/administration-guide/reports/access-and-permissions.md): Who can open the report builder, what an owner and a super administrator may do with a report, who manages report packs and who runs their reports from SelfService, how entity and field permissions wo
- [Publish reports to SelfService](https://docs.openiam.com/administration-guide/reports/publish-reports-to-selfservice.md): Give auditors and other users the output of reports without Webconsole access — the built-in report packs and auditor roles, the Report packs screen where you create a pack, add reports and choose its
- [System templates](https://docs.openiam.com/administration-guide/reports/system-templates.md): The report templates OpenIAM ships — what a system template is, the shipped list with the entity each reads, how to clone one into a report you own, and what an upgrade does to them.
- [Operate the report service](https://docs.openiam.com/administration-guide/reports/operate-the-report-service.md): What the report builder runs on — the report service, its database and source databases, the shared file store, the run queue, the nightly purge, every report.\* property with its default, the audit ac
- [Decide access with policies](https://docs.openiam.com/administration-guide/pbac.md): Author, simulate and safely roll out Cedar-based access policies that decide requests on attributes and context, alongside the entitlements a user already holds.
- [The policy model](https://docs.openiam.com/administration-guide/pbac/policy-model.md): What a policy, a version and an enforcement mode are, which OpenIAM entities Cedar can see, and the attribute rules that decide whether a policy evaluates or errors.
- [Create a policy](https://docs.openiam.com/administration-guide/pbac/create-a-policy.md): Create a policy header, author its first version with the form builder or the Cedar editor, and manage the version history without changing what is in force.
- [Simulate a policy](https://docs.openiam.com/administration-guide/pbac/simulate-a-policy.md): Evaluate a policy version against real users and resources without touching live access, read the per-subject results, and stress-test a policy for throughput and latency.
- [Roll a policy out safely](https://docs.openiam.com/administration-guide/pbac/roll-out-a-policy.md): Take a policy from draft to fully enforced through shadow and partial modes, understand how deterministic bucketing decides who is governed, and know what the audit trail records at each stage.
- [Trace a decision](https://docs.openiam.com/administration-guide/pbac/trace-a-decision.md): Find why one request was allowed or refused, read which policy determined it, and get at the per-policy participation detail the decision screen does not show.
- [PBAC reference](https://docs.openiam.com/administration-guide/pbac/pbac-reference.md): The pbac-manager service, its infrastructure dependencies, cache intervals and configuration properties, usage metering, and the REST API behind the PBAC screens.
- [Privacy decisions](https://docs.openiam.com/administration-guide/pbac/privacy-decisions.md): Make a PBAC policy depend on a person's consent for a privacy purpose, read the privacy record and obligations it works with, and know what the gateway and guarded API methods do with the four-valued
- [Secure sign-in and credentials](https://docs.openiam.com/administration-guide/security.md): Route to the right authentication, MFA, passwordless, password, recovery or credential-rotation task, and know which object you are actually editing.
- [The authentication model](https://docs.openiam.com/administration-guide/security/authentication-model.md): How a request is matched to a content provider, a rule and a sequence of authentication steps, which object each decision actually lives on, and how to build a passwordless sign-in.
- [A user cannot sign in](https://docs.openiam.com/administration-guide/security/cannot-sign-in.md): Triage a sign-in failure by what the user actually sees, from a refused password to a second factor that never prompts, and know which page fixes each cause.
- [Authentication providers and MFA](https://docs.openiam.com/administration-guide/security/authentication-providers-and-mfa.md): Decide which authentication provider type and which second factor a situation calls for, then go to the page that configures it.
- [Authentication levels, rules and capability flags](https://docs.openiam.com/administration-guide/security/authentication-providers-and-mfa/authentication-provider-reference.md): Every authentication level OpenIAM can route to, the five tables that make up a rule, the shipped rules including the passwordless ones, the provider capability flags and the Authentication property c
- [Add TOTP as a second factor](https://docs.openiam.com/administration-guide/security/totp.md): Turn on TOTP for an authentication policy provider, attach it to a rule, and enrol a user with any RFC 6238 authenticator app.
- [OpenIAM Authenticator app](https://docs.openiam.com/administration-guide/security/openiam-authenticator-app.md): Enrol a phone in the OpenIAM Authenticator app from My Devices, approve a push sign-in from it, use it for TOTP codes, remove it, and keep device-manager's Firebase key in order.
- [FIDO2 and WebAuthn](https://docs.openiam.com/administration-guide/security/fido2-and-webauthn.md): Roll out FIDO2 security keys and platform authenticators, attach WEB\_AUTH to a rule for passwordless or second-factor sign-in, and recover a user who lost their authenticator.
- [What OpenIAM's WebAuthn implementation does and does not do](https://docs.openiam.com/administration-guide/security/fido2-and-webauthn/fido2-and-webauthn-reference.md): What OpenIAM's WebAuthn implementation does and does not do, the ceremony parameters that are fixed in the product, and everything 4.2.1.0 creates.
- [Add Duo as a second factor](https://docs.openiam.com/administration-guide/security/duo.md): Register a Duo tenant as its own authentication provider, reference it from an authentication policy provider, and attach the shipped Duo rule.
- [Certificate authentication](https://docs.openiam.com/administration-guide/security/certificate-authentication.md): Configure client-certificate sign-in end to end, with the single-capture-group regex contract, a CA validation script that actually validates, and the negative tests that prove it.
- [Password policy](https://docs.openiam.com/administration-guide/security/password-policy.md): Build a password policy with real parameter names and shipped defaults, understand how one policy is selected out of many, and prove the change with a positive and a negative test.
- [Configure password recovery and account unlock](https://docs.openiam.com/administration-guide/security/password-recovery.md): Configure forgot-password, forgot-username, security questions and account unlock with the real policy parameters, property keys and audit actions.
- [Verify a help-desk caller](https://docs.openiam.com/administration-guide/security/helpdesk-verification.md): Make a help-desk technician answer questions about the caller before the caller's profile opens, with the fixed question pool, the counts and the audit actions.
- [Adaptive authentication](https://docs.openiam.com/administration-guide/security/adaptive-authentication.md): Build an adaptive authentication rule that steps up when a user's country is new, prove which edge fired, and roll it back safely.
- [Adaptive risk types and their values](https://docs.openiam.com/administration-guide/security/adaptive-authentication/adaptive-authentication-reference.md): All fourteen adaptive risk types, the edge each takes when its own evaluation fails, the conformity and value formats, the geolocation properties and the behavioral model.
- [Step-up authentication](https://docs.openiam.com/administration-guide/security/step-up-authentication.md): Demand a stronger authentication method on one URL without changing everyday sign-in — how OpenIAM expresses assurance, how a rule reaches a path, what the user sees, how long a step-up lasts, and how
- [Terminate a user's sessions](https://docs.openiam.com/administration-guide/security/session-management.md): End one person's live sessions from the screen that can, prove the termination took, and know what it does not reach.
- [What an OpenIAM session is, and what ends one](https://docs.openiam.com/administration-guide/security/session-management/session-management-reference.md): Where an OpenIAM session lives, the cookie and its flags, the two timeouts and their shipped values, and exactly what a termination does and does not invalidate.
- [Social sign-in](https://docs.openiam.com/administration-guide/security/social-authentication.md): Configure Google, Facebook, LinkedIn or Apple as a sign-in provider for users who already exist in OpenIAM, with the real attribute IDs, callback paths and shipped defaults.
- [Register users from a social provider](https://docs.openiam.com/administration-guide/security/social-registration.md): Let an unknown person carry approved profile data from Google, Facebook or LinkedIn into OpenIAM's self-registration flow, without bypassing any registration control.
- [Compromised password detection](https://docs.openiam.com/administration-guide/security/compromised-passwords.md): Understand, verify and — if your deployment requires it — turn off the post-login breached-password notification that ships enabled on policy 4000.
- [Rotate service credentials](https://docs.openiam.com/administration-guide/security/rotate-service-credentials.md): Which service credentials OpenIAM holds and under which Vault key, which of them you rotate yourself, what breaks when one is wrong, and the log line you will see.
- [Vault client identities](https://docs.openiam.com/administration-guide/security/vault-client-identities.md): Which certificate each OpenIAM component presents to Vault and what its role may do, how each distribution issues and renews the certificates, how to rotate them or use your own CA, and when the legac
- [Configure federation and application SSO](https://docs.openiam.com/administration-guide/federation.md): Choose between SAML, OpenID Connect and the Access Gateway by naming the protocol and each side's role, then go to the page that configures it.
- [OpenIAM as a SAML identity provider](https://docs.openiam.com/administration-guide/federation/saml-identity-provider.md): Configure OpenIAM as a SAML 2.0 identity provider for one service provider, test both initiation paths, and diagnose a missing assertion attribute.
- [Every SAML identity provider attribute, with its shipped default](https://docs.openiam.com/administration-guide/federation/saml-identity-provider/saml-identity-provider-reference.md): Every AUTH\_ATTRIBUTE key on a SAML identity provider, with its Webconsole label, shipped default, binding property and release.
- [Federate a Microsoft Entra domain](https://docs.openiam.com/administration-guide/federation/federate-a-microsoft-entra-domain.md): Route sign-in for every user in a verified Microsoft Entra domain to OpenIAM, align the immutable identity, and roll the domain back to managed authentication.
- [OpenIAM as a SAML service provider](https://docs.openiam.com/administration-guide/federation/saml-service-provider.md): Configure OpenIAM as a SAML 2.0 service provider against an external identity provider, keep the assertion consumer service reachable, and prove correlation and entitlement separately.
- [OAuth 2.0 and OpenID Connect](https://docs.openiam.com/administration-guide/federation/oauth-and-oidc.md): Register an OAuth 2.0 client so OpenIAM becomes its authorization server and OpenID Connect provider, then fence it so entitlement actually applies.
- [OAuth endpoints, grants, scopes and signing](https://docs.openiam.com/administration-guide/federation/oauth-and-oidc/oauth-and-oidc-reference.md): Every OAuth and OIDC endpoint including the end-session endpoint, the tenant metadata document, Client ID Metadata Documents, the resource parameter, the three response modes including form\_post, the
- [Sign in to SharePoint Server through OpenID Connect](https://docs.openiam.com/administration-guide/federation/oauth-and-oidc/sharepoint-server-oidc.md): Make OpenIAM the OpenID Connect identity provider for SharePoint Server Subscription Edition, with the client settings SharePoint needs, the PowerShell for 24H2 and earlier builds, and the failures yo
- [Connect AI assistants through the MCP server](https://docs.openiam.com/administration-guide/federation/mcp-server.md): Deploy the OpenIAM MCP server, publish it through the Access Gateway, decide which roles may use it, and connect Claude.ai, Claude Code or another MCP client that signs users in with OpenIAM.
- [Govern AI agents as non-human identities](https://docs.openiam.com/administration-guide/federation/mcp-server/mcp-agents.md): Give every MCP client an AI agent record in the non-human identity inventory, set up the SelfService AI assistant's client and the record that switches it on and holds its model connection, register a
- [Decide MCP tool calls with policies](https://docs.openiam.com/administration-guide/federation/mcp-server/mcp-policies.md): Every MCP tool call is a Cedar policy decision the server applies — the vocabulary a policy can test, the permit every call needs, the seven shipped policies and how 2026.11.1 enforces them, reviewing
- [MCP tools, errors, properties and limits](https://docs.openiam.com/administration-guide/federation/mcp-server/mcp-server-reference.md): The 20 tools of the OpenIAM MCP server with their scopes, arguments and results, the catalog document, the request headers, the HTTP and tool error codes including the agent admission reasons, every o
- [How the SelfService AI assistant reads OpenIAM data](https://docs.openiam.com/administration-guide/federation/mcp-server/ai-assistant-mcp-reads.md): How the SelfService AI assistant reads a person's profile, access, applications, requests, approvals and campaigns, and answers questions about entitlements, people and organizations, through the Open
- [Where the AI assistant sends people's data](https://docs.openiam.com/administration-guide/federation/mcp-server/ai-assistant-model-and-data-location.md): What the SelfService AI assistant tells people about the model it runs on and where their data goes, and why the answer is always that the data leaves your network for Oracle Cloud Infrastructure (OCI
- [Just-in-time provisioning](https://docs.openiam.com/administration-guide/federation/jit-provisioning.md): Create an OpenIAM identity on an external user's first federated sign-in, with the gating attribute, the fixed creation order and the tests that prove an unapproved person is refused.
- [The JIT script contract and claim mapping](https://docs.openiam.com/administration-guide/federation/jit-provisioning/jit-provisioning-reference.md): The methods a just-in-time provisioning script must implement, a script that compiles, the claim names each identity provider sends, and how to map identity-provider groups to OpenIAM groups.
- [Administer the Access Gateway](https://docs.openiam.com/administration-guide/gateway.md): Route to the right Access Gateway page — understand the model, publish an application, transform its requests and responses, read the reference, or diagnose a failure.
- [How the Access Gateway works](https://docs.openiam.com/administration-guide/gateway/access-gateway.md): What the OpenIAM Access Gateway is, why an organization deploys one, where it sits between the browser, the application and OpenIAM, and how one protected request travels through it.
- [Protect an application behind the Access Gateway](https://docs.openiam.com/administration-guide/gateway/protect-an-application.md): Publish an application behind the OpenIAM Access Gateway end to end — content provider, default URI patterns, the application's own pattern, its upstream server, entitlement and the first proxied requ
- [Give the application the authenticated identity](https://docs.openiam.com/administration-guide/gateway/inject-identity.md): Give an application behind the Access Gateway the authenticated identity — as request headers, query parameters or cookies, or by form fill: filling and posting the application's own login form, the c
- [Advanced request and response transformations](https://docs.openiam.com/administration-guide/gateway/request-and-response-transformations.md): Change what the browser gets back from an application behind the Access Gateway — rewrite absolute URLs, map upstream errors, redirect a path elsewhere, fix where users land after signing in, and bran
- [Kerberos and desktop SSO](https://docs.openiam.com/administration-guide/gateway/kerberos.md): Configure Kerberos/SPNEGO desktop single sign-on through the Access Gateway — the principal shape, the Kerberos authentication rule, and the two URI patterns that otherwise silently override it.
- [Troubleshoot the Access Gateway](https://docs.openiam.com/administration-guide/gateway/troubleshoot-the-gateway.md): Diagnose a request that fails through the OpenIAM Access Gateway — locate the failing hop, collect the four pieces of evidence that settle it, and work the symptom/cause/fix table.
- [Access Gateway reference](https://docs.openiam.com/administration-guide/gateway/access-gateway-reference.md): Everything the Access Gateway exposes, in one place — metadata types and value sources, the calls it makes to OpenIAM, the headers it sends the UI, status codes, postback validation, session renewal,
- [Configure platform services](https://docs.openiam.com/administration-guide/platform.md): Route to the platform-wide service you need to configure — properties, mail, OTP delivery, localization, consent, promotion or a supporting service.
- [System configuration](https://docs.openiam.com/administration-guide/platform/system-configuration.md): Find the right System configuration tab, and change a shipped property without breaking a working system.
- [Metadata types and elements](https://docs.openiam.com/administration-guide/platform/metadata-types.md): What a metadata type is, what its grouping decides, how its elements become fields on a screen, and what each flag on it actually changes.
- [Mail and notifications](https://docs.openiam.com/administration-guide/platform/mail-and-notifications.md): Configure SMTP delivery from a shipped mailbox template, test it safely in simulation mode, and change what a notification says.
- [SMS and one-time passwords](https://docs.openiam.com/administration-guide/platform/sms-and-otp.md): Configure a Twilio, SMSGlobal, email or Groovy OTP provider with the real attribute names and defaults, and test it with a disposable identity.
- [Languages and localization](https://docs.openiam.com/administration-guide/platform/localization.md): Understand the two translation surfaces, add a LANGUAGE\_MAPPING row for a menu, and verify it against a real locale.
- [Promote configuration between environments](https://docs.openiam.com/administration-guide/platform/import-export-and-promotion.md): Promote roles, groups, organizations, resources and business rules from one environment to the next with the import-export utility, and plan the rest of the promotion around it.
- [Import and export reference](https://docs.openiam.com/administration-guide/platform/import-export-and-promotion/import-export-reference.md): Every object type, field, configuration key, command flag and artifact shape of the import-export utility, what it does not cover, and what the two Webconsole Export and Import screens really do.
- [What a backup and restore must cover](https://docs.openiam.com/administration-guide/platform/backup-and-restore-scope.md): What a recoverable copy of OpenIAM actually consists of — the nine schemas, the vault, files on disk and OpenSearch — and the one version check that exists.
- [Define a sequence generator](https://docs.openiam.com/administration-guide/platform/sequence-generators.md): Create a named cluster-wide counter and call it from a script, so a synchronization or a policy map can invent an identifier that never repeats.
- [Set up geo-IP lookup](https://docs.openiam.com/administration-guide/platform/geo-ip-lookup.md): Turn on IP geolocation, choose between the external API and the local database, load the database file, and prove one address resolves.
- [Configure an analytics dashboard tile](https://docs.openiam.com/administration-guide/platform/analytics-dashboard.md): Add, correct or retire a counter tile on the analytics dashboard, and read the six shipped tiles literally enough to trust the numbers.
- [Turn on the AI assistant](https://docs.openiam.com/administration-guide/platform/turn-on-the-ai-assistant.md): Turn the SelfService AI assistant on by giving its AI Assistant agent record a model connection and activating it, choose who is offered it through the AI\_ASSISTANT menu entitlement, and know what peo
- [AI assistant conversation history](https://docs.openiam.com/administration-guide/platform/ai-assistant-conversation-history.md): How the SelfService AI assistant keeps and names each conversation, how much of it reaches the model and how to fit that to the model's context window, the follow-up suggestions it adds after an answe
- [Supported model for the AI assistant](https://docs.openiam.com/administration-guide/platform/ai-assistant-supported-models.md): The one model the SelfService AI assistant supports, gpt-oss-120b on Oracle Cloud Infrastructure (OCI) Generative AI, with its license, context window and measured tool-calling accuracy, the OCI regio
- [Frequently asked questions](https://docs.openiam.com/administration-guide/faq.md): The questions administrators ask most often, answered briefly and linked to the page that carries the detail.
- [Gateway, SSO and federation](https://docs.openiam.com/administration-guide/faq/gateway-and-federation.md): Short answers to questions administrators ask most often about gateway, sso and federation.
- [Identities, roles and scheduled work](https://docs.openiam.com/administration-guide/faq/identities-and-access.md): Short answers to questions administrators ask most often about identities, roles and scheduled work.
- [Operations, requests and access](https://docs.openiam.com/administration-guide/faq/operations-and-requests.md): Short answers to questions administrators ask most often about operations, requests and access.
- [Provisioning and lifecycle](https://docs.openiam.com/administration-guide/faq/provisioning-and-lifecycle.md): Short answers to questions administrators ask most often about provisioning and lifecycle.
- [Security, recovery and platform](https://docs.openiam.com/administration-guide/faq/security-and-platform.md): Short answers to questions administrators ask most often about security, recovery and platform.
- [Error and symptom index](https://docs.openiam.com/administration-guide/error-and-symptom-index.md): Every error message, log line and observable symptom the guide explains, with the page that explains it.
- [Consent and policy acceptance](https://docs.openiam.com/administration-guide/consent.md): Capture, version and evidence a user's consent to a policy or privacy notice, gate access on it, and let the user withdraw it — plus what OpenIAM does and does not give a privacy officer handling a da
- [Consent and IT policy](https://docs.openiam.com/administration-guide/consent/consent-and-it-policy.md): Create a versioned, localized consent policy or privacy notice, gate a content provider with it, read the acceptance history as evidence, and let the user withdraw consent.
- [Consent data model and audit actions](https://docs.openiam.com/administration-guide/consent/consent-and-it-policy/consent-reference.md): The four consent tables and their columns, the screens that write them, the audit action each operation records, and the deprecated single-policy path.
- [Record privacy and consent](https://docs.openiam.com/administration-guide/privacy.md): Record why you process personal data and under what authority, show people versioned notices, keep an auditable consent ledger with point-in-time answers, and make access depend on consent.
- [Register purposes and lawful authorities](https://docs.openiam.com/administration-guide/privacy/register-purposes-and-authorities.md): Register the lawful authorities, processing activities and purposes your privacy program relies on, decide who is offered each purpose, and take them through review to ACTIVE.
- [Publish a privacy notice](https://docs.openiam.com/administration-guide/privacy/publish-a-privacy-notice.md): Write the notice people read before they consent, choose its language from the system language catalog, get it approved by a second administrator, and change it later — with or without asking everyone
- [What people see in the Privacy Center](https://docs.openiam.com/administration-guide/privacy/the-privacy-center.md): What a person sees and can do in the SelfService Privacy Center — which purposes they are offered, how they give and withdraw consent, receipts and history, and why preferences are kept apart from con
- [Look up a person's consent](https://docs.openiam.com/administration-guide/privacy/look-up-consent.md): Find one person's consent state per purpose, read the hash-chained ledger behind it, answer what was true on a past date, produce a consent receipt, and record an event on their behalf.
- [Ask for consent at the gateway](https://docs.openiam.com/administration-guide/privacy/enforce-consent-at-the-gateway.md): Make an application behind the Access Gateway depend on a person's consent, and send a browser that lacks it to a consent page — then back — instead of an error, while API callers get a 401 that names
- [Operate the privacy service](https://docs.openiam.com/administration-guide/privacy/operate-the-privacy-service.md): Read the privacy dashboard, clear deliveries that drifted and outbox events that failed, verify the evidence chain, and know what retention and webhook delivery do in this release.
- [Privacy reference](https://docs.openiam.com/administration-guide/privacy/privacy-reference.md): Every lifecycle status, consent event type, audience selector, audit action, property, webhook signature header and rejection message of the Privacy module, with the database tables behind them.
- [Monitor and maintain OpenIAM](https://docs.openiam.com/administration-guide/operations.md): Route to the evidence you need — a failed operation, an audit trail, a stale index, a SIEM feed or an outbound integration.
- [Which log answers which question](https://docs.openiam.com/administration-guide/operations/which-log-to-read.md): A routing page for an administrator holding a symptom — what the audit log answers, what each service log is responsible for, which one to open for a given failure, and what no log records at all.
- [Diagnose a failed operation](https://docs.openiam.com/administration-guide/operations/diagnose-a-failed-operation.md): Start from one failed operation, walk it down through the layers that each keep their own record, and finish knowing which layer failed and who owns the fix.
- [Find audit evidence](https://docs.openiam.com/administration-guide/operations/find-audit-evidence.md): Find the audit event for one specific change — where events live, how to search them, how far the trail goes back, and what it will never tell you.
- [Audit export to a SIEM](https://docs.openiam.com/administration-guide/operations/audit-and-export.md): Stream audit events to Splunk, Sentinel, QRadar or any syslog collector through an audit export connector, and prove the events arrive.
- [Rebuild a search index](https://docs.openiam.com/administration-guide/operations/rebuild-a-search-index.md): Rebuild one OpenSearch index from the Webconsole when an object is correct on its own screen but search cannot find it.
- [Rebuild the authorization graph](https://docs.openiam.com/administration-guide/operations/rebuild-the-authorization-graph.md): Establish that a stale authorization graph is why a correct membership row and a wrong effective answer coexist, and get the rebuild done through the one route that exists.
- [Timestamps off by a fixed offset](https://docs.openiam.com/administration-guide/operations/timestamps-off-by-a-fixed-offset.md): Tell the three timezone knobs apart when every audit and log timestamp is out by a whole number of hours, and hand the right one to the deployment owner.
- [Integration patterns for external systems](https://docs.openiam.com/administration-guide/operations/enterprise-integrations.md): Choose between provisioning, a manual task, an outbound ITSM script and audit export, and learn the contract an outbound script owes the workflow that calls it.
- [Reference](https://docs.openiam.com/administration-guide/reference.md): Look up a property, an enumerated value, or a shipped object without reading a task page.
- [System property reference](https://docs.openiam.com/administration-guide/reference/system-properties.md): Every system property OpenIAM ships, with its category, type, shipped default and Webconsole label.
- [Audit actions and retention](https://docs.openiam.com/administration-guide/reference/audit-actions-and-retention.md): The complete audit action catalog and the per-action retention properties that prune it.
- [Enumerated value reference](https://docs.openiam.com/administration-guide/reference/enums.md): Every enumerated value an OpenIAM administrator can choose, and the field or drop-down that offers each set.
- [User lifecycle reference](https://docs.openiam.com/administration-guide/reference/user-lifecycle-reference.md): The eleven lifecycle menu items with their resource IDs and audit actions; all 21 user statuses with what produces each; and the three properties that classify them.
- [User search configuration](https://docs.openiam.com/administration-guide/reference/user-search-configuration.md): Every column name and optional-criterion value the four user-search properties accept, with their shipped defaults and the vocabularies each search widget validates against.
- [Managed system fields and the connector request](https://docs.openiam.com/administration-guide/reference/managed-system-fields.md): The complete managed-system form — every built-in field and the column it writes, the connector-specific dynamic fields, the attribute list that reaches the connector, and worked settings for LDAP, JD
- [Shipped connectors](https://docs.openiam.com/administration-guide/reference/shipped-connectors.md): The connector definitions that ship, the queue each one names, and the per-connector symptoms that mean you are on the wrong connector rather than the wrong mapping.
- [Synchronization configuration fields](https://docs.openiam.com/administration-guide/reference/synchronization-configuration-fields.md): Every field on the synchronization form with the column behind it, the five source types, and the batch and threading defaults.
- [Synchronization script contracts](https://docs.openiam.com/administration-guide/reference/synchronization-script-contracts.md): Every synchronization script slot, the exact method signatures, all thirteen transform return codes with their numeric values and effects, and the base-class helpers.
- [Reconciliation situations and responses](https://docs.openiam.com/administration-guide/reference/reconciliation-situations-and-responses.md): The four reconciliation situations, what each of the eleven responses actually writes, and every field and script column on the reconciliation form.
- [Shipped approval workflows](https://docs.openiam.com/administration-guide/reference/shipped-workflows.md): The 49 approval workflow definitions OpenIAM ships, the process IDs you configure against, and the delegate names that appear in the log when one fails.
- [Shipped batch tasks](https://docs.openiam.com/administration-guide/reference/shipped-batch-tasks.md): Every batch task OpenIAM ships with its task ID, cron expression, backing bean and shipped enabled state, the sixteen beans a task may run, and the rows that cannot run at all.
- [Shipped mail templates](https://docs.openiam.com/administration-guide/reference/shipped-mail-templates.md): The complete inventory of shipped notification templates, so you customize an existing template instead of inventing one.
- [Shipped reports](https://docs.openiam.com/administration-guide/reference/shipped-reports.md): The reports OpenIAM ships, the reporting engine behind them, and where the definitions live.
- [Shipped Groovy scripts](https://docs.openiam.com/administration-guide/reference/shipped-groovy-scripts.md): Every Groovy script OpenIAM ships, organized by extension point, so you start from a working example.
- [Groovy script reference](https://docs.openiam.com/administration-guide/reference/groovy-script-reference.md): Where a Groovy script is stored, every column a reference to one can live in, which OpenIAM services each script family may inject, and the sandbox allow-list.
- [SoD rule and policy reference](https://docs.openiam.com/administration-guide/reference/sod-rules-and-rule-sets.md): Every value, field and table behind SoD policies, rule sets and mitigations — the enums, the rule JSON schema, how the shipped catalogs are organized, what activation creates, and the violation-report
- [Certification database tables](https://docs.openiam.com/administration-guide/reference/certification-tables.md): Every table in the certification database and every field in the ephemeral preview store, so a report or a break-glass query can be written against the right one.
- [Search indexes and the authorization graph](https://docs.openiam.com/administration-guide/reference/search-indexes.md): Every search index OpenIAM maintains, how to rebuild one, and how to rebuild the authorization graph.
- [Password and authentication policy parameters](https://docs.openiam.com/administration-guide/reference/policy-parameters.md): Every password and authentication policy parameter, its validation handler, and the values the default shipped policies use.
- [Languages and localization reference](https://docs.openiam.com/administration-guide/reference/languages.md): The languages OpenIAM ships, their codes, and how a missing translation falls back.
- [Developer Guide](https://docs.openiam.com/developer-guide/developerguide.md): Extend OpenIAM — write Groovy scripts for provisioning, synchronization, reconciliation and batch work, and integrate with the REST API.
- [Choose what you are building](https://docs.openiam.com/developer-guide/choose-what-youre-building.md): Match what you are trying to build to the pages that build it, in order.
- [Set up your environment](https://docs.openiam.com/developer-guide/set-up-your-environment.md): Create a local project with the OpenIAM libraries on the classpath, in VS Code or Eclipse, so scripts compile before you deploy them.
- [How scripting works](https://docs.openiam.com/developer-guide/how-scripting-works.md): The script types, where each one runs in a flow, what it receives, and the conventions every script follows.
- [Transformation scripts](https://docs.openiam.com/developer-guide/transformation-scripts.md): Map an inbound synchronization row onto an OpenIAM user, group or role — the base classes, the return signals, the caches, and an annotated shipped example.
- [Validation and attribute scripts](https://docs.openiam.com/developer-guide/validation-and-attribute-scripts.md): Reject unusable rows before they are processed, declare which source attributes are read, and build the identifier an account carries in a target.
- [Policy map scripts](https://docs.openiam.com/developer-guide/policy-map-scripts.md): Control whether an attribute is written to a managed system and what value it carries — isPerform, perform, the diff object, and an annotated shipped example.
- [Reconciliation scripts](https://docs.openiam.com/developer-guide/reconciliation-scripts.md): Act on the differences reconciliation finds between OpenIAM and a managed system — situations, command scripts, and an annotated shipped example.
- [Batch scripts](https://docs.openiam.com/developer-guide/batch-scripts.md): Scheduled scripts that run on their own — the context binding, reaching services, the output variable, and an annotated shipped example.
- [API fundamentals](https://docs.openiam.com/developer-guide/fundamentals.md): How to authenticate against the OpenIAM REST API, which response envelope each kind of endpoint returns, how failures are reported, and how to find the endpoint you need.
- [Your first calls](https://docs.openiam.com/developer-guide/your-first-calls.md): Authenticate, search for a user, create one, change its state and remove it — a complete first integration against a running deployment.
- [Tokens](https://docs.openiam.com/developer-guide/tokens.md): Obtain, inspect, validate, refresh and revoke an OAuth token, and end a session — the token endpoints, their parameters and their responses.
- [Managing users](https://docs.openiam.com/developer-guide/user-lifecycle.md): The provisioning API — create and update users, move them through their lifecycle, manage passwords, and read the result correctly.
- [Driving synchronization](https://docs.openiam.com/developer-guide/synchronization.md): The synchronization configuration API — manage configurations, test and run them, and work with CSV sources, including the two base paths that catch people out.
- [Common errors](https://docs.openiam.com/developer-guide/common-errors.md): The failures that span more than one page — what you see, what it means, what to do.
- [SelfService user guide](https://docs.openiam.com/end-user-guide-for-selfservice/end-user-guide-for-selfservice.md): What the SelfService portal is, who it is for, and what you can do in it.
- [Signing in](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in.md): How to sign in to SelfService, and what to expect the first time.
- [If you forgot your password](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in/forgot-password.md): Reset your own password when you cannot sign in, without calling the help desk.
- [If you forgot your user name](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in/forgot-username.md): Have your user name emailed to you when you cannot remember it.
- [Setting your security questions](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in/security-questions.md): Set and update the personal questions that let you reset your own password.
- [Registering yourself](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in/self-registration.md): Register yourself for an account when your organization offers self-registration.
- [Accepting the IT policy](https://docs.openiam.com/end-user-guide-for-selfservice/signing-in/it-policy.md): Accept your organization's IT policy, and review what you have agreed to.
- [Your profile](https://docs.openiam.com/end-user-guide-for-selfservice/your-profile.md): View your personal details, and understand which parts you can change yourself.
- [Editing your profile](https://docs.openiam.com/end-user-guide-for-selfservice/your-profile/edit-profile.md): Change your personal details, confirm a new email or phone, and understand approvals.
- [Your profile picture](https://docs.openiam.com/end-user-guide-for-selfservice/your-profile/profile-picture.md): Add, replace, or remove the photo shown on your profile.
- [Your accounts in other systems](https://docs.openiam.com/end-user-guide-for-selfservice/your-profile/your-identities.md): Understand the accounts you hold in managed systems and how they relate to you.
- [Password and security](https://docs.openiam.com/end-user-guide-for-selfservice/change-password.md): Change your password, understand the rules, and know what happens when it expires.
- [Password history](https://docs.openiam.com/end-user-guide-for-selfservice/change-password/password-history.md): See when your password was last changed and why a change was made.
- [Security keys](https://docs.openiam.com/end-user-guide-for-selfservice/change-password/security-keys.md): Register a security key or built-in authenticator so you can sign in without a password.
- [SSH keys](https://docs.openiam.com/end-user-guide-for-selfservice/change-password/ssh-keys.md): Store the SSH keys you use to connect to servers, and keep track of when they expire.
- [Devices and privacy](https://docs.openiam.com/end-user-guide-for-selfservice/my-devices.md): Pair your phone with the OpenIAM Authenticator app so it can approve your sign-ins, and remove phones you no longer have.
- [My sessions](https://docs.openiam.com/end-user-guide-for-selfservice/my-devices/my-sessions.md): See everywhere you are currently signed in, and sign out of sessions remotely.
- [Consent history](https://docs.openiam.com/end-user-guide-for-selfservice/my-devices/consent-history.md): Review the policies you have accepted and when you accepted them.
- [Your privacy choices](https://docs.openiam.com/end-user-guide-for-selfservice/my-devices/privacy-center.md): Give or withdraw your consent for each way your organization uses your personal data, read the notices behind it, and keep a record of your choices.
- [Your applications](https://docs.openiam.com/end-user-guide-for-selfservice/applications.md): Open your work applications from one place, without signing in again.
- [Your access](https://docs.openiam.com/end-user-guide-for-selfservice/your-access.md): See everything you have access to, and understand where each item came from.
- [My groups](https://docs.openiam.com/end-user-guide-for-selfservice/your-access/my-groups.md): Work with the groups you are responsible for managing.
- [Access profiles](https://docs.openiam.com/end-user-guide-for-selfservice/your-access/access-profiles.md): Request a ready-made bundle of access that matches a job, instead of asking for items one at a time.
- [Requests](https://docs.openiam.com/end-user-guide-for-selfservice/requests.md): How asking for access works, from the catalog through approval to being granted.
- [Requesting access](https://docs.openiam.com/end-user-guide-for-selfservice/requests/request-access.md): Ask for access from the service catalog, using the four-step request wizard.
- [Requesting for other people](https://docs.openiam.com/end-user-guide-for-selfservice/requests/request-for-others.md): Raise requests on behalf of colleagues, individually or for several people at once.
- [Giving up access](https://docs.openiam.com/end-user-guide-for-selfservice/requests/revoke-access.md): Hand back access you no longer need, and understand when it actually goes away.
- [Request history](https://docs.openiam.com/end-user-guide-for-selfservice/requests/request-history.md): Track what you have asked for, where each request has reached, and why it was decided.
- [Approvals and tasks](https://docs.openiam.com/end-user-guide-for-selfservice/approvals.md): Find the items waiting for your decision and understand what you are being asked.
- [Approving, rejecting, and delegating](https://docs.openiam.com/end-user-guide-for-selfservice/approvals/approve-reject-delegate.md): Make a decision on a task — approve it, reject it, or pass it to someone better placed.
- [Out of office](https://docs.openiam.com/end-user-guide-for-selfservice/approvals/out-of-office.md): Nominate someone to handle your approvals while you are away, and hand over what is already waiting.
- [Request administration](https://docs.openiam.com/end-user-guide-for-selfservice/approvals/request-administration.md): Oversee requests across your area — find stuck ones, reassign approvals, and keep things moving.
- [Access reviews](https://docs.openiam.com/end-user-guide-for-selfservice/access-reviews.md): Take part in an access review — confirm which access should stay and which should go.
- [Your team](https://docs.openiam.com/end-user-guide-for-selfservice/your-team.md): See the people who report to you and what you can do for them.
- [Acting for your team](https://docs.openiam.com/end-user-guide-for-selfservice/your-team/direct-report-operations.md): Reset passwords, review access, manage accounts, and disable users on your team.
- [Position and role changes](https://docs.openiam.com/end-user-guide-for-selfservice/your-team/position-change.md): Move someone to a new role, manager, or team, and have their access follow.
- [Leave and termination](https://docs.openiam.com/end-user-guide-for-selfservice/your-team/leave-and-termination.md): Handle someone going on leave or leaving the organization, including what happens to their mailbox.
- [Directory lookup](https://docs.openiam.com/end-user-guide-for-selfservice/directory-lookup.md): Find colleagues and see their contact details and place in the organization.
- [Your AI assistant conversations](https://docs.openiam.com/end-user-guide-for-selfservice/ai-assistant-conversations.md): Use the AI assistant in SelfService — type and send a question, ask about your access, roles and colleagues, ask about the requests you made, read its cards and tables, request access for yourself, pi
- [Reports](https://docs.openiam.com/end-user-guide-for-selfservice/reports.md): Run the reports available to you and read the results.
- [Running reports](https://docs.openiam.com/end-user-guide-for-selfservice/reports/run-reports.md): Run the reports your organization has published for you, and download the files.
- [Report subscriptions](https://docs.openiam.com/end-user-guide-for-selfservice/reports/report-subscriptions.md): Have a report generated and delivered to you automatically on a schedule.
- [For managers and delegated administrators](https://docs.openiam.com/end-user-guide-for-selfservice/for-managers.md): Tasks available to managers and delegated administrators in SelfService.
- [Creating a user](https://docs.openiam.com/end-user-guide-for-selfservice/for-managers/new-user.md): Raise a request to create an account for a new person.
- [Bulk upload](https://docs.openiam.com/end-user-guide-for-selfservice/for-managers/bulk-upload.md): Create or update many people at once from a file, and read the results.
- [Bulk password reset](https://docs.openiam.com/end-user-guide-for-selfservice/for-managers/bulk-password-reset.md): Reset passwords for a list of people at once, from a file.
- [Group management](https://docs.openiam.com/end-user-guide-for-selfservice/for-managers/group-management.md): Request a new group, clone an existing one, and manage who approves membership.
- [Glossary](https://docs.openiam.com/end-user-guide-for-selfservice/glossary.md): Plain-language definitions of the terms and abbreviations used in SelfService.
- [Connector configuration](https://docs.openiam.com/connector-configuration/connectorconfig.md): How OpenIAM connectors integrate with target systems to provision and reconcile identities and entitlements, and where to configure each one.
- [Connector parameters](https://docs.openiam.com/connector-configuration/2-configparam.md): This section describes how to define the configuration parameters for a connector
- [Microsoft application connectors](https://docs.openiam.com/connector-configuration/microsoft.md): The .NET/PowerShell connectors — what they are, how they install, and which applications they integrate with.
- [Installing PowerShell connectors](https://docs.openiam.com/connector-configuration/microsoft/1-powershellconnectorinstallation.md): This page describes how to install any PowerShell connector
- [Using PowerShell connectors](https://docs.openiam.com/connector-configuration/microsoft/2-powershellconnectorsusage.md): This page describes how to use and troubleshoot any PowerShell connector
- [Updating PowerShell connectors](https://docs.openiam.com/connector-configuration/microsoft/3-powershellconnectorupdate.md): This page describes how to update any PowerShell connector
- [Building a custom PowerShell connector](https://docs.openiam.com/connector-configuration/microsoft/15-powershell-generic.md): This page describes how to build a custom PowerShell connector for OpenIAM using a PowerShell generic connector.
- [Active Directory PowerShell connector](https://docs.openiam.com/connector-configuration/microsoft/4-adpowershell.md): This page describes how to use the OpenIAM Active Directory connector
- [Entra ID/O365 connector](https://docs.openiam.com/connector-configuration/microsoft/5-azuread.md): This page describes how to enable provisioning to Entra ID and Office365
- [Exchange connector](https://docs.openiam.com/connector-configuration/microsoft/6-exchange.md): This page describes how to enable provisioning to Exchange and Exchange online
- [Azure DevOps connector](https://docs.openiam.com/connector-configuration/microsoft/7-azuredevops.md): This page describes how to work with OpenIAM Azure DevOps connector
- [Dynamics365 connector](https://docs.openiam.com/connector-configuration/microsoft/8-dynamics365.md): This page describes how to use the OpenIAM Dynamics 365 connector
- [Dynamics365 Finance\&Operations connector](https://docs.openiam.com/connector-configuration/microsoft/12-dynamics365fo.md): This page describes how to use the OpenIAM Dynamics 365 Finance & Operations connector
- [Microsoft SQL Server connector](https://docs.openiam.com/connector-configuration/microsoft/9-sqlserver.md): This page describes how to enable provisioning to a database table
- [WinLocal OpenIAM connector](https://docs.openiam.com/connector-configuration/microsoft/10-winlocal.md): This page describes how to work with standalone Windows Server users and groups
- [AD Password Filter](https://docs.openiam.com/connector-configuration/microsoft/12-windowspasswordfilter.md): This page describes how to work with the Active Directory password filter
- [SuccessFactors connector](https://docs.openiam.com/connector-configuration/microsoft/13-successfactors.md): This page describes how to install and configure SuccessFactors connector in OpenIAM
- [Microsoft Graph PowerShell connector](https://docs.openiam.com/connector-configuration/microsoft/14-psgraph.md): This page describes how to install and configure Microsoft Graph PowerShell connector in OpenIAM.
- [Microsoft Teams connector](https://docs.openiam.com/connector-configuration/microsoft/16-teams.md): This page describes how to install and configure the Microsoft Teams connector in OpenIAM.
- [ADP connector](https://docs.openiam.com/connector-configuration/adp.md): This page describes how to enable provisioning to manage ADP HR system users.
- [Aerospike connector](https://docs.openiam.com/connector-configuration/aerospike.md): This section describes how to configure the Aerospike connector to connect with the Aerospike NoSQL, key-value, and document-oriented database.
- [AWS connector](https://docs.openiam.com/connector-configuration/aws.md): This page describes how to enable provisioning to manage AWS system users
- [Boomi connector](https://docs.openiam.com/connector-configuration/boomi.md): Configure the Boomi connector to import users, roles, and groups from Boomi AtomSphere using an API token.
- [Box connector](https://docs.openiam.com/connector-configuration/box.md): Configure the Box connector to provision users and groups to Box using a Platform App with JWT server authentication.
- [Cloud connector](https://docs.openiam.com/connector-configuration/cloud.md): The Cloud connector — a template-style connector that provisions users to a REST endpoint over HTTP(S).
- [FreeIPA connector](https://docs.openiam.com/connector-configuration/freeipa.md): This page describes how to configure a connector to integrate with FreeIPA integrated security information management solution
- [Freshdesk connector](https://docs.openiam.com/connector-configuration/freshdesk.md): Configure the Freshdesk connector to provision users as Freshdesk contacts using the Freshdesk REST API and an API key.
- [Freshservice connector](https://docs.openiam.com/connector-configuration/freshservice.md): Configure the Freshservice connector to provision agents to Freshservice using the Freshservice REST API and an API key.
- [Freshservice ticketing system](https://docs.openiam.com/connector-configuration/freshservice-ticketing.md): Connect OpenIAM's ticketing integration to a Freshservice account, so ticket rules create, update and close Freshservice tickets through the Freshservice API v2 with an agent's API key.
- [Google Workspace (GSuite) connector](https://docs.openiam.com/connector-configuration/gsuite.md): This page describes how to configure the Google Workspace connector for OpenIAM
- [Groovy Script connector](https://docs.openiam.com/connector-configuration/scriptconnector.md): This page describes how to configure and use flexible groovy script connector
- [Configuring the Groovy Script connector](https://docs.openiam.com/connector-configuration/scriptconnector/groovyscriptconnector.md): This page describes how to configure and use flexible groovy script connector
- [Developing Groovy scripts for the Script connector](https://docs.openiam.com/connector-configuration/scriptconnector/script-development.md): How to write, deploy and register the Groovy scripts that a Script connector runs — the handlers, the libraries they need, and what each one must return
- [OpenIAM connector request template](https://docs.openiam.com/connector-configuration/scriptconnector/connector-request-template.md): This page contains a template to gather technical information for building a connection with the user's application
- [JDBC connector](https://docs.openiam.com/connector-configuration/jdbc.md): This page describes how to enable provisioning to a database table with JDBC
- [Kronos connector](https://docs.openiam.com/connector-configuration/kronos.md): Configure the Kronos (UKG) connector to create, update, and search employees over the Kronos REST API.
- [LastPass connector](https://docs.openiam.com/connector-configuration/lastpass.md): Configure the LastPass connector to import users and groups from LastPass Enterprise using the provisioning API (account ID and provisioning hash).
- [LDAP connector](https://docs.openiam.com/connector-configuration/ldap.md): This page describes how to configure the LDAP connector which can be used with Active Directory and LDAP
- [Linux connector](https://docs.openiam.com/connector-configuration/linux.md): This page describes how to enable provisioning to a Linux system
- [Oracle RDBMS connector](https://docs.openiam.com/connector-configuration/oracle.md): This page describes how to enable provisioning to manage Oracle database user accounts
- [Oracle EBS connector](https://docs.openiam.com/connector-configuration/oracleebs.md): This page describes how to set up connection to Oracle EBS
- [Oracle IDCS connector](https://docs.openiam.com/connector-configuration/oracle-idcs.md): Configure the Oracle IDCS connector to provision users to Oracle Identity Cloud Service using OAuth2 client credentials.
- [PostgreSQL connector](https://docs.openiam.com/connector-configuration/postgresql.md): This page describes how to use OpenIAM PostgreSQL Connector
- [Rexx connector](https://docs.openiam.com/connector-configuration/rexx.md): This page describes how to use OpenIAM Rexx Connector
- [Salesforce.com connector](https://docs.openiam.com/connector-configuration/salesforce.md): This section describes how to enable provisioning / deprovisioning users in Salesforce.com using OpenIAM
- [SAP S/4HANA connector](https://docs.openiam.com/connector-configuration/sap.md): This page describes how to set up connection to SAP S/4 Hana
- [SAP S/4HANA reference](https://docs.openiam.com/connector-configuration/sap/sap-reference.md): What the SAP S/4HANA connector reads from SAP and how OpenIAM stores it — the role-content searches, the filter syntax, the roles and groups each SAP object becomes, the shipped metadata types and syn
- [SAP UME connector](https://docs.openiam.com/connector-configuration/sapume.md): This page describes how to set up connection to SAP UME connector
- [SAP Fiori connector](https://docs.openiam.com/connector-configuration/sap-fiori.md): Configure the SAP Fiori connector to provision users to SAP over an RFC (JCo) connection.
- [SCIM connector](https://docs.openiam.com/connector-configuration/scim.md): This page describes how to configure the SCIM connector
- [ServiceNow ticketing system](https://docs.openiam.com/connector-configuration/servicenow-ticketing.md): Connect OpenIAM's ticketing integration to a ServiceNow instance, so ticket rules create, update and close incidents, catalog tasks or other task records through the ServiceNow Table API or a custom c
- [Tableau connector](https://docs.openiam.com/connector-configuration/tableau.md): This page describes how to configure and use the Tableau connector
- [Thales connector](https://docs.openiam.com/connector-configuration/thales.md): Configure the Thales connector to provision users to the Thales (SafeNet Trusted Access) platform over its REST API.
- [Thales WSDL connector](https://docs.openiam.com/connector-configuration/thales-wsdl.md): Configure the Thales WSDL connector to provision users and groups to SafeNet Authentication Service via the BSIDCA SOAP web service.
- [Workday connector](https://docs.openiam.com/connector-configuration/workday.md): This page describes how to set up connection to Workday
- [Provisioning operations troubleshooting](https://docs.openiam.com/connector-configuration/4-troubleshootingconnector.md): This section describes how to troubleshoot bugs and explains known issues of provisioning operations
- [Troubleshooting](https://docs.openiam.com/troubleshooting/troubleshooting.md): Establish what is wrong, then find the page that fixes it — a triage route for an unknown fault, and an index of where every kind of problem is documented.
- [Getting help and escalating](https://docs.openiam.com/troubleshooting/getting-help.md): When to resolve an issue yourself versus escalate to OpenIAM support, and exactly what to collect before you open a ticket.
- [Signing in and access](https://docs.openiam.com/troubleshooting/signing-in.md): Nobody can sign in, one person cannot, or someone is in but cannot see what they should.
- [SelfService and login error messages](https://docs.openiam.com/troubleshooting/signing-in/selfservice-and-login-errors.md): Symptom-to-cause reference for the error messages end users see when signing in, changing passwords, using MFA, submitting requests, or using SSO.
- [Elasticsearch read-only state](https://docs.openiam.com/troubleshooting/signing-in/elasticsearch-readonly-state.md): Nobody can sign in because the search tier has put its indices into read-only mode after running low on disk.
- [Access forbidden error](https://docs.openiam.com/troubleshooting/signing-in/access-forbidden.md): An Access Forbidden error in the browser when every service is healthy, which is a stale authorization graph rather than a service fault.
- [Backend exception error when running authentication manager](https://docs.openiam.com/troubleshooting/signing-in/auth-manager.md): Diagnosing the gremlin backend exception the authentication manager reports, from a stopped Cassandra node through to rebuilding the entitlements graph.
- [Unlock sysadmin](https://docs.openiam.com/troubleshooting/signing-in/unlocksysadmin.md): Clearing the account-locked flags on the sysadmin account directly in the database, when the password is known but the account is locked out.
- [Error when sending activation link](https://docs.openiam.com/troubleshooting/signing-in/activationlink.md): Why an activation link does not arrive, and the separate property that governs whether the auto-generate option appears on the Reset Password screen.
- [Resetting passwords](https://docs.openiam.com/troubleshooting/signing-in/resetting_passwords.md): Resetting every password in the deployment when the encryption key is gone, which is a recovery of last resort rather than an administrative action.
- [Username not shown in SelfService](https://docs.openiam.com/troubleshooting/signing-in/username_in_selfservice.md): Showing a user their own account logins on the My Profile page in SelfService, which is off until an administrator adds the field.
- [The message broker](https://docs.openiam.com/troubleshooting/message-broker.md): RabbitMQ — a cluster that will not form, a management UI you cannot reach, and a queue the consumer cannot get past.
- [RabbitMQ cluster went out of order](https://docs.openiam.com/troubleshooting/message-broker/1-rabbitmq-reinit.md): Re-initializing a RabbitMQ cluster that has lost its state, and the vhost and permission set the OpenIAM services need back afterwards.
- [RabbitMQ connection timeout issue](https://docs.openiam.com/troubleshooting/message-broker/3-rabbitmq-connection-timeout.md): Why no OpenIAM service starts when RabbitMQ's own hostname does not resolve, and how to match the Mnesia hostname to the server.
- [RabbitMQ is not reached from UI in RPM installations](https://docs.openiam.com/troubleshooting/message-broker/2-rabbitmq-ui.md): Reaching the RabbitMQ management UI through OpenIAM on an RPM deployment, by routing it with a content provider.
- [ESB restarts in a loop over one audit log message](https://docs.openiam.com/troubleshooting/message-broker/4-audit-queue-poison-message.md): This section describes the audit log queue's dead-letter queue and how to inspect a message that no consumer can process
- [Databases](https://docs.openiam.com/troubleshooting/databases.md): Schema migrations that will not validate, write conflicts under load, and a corrupted encryption block.
- [Run Flyway in repair mode](https://docs.openiam.com/troubleshooting/databases/run_flyway_repair_mode.md): Clearing a Flyway checksum mismatch by running the migration in repair mode, then putting the command back.
- [Flyway version issue](https://docs.openiam.com/troubleshooting/databases/flyway_version.md): The Flyway error that stops an installation on SQL Server, which reports an edition problem but means the database version is below the supported floor.
- [MariaDB "Record has changed since last read" errors](https://docs.openiam.com/troubleshooting/databases/mariadb-snapshot-isolation.md): MariaDB snapshot-isolation write conflicts (error 1020 / ER\_CHECKREAD), how OpenIAM retries them automatically, and how to tune the retry.
- [PAD block corrupted](https://docs.openiam.com/troubleshooting/databases/pad-block-corrupted.md): Recovering from PAD block corruption, which means rebuilding the secret store — so every secret it holds has to be captured first.
- [Memory, storage and performance](https://docs.openiam.com/troubleshooting/performance.md): Memory, disk, swap and connection pools — the host running out of something, or a service not allowed enough of it.
- [Check memory utilization](https://docs.openiam.com/troubleshooting/performance/memoryutili.md): Finding how much memory each Java service is allowed and what it is actually using, including a heap summary from a running process.
- [Redis memory utilization](https://docs.openiam.com/troubleshooting/performance/redismemory.md): Reading what the Redis cache is using, whether it has a memory cap, and what the broker does when it reaches one.
- [Running out of disk space](https://docs.openiam.com/troubleshooting/performance/lackof_disk_space.md): Finding what has filled the disk on an OpenIAM host and reclaiming it, from container images to the systemd journal.
- [Increasing memory for OpenIAM services](https://docs.openiam.com/troubleshooting/performance/increasing-ram.md): This document explains how to increase memory to accommodate OpenIAM services.
- [Increasing the JDBC connection pool size](https://docs.openiam.com/troubleshooting/performance/jdbc-connection-pool.md): Raising the JDBC connection pool size when load testing exhausts it, and where to set it on each deployment type.
- [Disable swap](https://docs.openiam.com/troubleshooting/performance/disableswap.md): Confirming swap is disabled and keeping it off across reboots, which OpenIAM requires rather than merely prefers.
- [Changing refresh time for my applications page in SelfService](https://docs.openiam.com/troubleshooting/performance/my-application-page-selfservice.md): Why a change to an application takes up to 50 minutes to appear on the My Applications page in SelfService, and which cache timer to shorten.
- [Logs and diagnostics](https://docs.openiam.com/troubleshooting/logs-and-diagnostics.md): Turning up the detail, and the two things that go wrong with audit documents and reports.
- [Enabling and disabling debug logs for Cassandra and JanusGraph](https://docs.openiam.com/troubleshooting/logs-and-diagnostics/debug-logs-cassandrajanusgraph.md): Turning DEBUG logging on and off for Cassandra and JanusGraph, and putting the configuration back afterwards.
- [Audit document timestamp issue](https://docs.openiam.com/troubleshooting/logs-and-diagnostics/audit-doc-timestamp.md): This section describes the resolution for audit document timestamp issue.
- [Error during report generating in RPM installations](https://docs.openiam.com/troubleshooting/logs-and-diagnostics/report-generation-issue.md): Reports that fail to generate on an RPM deployment because the host has no fonts for the reporting engine to render with.
- [Audit log export errors](https://docs.openiam.com/troubleshooting/logs-and-diagnostics/audit-log-export-errors.md): Error codes and log messages from the audit log export connectors, with the cause and the action for each.
- [Interface customization](https://docs.openiam.com/troubleshooting/interface.md): Changing what the Webconsole and SelfService show — labels, menu items and the properties behind them.
- [Changing system labels and messages](https://docs.openiam.com/troubleshooting/interface/changing-system-labels-and-messages.md): Overriding the labels and messages shown in the OpenIAM interface, for English and for any other locale the deployment offers.
- [Removing menu items from top navigation bar](https://docs.openiam.com/troubleshooting/interface/remove-navigation-bar.md): Taking Edit profile and Change password off the SelfService top navigation bar, and why the change needs two saves.
- [Overriding UI application properties](https://docs.openiam.com/troubleshooting/interface/overriding-app-properties.md): Changing the behavior of the OpenIAM interface by overriding a UI application property, on each deployment type.
- [Synchronization and connectors](https://docs.openiam.com/troubleshooting/connectors.md): Synchronization runs, the connector source they read through, and where the per-connector pages are.
- [Troubleshooting a synchronization run](https://docs.openiam.com/troubleshooting/connectors/synchronization-runs.md): Triage a synchronization run that failed, did nothing, or did the wrong thing — which of the four start-up gates stopped it, and what evidence each leaves.
- [The connector synchronization source](https://docs.openiam.com/troubleshooting/connectors/sync-vs-async-source.md): What the connector synchronization source does, and what a configuration still set to the retired CONNECTOR value tells you about the upgrade.
- [Deployment routes](https://docs.openiam.com/troubleshooting/deployment.md): Problems belonging to the deployment route rather than to OpenIAM — package dependencies on RPM, and working through a Kubernetes cluster.
- [Troubleshooting a Kubernetes cluster](https://docs.openiam.com/troubleshooting/deployment/kubernetes.md): Working through an OpenIAM cluster on Kubernetes from the nodes inward, and collecting a log excerpt to send with a ticket.
- [Troubleshooting guide for RPM](https://docs.openiam.com/troubleshooting/deployment/troubleshooting-guide.md): Collecting the right logs from an RPM deployment — for a failed installation, for one service, and for a problem you can reproduce on demand.
- [Failed dependencies](https://docs.openiam.com/troubleshooting/deployment/failed-dependencies.md): The failed-dependencies error when installing the OpenIAM RPM, why the documented install command does not produce it, and what to do when yum cannot reach its repositories.

## What's new in OpenIAM

- [What's new in OpenIAM](https://docs.openiam.com/whats-new-in-openiam/readme.md): New updates and improvements
- [Earlier releases](https://docs.openiam.com/whats-new-in-openiam/earlier-releases.md): Release notes for the 4.2.x line
- [2026](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2026.md): OpenIAM releases from 2026
- [4.2.1.18](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2026/v4-2-1-18.md): Released 5 August 2026
- [4.2.1.17](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2026/v4-2-1-17.md): Released 9 June 2026
- [4.2.1.16](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2026/v4-2-1-16.md): Released 17 February 2026
- [2025](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025.md): OpenIAM releases from 2025
- [4.2.2](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025/v4-2-2.md): Released 7 December 2025
- [4.2.1.15](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025/v4-2-1-15.md): Released 30 July 2025
- [4.2.1.14](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025/v4-2-1-14.md): Released 14 June 2025
- [4.2.1.13](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025/v4-2-1-13.md): Released 28 February 2025
- [4.2.1.12](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2025/v4-2-1-12.md): Released 13 January 2025
- [2024](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2024.md): OpenIAM releases from 2024
- [4.2.1.11](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2024/v4-2-1-11.md): Released 21 October 2024
- [4.2.1.10](https://docs.openiam.com/whats-new-in-openiam/earlier-releases/2024/v4-2-1-10.md): Released 15 July 2024


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openiam.com/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
