Start with the task
Use the current action contract and its worked guide together. The contract supplies the exact input/output schema and execution policy; the guide explains the response, verification and recovery. This overview groups those tasks without duplicating every route or mixing public workflows with internal operator setup.
| Task | Start here |
|---|---|
| Understand identity and credential context | Authentication |
| Create or change a scoped API key | API keys and Get API key options |
| Implement third-party sign-in | Integrate with Auth |
| Find application workspaces | List application workspaces |
| Create or rename a workspace | Create workspace and Rename workspace |
| Inspect workspace access | List my workspace access and List workspace members |
| Manage resource grants | List my resource grants and Create resource grant |
| Read organizations | List organizations and Get organization |
| Inspect sessions and security | List sessions and Get user security |
| Inspect profile and notification preferences | Get my profile and List notification preferences |
| Read language and timezone preferences | Get my language and timezone preferences |
Discover the exact action
In the action reference, search and select Auth, then the action. With the CLI, search the credential-scoped catalog and inspect the exact returned action ID:
topolo whoami --json
topolo actions --service topolo-auth --query workspace --limit 25 --json
Use topolo actions get for the discovered ID and inspect its schemas, effects, examples, verification and recovery. MCP exposes the same discovery through topolo_search_actions and topolo_get_action. A missing example or incomplete recovery contract is a documentation gap; it is not permission to guess a route or operation.
Prepare and verify
- Resolve the action's identifiers and resource boundary in the current credential context.
- Validate the exact input against the published schema.
- Plan the action, including confirmation for a mutation that has been reviewed and authorized.
- Execute that unchanged selection and follow its verification steps immediately.
- If the call was interrupted or a read-back differs, use its recovery guidance before another mutation.
An HTTP method alone does not establish effects. Workspace discovery can provision a default, and some mutations can fail after a partial write. Read the selected task guide instead of assuming every GET is side-effect free or every error means nothing changed.
Human and agent documentation
The normal pages present task explanations, copyable code, response meanings and worked examples. Their separately typed agent guidance carries execution prerequisites and boundaries for machine retrieval. Hidden guidance is part of the same immutable reviewed version; it is not an additional access grant or a reason to expose a restricted guide publicly.
Internal service credentials, billing provisioning, registry repair and platform-only policy actions require their authenticated restricted guides and current runtime authorization. Public documentation does not expose their setup secrets or turn them into customer capabilities.
Use the per-action guide's evidence limits. A captured local handler response proves behavior under its declared dependencies; it does not prove your live permission, downstream persistence or a successful external login.