Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

Account

object

  • idstringrequired

  • namestringrequired

  • emailstringrequired

  • sqlNamestringrequiredpattern ^[a-z][a-z0-9_]{2,31}$

    The account's SQL name, unique on the instance. Derived from the display name (else the email's local part, else the word user, with a number added on a collision or a name the query engine reserves) when the account is created or upgraded, and fixed thereafter: changing the name or email never changes it.

  • isAdminbooleanrequired

  • pictureVersionstring

    The version of the person's picture, present while they have one and new whenever it is replaced; absent while they have none, when their initials stand in. GET /api/accounts/{sqlName}/picture?v=<version> reads it.

  • statusstringrequired

    One of invited, active, deactivated

  • isOriginalbooleanrequired

  • createdAtstringrequired

  • updatedAtstringrequired

  • lastSignInAtstringor nullrequired

No other keys.

Dezfil · Apache-2.0docs from 7439201b