Sign in
Sessions

List sessions

Returns sessions in the specified zone. By default, returns entry sessions (app user sessions with an initiator that are roots or direct children of a root user session). Use include_nested=true to include nested sessions. Can be filtered by session type, status, and user.

get/zones/{zoneId}/sessions

Path parameters

zoneIdstring required

Zone ID

Query parameters

session_type'user' | 'application'
active'true'
status'active' | 'expired' | 'revoked'
user_idstring

Filter by user ID

include_nested'true'

Include nested sessions. When false (default), only returns entry sessions (direct children of root user sessions). When true, returns all sessions with an initiator, including nested sessions.

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]

Response

Default Response

Changes

Changed in 12 of the 23 revisions of this API.431

  • d65d51379d938See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/credentials to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/groups to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/role_assignments/items/group_id to the response with the 200 status

      response-optional-property-added

    • ○

      the items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/role_assignments/items/role_identifier response's property pattern ^[a-z0-9]+(?:[-_][a-z0-9]+)*$ was added for the status 200

      response-property-pattern-added

    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/role_assignments/items/role_owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/role_assignments/items/source to the response with the 200 status

      response-required-property-added

  • 2f5033ed44912See the full diff
    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/application/allOf[subschema #1: Application]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #2: Application Session Type]/application/allOf[subschema #1: Application]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

  • 1a0dd4d857ee1See the full diff
    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/status to the response with the 200 status

      response-required-property-added

  • 7e0e4fa2e16f1See the full diff
    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/role_assignments to the response with the 200 status

      response-optional-property-added

  • ffb6f697525f2See the full diff
    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/grant_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/session_count to the response with the 200 status

      response-optional-property-added

  • 932699a5ea162See the full diff
    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/application/allOf[subschema #1: Application]/consent to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #2: Application Session Type]/application/allOf[subschema #1: Application]/consent to the response with the 200 status

      response-required-property-added

  • aee6e66de0d31See the full diff
    • ○

      added the required property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/user/allOf[subschema #1: User]/identifier to the response with the 200 status

      response-required-property-added

  • d3d69f45bfed23See the full diff
    • ●

      removed the optional property items/items/allOf[subschema #2]/anyOf[subschema #1: User Session Type]/application/allOf[subschema #1: Application]/traits from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/items/allOf[subschema #2]/anyOf[subschema #2: Application Session Type]/application/allOf[subschema #1: Application]/traits from the response with the 200 status

      response-optional-property-removed

    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f4daf41e69b32See the full diff
    • ○

      added subschema #1 subschema #2 to the items/items/ response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed subschema #1 subschema #2 from the items/items/ response property allOf list for the response status 200

      response-property-all-of-removed

  • cb43483cd1b38See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter before

      new-optional-request-parameter

    • ○

      added the new optional query request parameter expand[]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter include_nested

      new-optional-request-parameter

    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added subschema #1 subschema #2 to the items/items/ response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed subschema #1 subschema #2 from the items/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      added the required property pagination to the response with the 200 status

      response-required-property-added