Page Comparison

Panel

Table of Contents

maxlevel	2

...

XML

JSON

Expand

title	XML

<user retainSysIds="true">
   <active>true</active>
   <browserAccess>-- System Default --</browserAccess>
   <businessPhone />
   <commandLineAccess>-- System Default --</commandLineAccess>
   <department />
   <email>test@test.com</email>
   <firstName>Joe</firstName>
   <impersonate63553454/>
   <lastName>Doe</lastName>
   <lockedOut>false</lockedOut>
   <loginMethod>Standard, Single Sign-On</loginMethod>
   <manager>Administrator</manager>
   <middleName>M</middleName>
   <mobilePhone />
   <passwordNeedsReset>false</passwordNeedsReset>
   <permissions>
	<permission>
	   <allGroups>false</allGroups>
	   <commands>ALL</commands>
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>false</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>true</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Agent</permissionType>
	   <sysId>c489750500d444eca9325559d0ef9673</sysId>
       </permission>
   </permissions>
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>
   <timeZone />
   <title>Vice President</title>
   <userName>test.user</userName>
   <userPassword>abc123</userPassword>
   <userRoles>
	<userRole>
	   <role description="The universal template admin role.">ops_universal_template_admin</role>
	   <sysId>187ecb3a27544b7fb702caee6dc8d5e3</sysId>
	</userRole>
	<userRole>
	   <role description="The report publishing role.">ops_report_publish</role>
	   <sysId>2e1dc86f47c6431884373f0e06b841da</sysId>
	</userRole>
   </userRoles>
   <webServiceAccess>-- System Default --</webServiceAccess>
</user>

Expand

title	JSON

{
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",
  "impersonate63553454":[],
  "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": "*",
    "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 --"
}

...

XML

JSON

Expand

title	XML

<users>
  <user>
   <active>true</active>
   <browserAccess>-- System Default --</browserAccess>
   <businessPhone />
   <commandLineAccess>-- System Default --</commandLineAccess>
   <department />
   <email>test@test.com</email>
   <firstName>Joe</firstName>
   <impersonate63553454/>
   <lastName>Doe</lastName>
   <lockedOut>false</lockedOut>
   <loginMethod>Standard, Single Sign-On</loginMethod>
   <manager>Administrator</manager>
   <middleName>M</middleName>
   <mobilePhone />
   <passwordNeedsReset>false</passwordNeedsReset>
   <permissions />
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>
   <timeZone />
   <title>Vice President</title>
   <userName>test.user</userName>
   <userPassword>abc123</userPassword>
   <userRoles />
   <webServiceAccess>-- System Default --</webServiceAccess>
  </user>
  <user> 
   <active>true</active> 
   <browserAccess>-- System Default --</browserAccess> 
   <businessPhone /> 
   <commandLineAccess>-- System Default --</commandLineAccess> 
   <department /> 
   <email>test@test.com</email> 
   <firstName>Joe</firstName> 
   <lastName>Doe</lastName> 
   <impersonate63553454/>
   <lockedOut>false</lockedOut> 
   <loginMethod>Standard, Single Sign-On</loginMethod> 
   <manager>Administrator</manager> 
   <middleName>M</middleName> 
   <mobilePhone /> 
   <passwordNeedsReset>false</passwordNeedsReset> 
   <permissions> 
    <permission> 
     <allGroups>false</allGroups> 
     <commands>ALL</commands> 
     <defaultGroup>true</defaultGroup> 
     <nameWildcard>*</nameWildcard> 
     <opCreate>false</opCreate> 
     <opDelete>true</opDelete> 
     <opExecute>true</opExecute> 
     <opRead>true</opRead> 
     <opUpdate>true</opUpdate> 
     <opswiseGroups /> 
     <permissionType>Agent</permissionType> 
     <sysId>c489750500d444eca9325559d0ef9673</sysId> 
    </permission>
  <permissions>
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId> 
   <timeZone /> 
   <title>Vice President</title> 
   <userName>test.user</userName> 
   <userPassword>abc123</userPassword> 
   <userRoles /> 
   <webServiceAccess>-- System Default --</webServiceAccess> 
  </user>
</users>

Expand

title	JSON

[ {
  "active": true, 
  "browserAccess": "-- System Default --", 
  "businessPhone": null, 
  "commandLineAccess": "-- System Default --", 
  "department": null, 
  "email": "test@test.com", 
  "firstName": "Joe", 
  "impersonate63553454":[],
  "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",
  "impersonate63553454":[],
  "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": "*",
    "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 --"
  }
]

...

	Description
URI	http://host_name/uc/resources/user
HTTP Method	GET
Description	Retrieves information on a specific User.
URI Parameters	See Read a User: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/user?username=test.user http://localhost:8080/uc/resources/user?userid=c489750500d444eca9325559d0ef9673 http://localhost:9090/uc/resources/user?username=test&showTokens=true
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
User Properties	See User Properties 63553454.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.
Example Response	Status 200 /OK (See Create, Modify, and Read a User: XML and JSON Examples.) Status 404 /Not Found A user with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...

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 10

New Version 11

Key

List Personal Access Tokens: Query Parameters