List active sessions

GET

/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/sessions

curl --request GET \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/applications/example/sessions \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

• Local development

Returns the currently active user sessions for the application.

Required scope: applications:read

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

cluster_id

required

string format: uuid

realm_name

required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

string

>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

Example

customer-portal

client_id

required

OAuth 2.0 client identifier. Used as the stable resource identifier in this API and in Keycloak realm URLs.

string

>= 1 characters <= 255 characters

Header Parameters

API-Version

required

string

Allowed values: 2026-06-01.beta

Responses

200

The request has succeeded.

Media typeapplication/json

Array<object>

An active user session for an application.

object

id

required

Session identifier.

string

user_id

required

Keycloak user ID.

string

username

required

Username of the authenticated user.

string

email

Email of the authenticated user.

string

ip_address

IP address the session originated from.

string

started_at

required

When the session started.

string format: date-time

last_access_at

required

When the session was last active.

string format: date-time

Example ^generated

[
  {
    "id": "example",
    "user_id": "example",
    "username": "example",
    "email": "example",
    "ip_address": "example",
    "started_at": "2026-04-15T12:00:00Z",
    "last_access_at": "2026-04-15T12:00:00Z"
  }
]

401

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Access is forbidden.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

429

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Retry-After

integer

RateLimit-Limit

integer

RateLimit-Remaining

integer

RateLimit-Reset

integer

X-RateLimit-Limit-Second

integer

X-RateLimit-Remaining-Second

integer

X-RateLimit-Limit-Minute

integer

X-RateLimit-Remaining-Minute

integer

X-RateLimit-Limit-Hour

integer

X-RateLimit-Remaining-Hour

integer

X-RateLimit-Limit-Day

integer

X-RateLimit-Remaining-Day

integer

500

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string format: uri

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}