Member details#

PropertyValue
Servicecrossfire
Operationmember
MethodGET
Path/api/members/{memberId}
Authenticationhuman
Success status200
Response dataUnpaginated value
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesmember.manage

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#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
memberIdlowercase opaque UUID

Validation#

check.object({ memberId: check.identifier })

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 ( member )

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

Validation#

res.member

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"
  }
}