Back to API overview

Sessions

3 endpoints

Active sessions with device metadata — list and revoke access.

sessions.read
sessions.revoke

List and revoke active user sessions for a sub-organization.

Authenticate with your organization API key. Include subOrgId as a query parameter or in the request body when using an org-wide key. Sub-org-scoped keys automatically target their sub-organization.
GET
/v1/sessions

List active sessions grouped by user. Requires sessions.read.

Query Parameters

ParamTypeRequiredDescription
subOrgIdstringNoSub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org.

Response — 200

{ "users": [ { "user_id": "...", "sessions": [ /* ... */ ] } ] }
DELETE
/v1/sessions

Revoke all sessions for a user. Requires sessions.revoke.

Query Parameters

ParamTypeRequiredDescription
subOrgIdstringYesSub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org.
userIdstringYesDirectory user ID

Response — 200

{ "success": true }
DELETE
/v1/sessions/{sessionId}

Revoke a single session. Requires sessions.revoke.

Query Parameters

ParamTypeRequiredDescription
subOrgIdstringNoSub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org.

Response — 200

{ "success": true }