Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

XML

JSON


Expand
titleXML
<user retainSysIds="true">
   <active>true</active>
   <browserAccess>-- System Default --</browserAccess>
   <businessPhone />
   <commandLineAccess>-- System Default --</commandLineAccess>
   <department />
   <email>test@test.com</email>
   <firstName>Joe</firstName>
   <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
titleJSON
{
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",
  "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
titleXML
<users>
<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> <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>
<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
titleJSON
[ {
"active": true,
"browserAccess": "-- System Default --",
"businessPhone": null,
"commandLineAccess": "-- System Default --",
"department": null,
"email": "test@test.com",
"firstName": "Joe",
"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", "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 --" }
]


...

Valid Value hh:mm:ss -timezone

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
userId
userId
userId

N/A

UUID of the user

UUID of the user

N

userName

Anchor
userName
userName
userName

N/A

User Name

String value of User name

N

userId

Anchor
name
name
name

Name

Token Name

Specifies the name of the application that will access the Universal Controller Web Service APIs using the personal access token.

Y


Anchor
expiration
expiration
expiration

Expiration

Description of property.

Specifies when the personal access token expires. If left unspecified, the token never expires.

Valid Values: yyyymmdd, Never

N

lastUsedLast Used Last time this token was used.Valid Values: yyyymmdd, NeverNcreateTimeCreatedTime this token was created.

Value: yyyy-mm-dd

N


Create Personal Access Token: XML and JSON Examples

...

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

...