Skip to main content
Version: Next

User

Identity-provider user or service account. Administrative fields may be omitted according to caller permissions.

attributes object
property name* string[]
  • Array [
  • string
  • ]
  • createdOnstring<date-time>

    Identity creation time.

    Example: 2026-01-01T00:00:00Z
    emailstring

    Email address.

    Example: alex@example.com
    enabledboolean

    Whether this identity can authenticate.

    Example: true
    firstNamestring

    Given name.

    Example: Alex
    idstring

    Identity-provider user identifier.

    Example: 2f1c17e5-72b8-4dbe-9f8d-c49e66f82e10
    lastNamestring

    Family name.

    Example: Morgan
    realmstring

    Realm name that owns the user.

    Example: building
    realmIdstring

    Identity-provider internal realm identifier.

    secretstring

    Client secret for a service user. Returned only by operations that explicitly expose or reset it.

    serviceAccountboolean
    usernamestring

    Possible values: >= 3 characters and <= 255 characters, Value must match regular expression ^(?=[\p{IsLatin}|\p{IsCommon}]+$)(?=[^<>&"'\s\v\h$%!#?§,;:*~/\\|^=\[\]{}()\p{Cntrl}]+$).*$`

    User
    {
    "attributes": {},
    "createdOn": "2026-01-01T00:00:00Z",
    "email": "alex@example.com",
    "enabled": true,
    "firstName": "Alex",
    "id": "2f1c17e5-72b8-4dbe-9f8d-c49e66f82e10",
    "lastName": "Morgan",
    "realm": "building",
    "realmId": "string",
    "secret": "string",
    "serviceAccount": true,
    "username": "string"
    }