Skip to main content

UserDto

User data transfer object

accessGroups object[]required

Access groups the user belongs to, sorted by name

  • Array [
  • idstring<uuid>required

    Access group ID

    Example: 550e8400-e29b-41d4-a716-446655440000
    namestringrequired

    Access group name

    Example: Kids
    sourcestringrequired

    Membership source (manual or oidc)

    Example: manual
  • ]
  • createdAtstring<date-time>required

    Account creation timestamp

    Example: 2024-01-01T00:00:00Z
    emailstringrequired

    User email address

    idstring<uuid>required

    Unique user identifier

    Example: 550e8400-e29b-41d4-a716-446655440000
    isActivebooleanrequired

    Whether the account is active

    Example: true
    lastLoginAt(string | null)<date-time>nullable

    Timestamp of last login

    Example: 2024-01-15T10:30:00Z
    permissionsstring[]required

    Custom permissions that extend the role's base permissions

    roleUserRolerequired

    User role (reader, maintainer, admin)

    Possible values: [reader, maintainer, admin]

    updatedAtstring<date-time>required

    Last account update timestamp

    Example: 2024-01-15T10:30:00Z
    usernamestringrequired

    Username for login

    Example: johndoe
    UserDto
    {
    "accessGroups": [
    {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Kids",
    "source": "manual"
    }
    ],
    "createdAt": "2024-01-01T00:00:00Z",
    "email": "[email protected]",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "isActive": true,
    "lastLoginAt": "2024-01-15T10:30:00Z",
    "permissions": [
    "string"
    ],
    "role": "reader",
    "updatedAt": "2024-01-15T10:30:00Z",
    "username": "johndoe"
    }