About these manuals
OktoID is a national-scale self-sovereign digital identity platform. These manuals explain how to use it. There is one manual per audience, because each audience comes with a different question, and one manual that tried to answer all of them would answer none of them well.
Who each manual is for
| Manual | For | The question it answers |
|---|---|---|
| Operator guide | Whoever runs the deployment | How do I run this, and what do I do when it breaks |
| Governance guide | The governance authority's staff | How do I admit an organization, author a policy, and withdraw trust |
| Entity administrator guide | Staff at issuing and verifying organizations | How do I design a credential, issue one, and verify one |
| Integrator guide | Engineers connecting their own systems | How do I call OktoID from my system |
| Holder help | Citizens, and the support staff who answer them | Where is my credential, and is this message real |
| Engineer handbook | The engineers who maintain and extend the platform | How is this built, and how do I extend it |
A manual is published together with the capability it describes. A manual you cannot find here describes something that has not been delivered yet.
How the documentation is arranged
The top bar has one entry per audience, and a reference that all of them share.
| Entry | For | Holds |
|---|---|---|
| Integrate | Engineers connecting their own systems | The integrator guide |
| SDKs | Developers building with OktoID's libraries, and the engineers who maintain the platform | The engineer handbook |
| Operate | Whoever runs the deployment | The operator guide |
| Govern | The governance authority's staff, and the administrators of organizations | The governance guide and the entity administrator guide |
| Reference | Everyone | The HTTP API, one page per operation, and the shared packages |
Within an entry, every page is one of three kinds:
- a tutorial takes you through one journey from start to finish. Start with one when you are new to OktoID;
- a how-to guide solves one task, for a reader who already knows the product;
- a concept page explains why something is the shape it is.
The reference states what each operation and each package is, exhaustively, and nothing else. It is generated from the platform's source rather than written by hand.
Which version you are reading
Every page belongs to a version of the platform. The version selector at the top of the page shows which one you are reading. Choose the version your deployment runs: a page from another version can describe screens, settings or steps that differ from the ones in front of you.
The version labelled Unreleased describes work that is not yet in a release.
Languages and search
The manuals are in English and Arabic. Switch between them with the language selector at the top of the page; the Arabic edition reads right to left.
Search works without an internet connection, because the search index is part of the site. It searches the language you are reading.
Getting a PDF
Each manual can be printed to a PDF with page numbers, from the same source as these pages, for acceptance packs and printed copies. One PDF is produced per language. With a copy of the repository, after building the site, run:
pnpm --filter @oktoid/docs-site pdf
Otherwise, ask the team that maintains your deployment for the PDF of the version you run.