> For the complete documentation index, see [llms.txt](https://docs-beta.openiam.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-beta.openiam.com/readme.md). # OpenIAM Documentation Product documentation for the OpenIAM identity platform — deploying it, designing with it, administering it, extending it, and using it. OpenIAM is a self-hosted identity governance and administration platform. Everything — the identity services, message bus, secrets vault, graph and search engines, database and monitoring — runs on infrastructure you control. These guides are organised by what you are trying to do. Each one assumes you have not read the others. ## Start here **New to OpenIAM?** [*Getting started*](/getting-started-guide/getting-started.md) takes you from two empty virtual machines to a working, verified proof of concept — installation, an Active Directory connector, a synchronised user, and a provisioned account. It is the fastest route to seeing the platform actually work. ## The guides | Guide | Use it for | | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [**Getting started**](/getting-started-guide/getting-started.md) | Building a proof of concept from nothing, end to end | | [**Installation**](/installation/installation.md) | Deploying for real — one host, three hosts, or Kubernetes, on your own infrastructure or in AWS or Azure | | [**Solution architecture and design**](/solution-architecture/solution-architecture.md) | The decisions taken before anyone opens the console — authoritative sources, identity correlation, where authentication lives, the role and SoD model, deployment topology and sizing, and how OpenIAM coexists with a platform you are not replacing yet | | [**Administration**](/administration-guide/admin.md) | Running the platform — identities, access, policy, workflows, certification, segregation of duties, federation and reporting | | [**Developer**](/developer-guide/developerguide.md) | Extending it — Groovy scripts for provisioning and synchronisation, and the REST API | | [**SelfService user guide**](/end-user-guide-for-selfservice/end-user-guide-for-selfservice.md) | For the people who use the portal: requesting access, approvals, reviews, and managing your own account | | [**Connector configuration**](/connector-configuration/connectorconfig.md) | Configuring a specific connector — Active Directory, LDAP, SAP, Workday, ServiceNow and the rest | | [**Troubleshooting**](/troubleshooting/troubleshooting.md) | When something is not working | ## Which guide answers my question? | I want to… | Go to | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | See what OpenIAM does, quickly | [Getting started](/getting-started-guide/getting-started.md) | | Choose a deployment shape, size it, or design the identity model | [Solution architecture and design](/solution-architecture/solution-architecture.md) | | Install or upgrade a real deployment | [Installation](/installation/installation.md) | | Connect an application or directory | [Connector configuration](/connector-configuration/connectorconfig.md), then [Administration](/administration-guide/admin.md) | | Automate joiners, movers and leavers | [Administration](/administration-guide/admin.md) | | Run an access review or certification campaign | [Administration](/administration-guide/admin.md) | | Write a Groovy script or call the API | [Developer](/developer-guide/developerguide.md) | | Request access, approve a request, or reset my password | [SelfService user guide](/end-user-guide-for-selfservice/end-user-guide-for-selfservice.md) | | Work out why something failed | [Troubleshooting](/troubleshooting/troubleshooting.md) | | See what changed in a release | [What's new](https://docs-beta.openiam.com/whats-new-in-openiam/) | {% hint style="info" %} **Each page states the release it was written against.** Look for *Applies to* at the foot of a page, or the `appliesTo` value in its header. Where a page has been checked against a running deployment, it also carries the date of that check. {% endhint %} --- # 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 If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs-beta.openiam.com/readme.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.