List the caller's sessions or all sessions

Overview

List the caller's sessions or all sessions. The authentication API establishes identity and manages the roles, grants, sessions, and service credentials used for authorization.

When to use it

• Use it when an application needs to list the caller's sessions or all sessions.
• Use it when a client needs to sign in, inspect its identity, or an administrator needs to manage access.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/auth/sessions" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "entries": [
    {
      "id": "string",
      "principal_id": "00000000-0000-4000-8000-000000000001",
      "created_at_ns": 0,
      "last_seen_ns": 0,
      "absolute_expiry_ns": 0
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to list the caller's sessions or all sessions. The documented 200 response is sessions.

How it works

Reference

Required capability

authenticated

Authorization scope

self, or all sessions with admin when all=true

{
  "entries": [
    {
      "id": "string",
      "principal_id": "00000000-0000-4000-8000-000000000001",
      "created_at_ns": 0,
      "last_seen_ns": 0,
      "absolute_expiry_ns": 0
    }
  ]
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/auth/sessions`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);