Developer guides
Guides for the CyberSentriq API, grouped by where you are: get started, authenticate, then call the endpoints.
Get started
Using this reference
How to read the interactive API reference, try a request, and declare what you rely on.
API contract and stability
What the API promises, what can change without notice, and how you are notified before it does.
End-to-end example
Authenticate, check connectivity, call an authenticated endpoint, handle a 401 and refresh.
Authentication
Authentication overview
The two ways to authenticate to the CyberSentriq API, and the facts common to both.
User and device-code authentication
Sign in as a person with the OAuth 2.0 device-code flow or the PKCE loopback flow.
Service account and M2M authentication
Authenticate a backend service with the client-credentials grant, and provision the credentials programmatically.
Refreshing tokens
Keep a session alive for native clients and machine-to-machine callers.
Step-up MFA for sensitive actions
Why some write calls return 403 step_up_required, how to detect it, and how to re-authenticate and retry.
Permissions in your token
What the permissions claim carries, the full catalog a tenant can hold, and the coarse access scopes to request today.
Endpoints
Endpoints you call
The public API surface: what is live today, and how versioning and the base URL work.
Your identity
Make your first authenticated call: return the caller's own identity record, with versioning and error handling.
Invite a user to your organization
Create an organization invitation for a user in your own organization, with versioning and error handling.
Manage machine-to-machine credentials
Create, list, rotate, rename and revoke the machine-to-machine credentials your organization uses to call the API.
Reading with an agent? Every guide is also available as clean markdown at /guides/<slug>.md, and they are listed for machines in llms.txt.