Page Comparison

Panel

Table of Contents

maxlevel	2

...

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

XML

JSON

Expand

title	XML

Code Block

language	text

<user retainSysIds="true">

<active>true</active>

<browserAccess>-- System Default --</

browserAccess>

browserAccess>

<businessPhone

<businessPhone />

<commandLineAccess>-- System Default --</

commandLineAccess>

commandLineAccess>

<department

<department />

<email>test@test

<email>test@test.com</

email>

email>

<firstName>Joe</firstName>

<impersonate

<impersonate/>

<lastName>Doe</lastName>

<lockedOut>false</lockedOut>

<lockedOut>false</lockedOut>

<loginMethod>Standard

<loginMethod>Standard, Single Sign-On</

loginMethod>

loginMethod>

<manager>Administrator</manager>

<manager>Administrator</manager>

<middleName>M</middleName>

<mobilePhone

<mobilePhone />

<passwordNeedsReset>false</passwordNeedsReset>

<passwordNeedsReset>false</passwordNeedsReset>

<permissions>
	<permission>

<allGroups>false</allGroups>

<allGroups>false</allGroups>

<commands>ALL</commands>

<defaultGroup>true</defaultGroup>

<nameWildcard>*</

nameWildcard>

nameWildcard>

<opCreate>false</opCreate>

<notGroups>false</notGroups>

<opCreate>false</opCreate>

<opDelete>true</opDelete>

<opExecute>true</opExecute>

<opswiseGroups

<opRead>true</

>

opRead>

<permissionType>Agent</permissionType>

<opUpdate>true</opUpdate>

<sysId>c489750500d444eca9325559d0ef9673<

<opswiseGroups /

sysId

>
	   <permissionType>Agent</permissionType>
	   <sysId>c489750500d444eca9325559d0ef9673</sysId>
       </permission>
   </

permissions>

permissions>

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<timeZone

<timeZone />

<title>Vice

<title>Vice President</

title>

title>

<userName>test

<userName>test.user</

userName>

userName>

<userPassword>abc123</userPassword>

<userRoles>
	<userRole>

<role

<role description="The universal template admin role.">ops_universal_template_admin</

role>

role>

<sysId>187ecb3a27544b7fb702caee6dc8d5e3</sysId>
	</userRole>
	<userRole>

<role

<role description="The report publishing role.">ops_report_publish</

role>

role>

<sysId>2e1dc86f47c6431884373f0e06b841da</sysId>
	</userRole>
   </

userRoles>

userRoles>

<webServiceAccess>-- System Default --</

webServiceAccess>

webServiceAccess>
</user>

{

Expand

title	JSON

Code Block

language	text

{
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",


  "impersonate":[],
  "lastName": "Doe",
  "lockedOut": false,
  "loginMethod": Standard, Single Sign-On",
  "manager": "Administrator",
  "middleName": "M",
  "mobilePhone": null,
  "passwordNeedsReset": false,
  "permissions": [ {
    "allGroups": false,
    "commands": "ALL",
    "defaultGroup": true,
    "nameWildcard": "*",
    "notGroups": false,
    "opCreate": false,
    "opDelete": false,
    "opExecute": true,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Agent",
    "sysId": "c489750500d444eca9325559d0ef9673"
  } ],
  "retainSysIds": true,
  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca",
  "timeZone": null,
  "title": "Vice President",
  "userName": "test.user",
  "userPassword": "abc123",
  "userRoles": [ {
    "role": {
      "description": "The universal template admin role.",
      "value": "ops_universal_template_admin"
    },
    "sysId": "b8c25922d370438aada276cff669136d"
  }, {
    "role": {
      "description": "The report publishing role.",
      "value": "ops_report_publish"
    },
    "sysId": "fda36f00cc4544bc8f7fbd203290539a"
  } ],
  "webServiceAccess": "-- System Default --"
}

Anchor

	Delete a User
	Delete a User

...

List Users: XML and JSON Examples

XML

JSON

Expand

title	XML

Code Block

language	text

<users>


  <user>

<active>true</active>

<browserAccess>-- System Default --</

browserAccess>

browserAccess>

<businessPhone

<businessPhone />

<commandLineAccess>-- System Default --</

commandLineAccess>

commandLineAccess>

<department

<department />

<email>test@test

<email>test@test.com</

email>

email>

<firstName>Joe</firstName>

<impersonate

<impersonate/>

<lastName>Doe</lastName>

<lockedOut>false</lockedOut>

<lockedOut>false</lockedOut>

<loginMethod>Standard

<loginMethod>Standard, Single Sign-On</

loginMethod>

loginMethod>

<manager>Administrator</manager>

<manager>Administrator</manager>

<middleName>M</middleName>

<mobilePhone

<mobilePhone />

<passwordNeedsReset>false</passwordNeedsReset>

<passwordNeedsReset>false</passwordNeedsReset>

<permissions

<permissions />

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<timeZone

<timeZone />

<title>Vice

<title>Vice President</

title>

title>

<userName>test

<userName>test.user</

userName>

userName>

<userPassword>abc123</userPassword>

<userRoles

<userRoles />

<webServiceAccess>-- System Default --</

webServiceAccess>

webServiceAccess>
  </user>


  <user>

<active>true</active>

<browserAccess>-- System Default --</

browserAccess>

browserAccess>

<businessPhone

<businessPhone />

<commandLineAccess>-- System Default --</

commandLineAccess>

commandLineAccess>

<department

<department />

<email>test@test.com</email>

<firstName>Joe</firstName>

<lastName>Doe</lastName>

<impersonate

<impersonate/>

<lockedOut>false</lockedOut>

<lockedOut>false</lockedOut>

<loginMethod>Standard

<loginMethod>Standard, Single Sign-On</

loginMethod>

loginMethod>

<manager>Administrator</manager>

<manager>Administrator</manager>

<middleName>M</middleName>

<mobilePhone

<mobilePhone />

<passwordNeedsReset>false</passwordNeedsReset>

<passwordNeedsReset>false</passwordNeedsReset> 
   <permissions>

    <permission>

<allGroups>false</allGroups>

<allGroups>false</allGroups>

<commands>ALL</commands>

<defaultGroup>true</defaultGroup>

<nameWildcard>*</

nameWildcard>

nameWildcard> 
     <notGroups>false</notGroups>

<opCreate>false</opCreate>

<opCreate>false</opCreate>

<opDelete>true</opDelete>

<opExecute>true</opExecute>

<opRead>true</opRead>

<opUpdate>true</opUpdate>

<opswiseGroups

<opswiseGroups />

<permissionType>Agent</permissionType>

<permissionType>Agent</permissionType>

<sysId>c489750500d444eca9325559d0ef9673</sysId> 
    </permission>


  <permissions>

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>

<timeZone

<timeZone />

<title>Vice

<title>Vice President</

title>

title>

<userName>test

<userName>test.user</

userName>

userName>

<userPassword>abc123</userPassword>

<userRoles

<userRoles />

<webServiceAccess>-- System Default --</

webServiceAccess>

webServiceAccess>

  </user>


</users>

Expand

title	JSON

Code Block

language	text

[ {


  "active": true,

  "browserAccess": "-- System Default --",

  "businessPhone": null,


  "commandLineAccess": "-- System Default --",

  "department": null,

  "email": "

test@test

test@test.com",


  "firstName": "Joe",

  "impersonate":[],


  "lastName": "Doe",

  "lockedOut": false,


  "loginMethod": Standard, Single Sign-On",


  "manager": "Administrator",


  "middleName": "M",

  "mobilePhone": null,


  "passwordNeedsReset": false,


  "permissions": [],


  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca",


  "timeZone": null,

  "title": "Vice President",

  "userName": "test.user",


  "userPassword": "abc123",


  "userRoles": [],


  "webServiceAccess": "-- System Default --"

},


  {
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",


  "impersonate":[],
  "lastName": "Doe",
  "lockedOut": false,
  "loginMethod": Standard, Single Sign-On",
  "manager": "Administrator",
  "middleName": "M",
  "mobilePhone": null,
  "passwordNeedsReset": false,
  "permissions": [ {
    "allGroups": false,
    "commands": "ALL",
    "defaultGroup": true,
    "nameWildcard": "*",
    "notGroups": false,
    "opCreate": false,
    "opDelete": false,
    "opExecute": true,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Agent",
    "sysId": "c489750500d444eca9325559d0ef9673"
  } ],
  "retainSysIds": true,
  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca",
  "timeZone": null,
  "title": "Vice President",
  "userName": "test.user",
  "userPassword": "abc123",
  "userRoles": [ {
    "role": {
      "description": "The universal template admin role.",
      "value": "ops_universal_template_admin"
    },
    "sysId": "b8c25922d370438aada276cff669136d"
  }, {
    "role": {
      "description": "The report publishing role.",
      "value": "ops_report_publish"
    },
    "sysId": "fda36f00cc4544bc8f7fbd203290539a"
  } ],
  "webServiceAccess": "-- System Default --"
  }

Anchor

	Modify a User
	Modify a User

...

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

...

Versions Compared

Old Version 4

New Version 5

Key

List Users: XML and JSON Examples

List Personal Access Tokens: Query Parameters