Current human session#

PropertyValue
Servicecrossfire
OperationcurrentSession
MethodGET
Path/api/sessions/current
Authenticationhuman
Success status200
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesNone declared

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

Path parameters#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

Response data#

object; fields below; unknown fields rejected ( session )

Field pathRepresentation and constraints
memberobject; fields below; unknown fields rejected ( member )
member.memberIdlowercase opaque UUID
member.matrixUserIdwell-formed Matrix user ID; maximum 255 UTF-16 units
member.displayNamestring; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls
member.roleCodemember or administrator
member.statusvalidator choice('active', 'suspended', 'revoked') ( status )
member.revisionexact JSON integer; 0…9007199254740991
member.createdAtexact JSON integer; 0…9007199254740991
member.applicationobject; fields below; unknown fields rejected ( application )
member.application.appliedRevisionexact JSON integer; 0…9007199254740991; JSON null permitted
member.application.appliedStatusvalidator choice('active', 'suspended', 'revoked') ( status ); JSON null permitted
member.application.nativeDisplayNamestring; 1–255 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
member.application.lastAttemptAtexact JSON integer; 0…9007199254740991; JSON null permitted
member.application.lastSuccessAtexact JSON integer; 0…9007199254740991; JSON null permitted
member.application.errorCodestring; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
member.application.errorMessagestring; 1–4096 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
csrfSecret43-character base64url private claim (32 bytes)
permissionsarray; 0–100 entries; item: string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls

Validation#

res.session

Referenced definitions:

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}