Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel2

...

The excludeRelated and retainSysIds properties are specified as attributes in the <user> element of XML web services.
 

XML

JSON


Expand
titleXML





Expand
titleJSON


Code Block
languagetext
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<user retainSysIds="true">
{
    "active": true,
   <active>true</active>
    <browserAccess> "browserAccess": "-- System Default --</browserAccess>",
     <businessPhone />"businessPhone": null,
    "commandLineAccess": <commandLineAccess>"-- System Default --</commandLineAccess>",
    <department />"department": null,
    <email />"email": null,
     <firstName>stone b</firstName>"firstName": "stone b",
    <impersonate/>
"impersonate": [],
   <lastName>branch</lastName>
  "lastName": "branch",
  <lockedOut>false</lockedOut>  "lockedOut": false,
 <loginMethod>Standard</loginMethod>   "loginMethod": "Standard",
<manager />   "manager": null,
<middleName />   "middleName": null,
<mobilePhone />   "mobilePhone": null,
<passwordNeedsReset>false</passwordNeedsReset>     <permissions/>"passwordNeedsReset": false,
    <sysId>4e820e27b548497bb8005bb884f2816a</sysId>
"permissions": [
   <timeZone>System</timeZone>     <title>IT{
Technician</title>     <tokens/>     <userName>stonebranch-user-02</userName>  "allGroups": true,
 <userRoles>         <userRole>  "commands": null,
         <role description="Can create reports that belong to a group to which I am a member.">ops_report_group</role>
   "defaultGroup": true,
            "nameWildcard": "*",
        <sysId>018b60fc6bb54ca68571f789e5ee1ad5</sysId>    "notGroups": false,
   </userRole>         <userRole>
"opCreate": false,
           <role description="opDelete"Can: createtrue,
global reports.">ops_report_global</role>           "opExecute":  <sysId>b21ecafbcd3f4424bfeca3d9846f2c34</sysId>true,
            </userRole>"opRead": true,
         <userRole>   "opUpdate": true,
        <role description="The report publishing role.">ops_report_publish</role>
"opswiseGroups": [],
           <sysId>cb84572b5bf44ddfb1e9e0e9b9d1b65a</sysId>
  "permissionType": "Agent",
      </userRole>     </userRoles>
  "sysId": "83c2d3b15d0c417f8a8890be17f1f4cd"
  <webServiceAccess>-- System Default --</webServiceAccess>
</user>
Expand
titleJSON
Code Block
languagetext
{    }
    ],
    "activeretainSysIds" : true,
  "browserAccess" : "-- System Default --",  "sysId": "4e820e27b548497bb8005bb884f2816a",
    "timeZone": "System",
    "title": "IT Technician",
    "businessPhonetokens" : null[],
    "commandLineAccessuserName" : "stonebranch-user-02",
 System  Default --","userRoles": [
        {
            "department" : null,role": {
           "email" : null,   "firstNamedescription" : "stone b",
  "impersonate" : [ ],
  "lastName" : "branchCan create reports that belong to a group to which I am a member.",
  "lockedOut" : false,   "loginMethod" : "Standard",   "manager" : null,  "value": "middleNameops_report_group"
 : null,   "mobilePhone" : null,   "passwordNeedsReset" : false},
  "permissions" : [ ],   "retainSysIds" : true,   "sysId" : "4e820e27b548497bb8005bb884f2816a",018b60fc6bb54ca68571f789e5ee1ad5"
      "timeZone" : "System"},
    "title" : "IT Technician", {
 "tokens" : [ ],   "userName" : "stonebranch-user-02",   "userRolesrole": :{
 [ {     "role" : {       "description" : "Can create global reports that.",
belong to a group to which I am a member.",       "value" : "ops_report_groupglobal"
  
 },     "sysId" : "018b60fc6bb54ca68571f789e5ee1ad5"    },
{     "role" : {      "sysId": "descriptionb21ecafbcd3f4424bfeca3d9846f2c34"
 :    "Can create global reports."},
       "value" : "ops_report_global"{
     },     "sysId" : "b21ecafbcd3f4424bfeca3d9846f2c34role": {
 }, {     "role" : {       "description" : "The report publishing role.",
                "value" : "ops_report_publish"
            },
            "sysId" : "cb84572b5bf44ddfb1e9e0e9b9d1b65a"
        }
    ],
    "webServiceAccess" : "-- System Default --"
}



...

List Personal Access Tokens: Query Parameters

The following request parameters can be used to filter the results of this service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

UUID of the user

N

username

username

N/A

User Name

String value of User name

N

userid

...