User object representation

The user object representation and fields are described below.

user was introduced in API version V1

user has not been marked for deprecation

Description

Representation of a session user returned in contexts like the API client context when user based authentication is being used

Fields

NameTypeDescriptionConstraints
urnString representation of a Unique Resource Name. Typically a UUID with 36 characters.
roleA string representation of a enumeration name restricted to the documented valuesThe user role assigned for the login user

Allowed values:

  • ANONYMOUS
  • DEFAULT
  • COMMENTER
  • EDITOR
  • PUBLISHER
  • ADMIN
  • SUPER
  • UNRECOGNIZED
statusA string representation of a enumeration name restricted to the documented valuesThe status of the login user

Allowed values:

  • UNVERIFIED
  • VERIFIED
  • MODERATED
  • UNRECOGNIZED