1. Docs
  2. API Reference
  3. IdentitySessionResponseDto

IdentitySessionResponseDto

Example

JSON
{
  "id": "string",
  "created_at": "2026-04-20T12:00:00.000Z",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "ip_address": "string",
  "user_agent": "string",
  "active_org_node_id": "string"
}

Properties

6 properties 3 required

id string Required

The session's current refresh token id: what `DELETE /identities/:id/sessions/:sessionId` takes. It changes on every refresh.

created_at string Required
format: date-time
expires_at string Required
format: date-time
ip_address string Optional

The address the session was signed in from: the browser's for a hosted sign-in, or the one a trusted backend forwarded in `X-Canopy-Client-IP`.

nullable
user_agent string Optional

The user agent the session was signed in from: the browser's for a hosted sign-in, or the one a trusted backend forwarded in `X-Canopy-Client-User-Agent`.

nullable
active_org_node_id string Optional

The organization the session is acting in, the source of its tokens' `org_id` claim. Null when the Environment's organizations container is off or the identity belongs to none.

nullable
Was this page helpful?

Tell us how we can improve this guide.

Canopy