DOCUMENTATIONv2

GET

Authentication

List sessions

/api/v2/auth/sessions

AUTHENTICATIONBearer token · sessions:readAUTHORITATIVE OWNERidentity-access · identity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List the authenticated identity's current and historical V2 client sessions.

WHEN THIS CALL IS USEFUL

Call this from account security, device management, or incident response to inventory current and historical sessions before deciding whether a session must be revoked.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover sessions.
Makes credential and account-lifecycle transitions explicit while keeping passwords, authenticator secrets, recovery codes, refresh tokens, devices, sessions, and account state under separate controls.

ISOLATION + AUTHORITY

Tenant identity, profile, password, authenticator enrollment, recovery code, device, session, access token, refresh credential, step-up grant, and account-closure state remain distinct. Authentication proves only the admitted session and scopes; it grants no workspace role, wallet, payment, settlement, publisher, matching, or trading authority.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the tenant, account lifecycle, client device, credential state, authenticator or recovery basis, and required step-up purpose for this security transition.

WHAT TO DO NEXT

Compare device identity, issue and activity times, lifecycle status, and revocation posture before selecting a session.
Revoke an unrecognized or no-longer-needed session through the dedicated revocation operation and then refresh this inventory.

AGENT GUIDANCE

Use sessions only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Keep registration, activation, credential verification, session issuance, refresh rotation, authenticator enrollment, confirmation, recovery, revocation, and account closure as separate lifecycle transitions.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the sessions:read scope.EXAMPLEBearer hc_live_…

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published identity-security schema.

400invalid_security_requestThe session, scope, public key, proof, or purpose-bound security request is invalid.

401invalid_credentialsThe bearer, client assertion, or proof-of-possession credential is invalid.

403step_up_requiredFresh purpose-bound authenticator verification or stronger authority is required.

404signing_key_not_foundThe requested signing-key or workload-client resource was not found.

409security_conflictThe requested identity-security transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

200Current and historical client sessions for the authenticated identity.Read completed · JSON RESPONSE+

{
  "data": {
    "current_session_id": "9b51ed4c9c8f4aec85d1bd5520e40557",
    "sessions": [
      {
        "session_id": "9b51ed4c9c8f4aec85d1bd5520e40557",
        "device_id": "web-client-7f4c2109",
        "device_name": "Firefox on macOS",
        "platform": "web",
        "status": "ACTIVE",
        "current": true,
        "push_enabled": false,
        "passkey_capable": false
      }
    ],
    "capabilities": {
      "step_up": true,
      "passkey_registration": true,
      "push_registration": true
    }
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then compare device identity, issue and activity times, lifecycle status, and revocation posture before selecting a session.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.

401The access token is invalid, expired, or revoked.Authentication required · JSON RESPONSE+

{
  "code": "invalid_session_credential",
  "message": "The access token is invalid, expired, or revoked."
}

INTEGRATION DECISIONinvalid_session_credential

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for accounts, activations, sessions, authenticators, step-up grants, workload identities, keys, and revocations.
ESCALATE WHEN: Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.

503Identity session management is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_unavailable",
  "message": "Identity session management is unavailable."
}

INTEGRATION DECISIONidentity_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the relevant account, session, authenticator, client, key, or one-time transaction state; replace consumed or expired credentials instead of replaying them.
ESCALATE WHEN: Escalate when account or tenant binding, session revocation, authenticator state, key rotation, or one-time-token consumption cannot be reconciled securely.

OPERATIONAL NOTES

Security and lifecycle guarantees

Session inventory is owned by Identity and is never assembled from client claims.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/auth/seedAUTH: Get Seed

GET/api/v1/auth/seedsAUTH: Get Multi-Tenant Seeds

GET/api/v1/sessions/activeSESSION: Get Active Sessions

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗