Identity.Base Docs

Operational Playbooks

The upstream repository includes step-by-step playbooks for common rollout and validation tasks. They are more prescriptive than the docs pages and are meant to be executed directly by developers, operators, or automation.

Full-stack smoke

Use the upstream full-stack-smoke-test playbook when you need to prove that the host, token issuance, health checks, and optional org flows all work together.

Admin API smoke

The admin smoke playbook exercises permissions, user lifecycle operations, role assignment, and soft delete/restore flows end to end.

React PKCE login smoke

The React playbook walks through sample-client setup, PKCE redirect flow, and verifying the SPA can exchange an authorization code for tokens.

Email and seed playbooks

The repo also ships task playbooks for MailJet enablement, role seeding, database migrations, and organization invitation flows.

Machine credential lifecycle

Use the service-principal guide as the rollout checklist for both migrations, least-privilege roles, one-time secret capture, token verification, rotation, and revocation.

How to use the playbooks well

  • Treat docs pages as architecture and integration reference; treat playbooks as execution checklists.
  • Use them in CI or QA when you need repeatable validation of login, admin operations, service credentials, or organization onboarding.
  • Adapt the commands to your actual host names, client IDs, and secrets instead of copying them verbatim into production automation.