Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cativa.digital/llms.txt

Use this file to discover all available pages before exploring further.

Every integration with Cativa starts with the user. This page describes the User model at the conceptual level and the canonical endpoint for credential validation.

​
The User model

Each Cativa user belongs to exactly one tenant and is identified by an id (GUID). Fields visible in authenticated responses include basic identity (email, firstName, lastName, displayName, userName), the public picture URL (pictureUrl), the community role, account status and the customer (tenant) the user belongs to.
The detailed contract for each response (including exact field names and types) will be published per-endpoint along with the public API catalog soon.

​
Validate credentials and discover the associated user

The single canonical endpoint for partners to validate a credential and discover the associated user is GET /social/v1/auth/me: 
curl https://apis.cativalab.digital/social/v1/auth/me \
  -H "Authorization: Bearer cativa_live_..."
Use the response to:
  • Confirm your key is valid and points to the right tenant (the customer field).
  • Capture the id of the user tied to the key (useful for your own logs and audit).
  • Refresh the session via the returned accessToken / refreshToken.

​
Upsert pattern from an external user

Public POST/PATCH/DELETE /users endpoints for external partners (CRM sync, creating a user from an external purchase, soft-delete) are coming soon. Until then, align with the Cativa team at dev@cativa.digital to discuss the flow for your specific case.

​
Next steps

Badges as Permissions

How to assign credentials to a user to grant access to groups and courses.

Communities and Spaces

Where the user fits in the Community > Space > Group hierarchy.