Skip to navigation

Get the authenticated user

Serves your own row: the actor you are — a member (USER, with userId) or an API key (API_KEY, with apiKeyId) — your name, status, capabilities as scope strings and your organisation’s name. A verified invited address claims its invitation here. Configure a client from this, never from the token; approval rules are GET /approval-rules. Its version is PUT /me’s If-Match.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

The caller’s row, rendered as the guide’s Reads section describes: the position headers and body field, the ETag (the row’s version, which PUT /me takes as If-Match).

actorobject

Who you are: USER with your user id, or API_KEY with the key’s id.

apiKeyIdinteger or null

Your key id — an API key’s; null for a member.

capabilitieslist of enums

Your capabilities, as your row serves them: scope strings in declared order; empty = none.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

lastActiveAtNsstring or nullformat: "^[0-9]+$"

When the principal was last seen acting — its last admitted request on this API (one a read replica serves is not recorded), or its open trading socket — epoch nanoseconds at a five-minute grain: a request inside five minutes of the mark need not move it, so read it as active within five minutes of this time. null while no mark is recorded: the principal has not acted since marks were first kept (0.71.0), or ever. A mark beside the row, not a field of it: it moves no version and no ETag.

namestring

Your platform name — a member’s, or the key’s name as issued.

orgIdinteger

Membership — stamped by the owner from the actor’s org; an organisation’s first administrator belongs to the organisation its creation mints.

orgNamestring

The organisation’s name: unique among live organisations when it is created, a label from then on — an organisation renames itself, and two may carry one name. At most 128 bytes; longer refuses INVALID_FIELD.

statusenum

Your standing: ACTIVE — the only standing this route answers; a DISABLED member or key is refused 403 FORBIDDEN_PRINCIPAL at admission.

Allowed values:
userIdinteger or null

Your user id — a member’s; null for an API key.

versionstringformat: "^-?[0-9]+$"

Your row’s version as a decimal string — a member’s user row’s, the key’s own on an API key. PUT /me takes it as If-Match, quoted as the ETag carries it: "<version>".

Errors

400
Get Me Users Request Bad Request Error
401
Get Me Users Request Unauthorized Error
403
Get Me Users Request Forbidden Error
503
Get Me Users Request Service Unavailable Error