Data model

This object includes the properties defined in the Base managed object properties schema, but does not provide the operational-status-related properties defined in that schema because it does not maintain the concept of an operational status.

For definitions of the qualifier abbreviations in the following tables, see Property characteristics.

The following class-specific specializations apply to the other base managed object properties:

Table 1. User object: base managed object properties specializations
Name Qualifier Type Description of specialization
object-uri String/ URI The canonical URI path of the User object is of the form /api/users/{user-id}, where {user-id} is the value of the object-id property (not the name property) of the User object.
parent String/ URI The canonical URI path of the Console object.
class String The class of a User object is "user".
name (ro) String If type is not "template": the name (console user ID) of the User object. It must be 4-320 characters in length and consist only of alphanumeric characters and the following special characters: @<+:#'="&*();-/\,%_>.?. This name must be unique among all users whose type is not "template" defined on the console. While preexisting names may contain a double quote (") character, it is not permitted in new user names.

If type is "template": the name of the template. While preexisting template names are virtually unrestricted in terms of length and characters, new template names must conform to the length and character requirement of the name property described in the Base managed object properties schema. This name must be unique among all template definitions on the console.

For the purpose of verifying uniqueness only, this name is treated in a case-insensitive fashion when used to create a new User object of any type.

description (w)(pc) String (0-1024) The description of the User object.

Default: an empty string