{
    id: string
    The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component
 
    componentName: string
    The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve
 
    componentType: string*
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DynamicField, EmailDistributionList, Group, Keyword, Model, OsImage, Realm, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User
 
    qualifiers: {
      Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration: key=deviceName, value=name of the device the configuration belongs to; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID
    }
}

{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

[
    A list of JSON Patch operations
 
     #JsonPatch.OneOperation
  ]

{
}

string
  Pointer or path to an element or property

{
    op: string*
    Enum: [
      "add"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "remove"
    ]
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "replace"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "move"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "copy"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "test"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    sessionID: string
    The unique identifier for this login session, which can be used to terminate this session
 
    emailAddress: string
    The user's e-mail address
 
    loggedInFromAddress: string
    Where the user logged in from
 
    loginTimestamp: date-time
    When the user logged into the systemexample = 2018-01-31T13:45:00.000+0000
 
    minutesIdle: integer
    How long this session has been idle or inactive
 
    roles: string
    Role(s) to which this user belongs
 
    sessionType: string
    What type of session this is (GUI, SSH proxy, or web services)
 
    username: string
    The user's name
}

{
    id: string
    The user's unique database key (read-only)
 
    name: string*
    The user's unique display name and login username; cannot be modified after creation
 
    accountCreatedOnTimestamp: date-time
    When the user was created (read-only)
     Example: 2018-01-31T13:45:00.000+0000
 
    emailAddress: string*
    The e-mail address of the user, for receiving reports and other exported information and for job approval requests
 
    enabledFlag: boolean
    Whether or not the user account is enabled; when not enabled, the user cannot log in
 
    forcePasswordChangeFlag: boolean
    Whether or not the user is required to change the password the next time the user logs in to the user interface; ignored when external authentication is in use. During create and update requests, this flag is automatically set for the resulting user when appropriate; note that this flag is enabled any time a user, userA creates or changes the password of another user, userB, even when userB is set for no password expiration, to ensure userA does not know userB's password. (read-only)
 
    lastPasswordChangeTimestamp: date-time
    When the password was last changed; null when external authentication is in use (read-only)
     Example: 2018-01-31T13:45:00.000+0000
 
    lastSuccessfulLoginTimestamp: date-time
    When the user last logged in; null when user has never logged in (read-only)
     Example: 2018-01-31T13:45:00.000+0000
 
    password: string
    The user's login password; required when local authentication is in use; ignored when external authentication is in use
 
    passwordEncryptedFlag: boolean
    Whether or not the password is encrypted
 
    passwordNeverExpiresFlag: boolean
    Whether or not the password expires and must be changed; when false, the password expires per the 'Require Users to Change Passwords After' system parameter; when true, the password does not expire and the system parameter does not apply; ignored when external authentication is in use
 
    roles: [
      The role(s) this user belongs to, which grant access to devices and functionality; a user must be associated with at least one role
 
       #ComponentId
    ]*
 
    rootAccountFlag: boolean
    Whether or not this is a root account as defined during installation; you cannot add a root account; you cannot disable or delete a root account; and a root account must always be associated with the Administrator role (read-only)
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}