...

Universal Controller supports the following RESTful-based web services for User operations, which are listed alphabetically on this page.

User Web Services#Create Create a UserUser Web Services#Delete
Delete a User
User Web Services#List List Users
User Web Services#Modify Modify a UserUser Web Services#Read
Read a User

Formatting specifications for each web service, including details about parameter requirements, are provided.

...

	Description
URI	http://host_name/uc/resources/user
HTTP Method
Description	Creates a new User.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples: XML and JSON Examples, below.
User Properties	See User Web Services#User Properties, below.
User Permission Properties	See User Web Services#User Permission Properties, below.
User Role Properties	See User Web Services#User Role Properties, below.
Example Response	Status 200 /OK Successfully created the user with sysId {sysId}.

...

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>
   <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",
  "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 --"
}

Anchor

...

Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

	Description
URI	http://host_name/uc/resources/user/token
HTTP Method

DELETE

URI Parameters

See User Web Services#Delete a User URI Parameters, below.

POST

Description

Deletes a User.

Create the personal access token
Example URI	http://localhost:8080/uc/

resourcess

resources/user

?username=Test_User_Name

http://localhost:9080/uc/resources/user?userid=18fcf558002743e38edc49114734b6d9

Example Response

Status 200 /OK
User {username} deleted successfully.
Status 400 /Bad Request
Mutual exclusion violation. Cannot specify userid and username at the same time.
Status 404 /Not Found
User with {username/userid} does not exist.

...

Parameter

/token
Authentication	HTTP Basic
Produces Content-Type	text/plain
Consumes Content-Type	Application/XML, Application/JSON
Example Responses	Status 200 ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifX Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

Create Personal Access Token: Payload Properties (XML, JSON)

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With

userid

ID used within the Controller to identify this user.

String; URI parameter.

Y (unless userename is specified)

username

Name used within the Controller to identify this user.

String; URI parameter.

Y (unless userid is specified)

userid

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Users.

...

Example URI

...

Authentication

...

HTTP Basic

...

Produces Content-Type

...

application/xml, application/json

...

Example

...

See List Users: XML and JSON Examples.

...

User Properties

...

See #User Properties.

...

User Permission Properties

...

See User Web Services#User Permission Properties.

...

User Role Properties

...

See User Web Services#User Role Properties.

...

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>
   <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

title	JSON

[ {
  "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 --"
  }
]

...

`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
`name`	Token Name	Token Name	Specifies the name of the application that will access the Universal Controller Web Service APIs using the personal access token.	Y
`expiration`	Expiration	Description of property.	Specifies when the personal access token expires. If left unspecified, the token never expires.	N

Create Personal Access Token: XML and JSON Examples

XML

JSON

Example Request

Expand

title	XML

 <token>
        <expiration>2022-07-30</expiration>
        <name>test1</name>
        <userId></userId>
        <userName>sha</userName>
    </token>

Expand

title	JSON

{
        "expiration": "2022-07-30",
        "name": "test1",
        "userName": "ops.admin",
        "userId": ""
    }

Example Response

Expand

title	XML

ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP

Expand

title	JSON

ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP

Anchor
Delete a User
Delete a User
Delete a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	DELETE
Description	Deletes a User.
URI Parameters	See Delete a User URI Parameters, below.
Example URI	http://localhost:8080/uc/resourcess/user?username=Test_User_Name http://localhost:9080/uc/resources/user?userid=18fcf558002743e38edc49114734b6d9
Example Response	Status 200 /OK User {username} deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify userid and username at the same time. Status 404 /Not Found User with {username/userid} does not exist.

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`userid`	ID used within the Controller to identify this user.	String; URI parameter.	Y (unless `userename` is specified)	`username`
`username`	Name used within the Controller to identify this user.	String; URI parameter.	Y (unless `userid` is specified)	`userid`

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

	Description
URI	http://host_name/uc/resources/user/token/list
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user/token/list http://localhost:9090/uc/resources/user/token/list?username=test http://localhost:9090/uc/resources/user/token/list?userid=1234567
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful token list Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

List Personal Access Tokens: Query Parameters

The following request parameters will be needed for the service.

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
userid	N/A	UUID of the user	UUID of the user	Y	username
username	N/A	User Name	String value of User name	Y	userid

List Personal Access Tokens: XML and JSON Examples

XML

JSON

Example Response

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tokens>
    <token>
        <createTime>2022-07-28 17:11:35 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test2</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-29 12:39:20 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test3</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-28 17:08:07 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test4</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-29 12:56:33 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test5</name>
        <userName>ops.admin</userName>
    </token>
</tokens>

Expand

title	JSON

[
    {
        "createTime": "2022-07-28 17:11:35 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test2",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-29 12:39:20 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test3",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-28 17:08:07 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test4",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-29 12:56:33 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test5",
        "userName": "ops.admin"
    }
]

Anchor
List Users
List Users
List Users

	Description
URI	http://host_name/uc/resources/user/list
HTTP Method	GET
Description	Retrieves information on all Users.
Example URI	http://localhost:8080/uc/resources/user/list
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Users: XML and JSON Examples.
User Properties	See #User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

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>
   <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

title	JSON

[ {
  "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 --"
  }
]

Anchor
Modify a User
Modify a User
Modify a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	PUT
Description	Modifies the User specified by the sysId in the request. To modify User properties without modifying related records, see the excludeRelated property.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples.
User Properties	See User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.
Example Response	Status 200 /OK Successfully updated the user with sysId <sysId>.

Anchor
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads

The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.

Optionally Include Personal Access Tokens on Read/List User Payloads: User Read API

	Description
URI	http://host_name/uc/resources/user
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user?username=test&showTokens=true http://localhost:9090/uc/resources/user?userid=1234567&showTokens=false
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful user details Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

Optionally Include Personal Access Tokens on Read/List User Payloads: User List API

	Description
URI	http://host_name/uc/resources/user/list
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user/list?username=test&showTokens=true http://localhost:9090/uc/resources/user/list?userid=1234567&showTokens=false
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful user details Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

Optionally Include Personal Access Tokens on Read/List User Payloads: Query Parameters

The following request parameters will be needed for the service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

Y

username

N/A

User Name

String value of User name

Y

userid

showTokens

N/A

Show tokens

Boolean

True - Includes the Token details
False (Default) - Empty Token List

N

Optionally Include Personal Access Tokens on Read/List User Payloads: Example Response

XML

JSON

Example Response

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<user retainSysIds="true">
    <active>true</active>
    <browserAccess>Yes</browserAccess>
    <businessPhone />
    <commandLineAccess>Yes</commandLineAccess>
    <department />
    <email />
    <firstName>Administrator</firstName>
    <lastName />
    <lockedOut>false</lockedOut>
    <loginMethod>Standard</loginMethod>
    <manager />
    <middleName />
    <mobilePhone />
    <passwordNeedsReset>false</passwordNeedsReset>
    <permissions/>
    <sysId>e0bde364c0a802ba0092e79554132023</sysId>
    <timeZone />
    <title />
    <tokens>
        <token>
            <createTime>2022-07-28 17:11:35 -0400</createTime>
            <expiration>20220730</expiration>
            <lastUsed>Never</lastUsed>
            <name>test2</name>
            <userName>ops.admin</userName>
        </token>
        <token>
            <createTime>2022-07-29 12:39:20 -0400</createTime>
            <expiration>20220730</expiration>
            <lastUsed>Never</lastUsed>
            <name>test3</name>
            <userName>ops.admin</userName>
        </token>
        <token>
            <createTime>2022-07-28 17:08:07 -0400</createTime>
            <expiration>20220730</expiration>
            <lastUsed>Never</lastUsed>
            <name>test4</name>
            <userName>ops.admin</userName>
        </token>
        <token>
            <createTime>2022-07-29 12:56:33 -0400</createTime>
            <expiration>20220730</expiration>
            <lastUsed>Never</lastUsed>
            <name>test5</name>
            <userName>ops.admin</userName>
        </token>
    </tokens>
    <userName>ops.admin</userName>
    <userRoles/>
    <webServiceAccess>Yes</webServiceAccess>
</user>

Expand

title	JSON

{
    "active": true,
    "browserAccess": "Yes",
    "businessPhone": null,
    "commandLineAccess": "Yes",
    "department": null,
    "email": null,
    "firstName": "Administrator",
    "lastName": null,
    "lockedOut": false,
    "loginMethod": "Standard",
    "manager": null,
    "middleName": null,
    "mobilePhone": null,
    "passwordNeedsReset": false,
    "permissions": [],
    "retainSysIds": true,
    "sysId": "e0bde364c0a802ba0092e79554132023",
    "timeZone": null,
    "title": null,
    "tokens": [
        {
            "createTime": "2022-07-28 17:11:35 -0400",
            "expiration": "20220730",
            "lastUsed": "Never",
            "name": "test2",
            "userName": "ops.admin"
        },
        {
            "createTime": "2022-07-29 12:39:20 -0400",
            "expiration": "20220730",
            "lastUsed": "Never",
            "name": "test3",
            "userName": "ops.admin"
        },
        {
            "createTime": "2022-07-28 17:08:07 -0400",
            "expiration": "20220730",
            "lastUsed": "Never",
            "name": "test4",
            "userName": "ops.admin"
        },
        {
            "createTime": "2022-07-29 12:56:33 -0400",
            "expiration": "20220730",
            "lastUsed": "Never",
            "name": "test5",
            "userName": "ops.admin"
        }
    ],
    "userName": "ops.admin",
    "userRoles": [],
    "webServiceAccess": "Yes"
}

Anchor
Read a User
Read a User
Read a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	PUTGET
Description	Modifies the User specified by the sysId in the request. To modify User properties without modifying related records, see the excludeRelated property.	Example URIRetrieves 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
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	User Properties	See User Properties.
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.

...

Anchor
Read a User URI Parameters

...

User Properties

...

See User Web Services#User Properties.

...

User Permission Properties

...

See User Web Services#User Permission Properties.

...

User Role Properties

...

See User Web Services#User Role Properties.

...

Example Response

...

Status 200 /OK
Successfully updated the user with sysId <sysId>.

Read a User URI Parameters
Read a User: URI Parameters

Name	Description	Specifications	Required	Mutually Exclusive With
`userid`	Unique ID for this User.		Y (unless `username` is specified)	`username`
`username`	Name used within the Controller to identify this User.	Maximum 40 alphanumerics.	Y (unless `userid` is specified)	`userid`

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

	Description
URI	http://host_name/uc/resources/user/token
HTTP Method

GET

DELETE

Description

Retrieves information on a specific User.

URI Parameters

See Read a User: URI Parameters, below.

Delete the personal access token(s)
Example URI	http://localhost:

8080

9090/uc/resources/user/token?tokenname=test1&username=

test.user

abc

http://localhost:

8080

9090/uc/resources/user/token?tokenname=test1&userid=

c489750500d444eca9325559d0ef9673Consumes Produces

1234567
Authentication	HTTP Basic
Produces Content-Type

n/a

User Properties

See User Web Services#User Properties.

User Permission Properties

See User Web Services#User Permission Properties.

User Role Properties

See User Web Services#User Role Properties.

Example Response

Status 200 /OK
(See Create, Modify, and Read a User: XML and JSON Examples.)

Status 404 /Not Found

Consumes Content-Type

application/xml, application/json

Example Responses

Status 200
Status 400
- Error message.
Status 403
- Operation prohibited due to security constraints.
Status 404
- A user with name “{name}” does not exist.
- A user with id "

f87848b00a0001037f43e7c81c8ec969

- {uuid}" does not exist.

...

Status 500
- Unexpected request failure. See log(s) for more details.

Revoke Personal Access Token: Query Parameters

The following request parameters will be needed for the service.

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
userid

Unique ID for this User.

N/A

UUID of the user

Y

(unless

username

is specified)

username

usernameuserid

N/A

Name used within the Controller to identify this User.

Maximum 40 alphanumerics.

Y
(unless userid
is specified)

User Name	String value of User name	N	userid
tokenname	token 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
Properties
Properties
Properties

...

Versions Compared

Old Version 1

New Version 2

Key

Anchor

Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

Create Personal Access Token: Payload Properties (XML, JSON)

Create Personal Access Token: XML and JSON Examples

Anchor
Delete a User
Delete a User
Delete a User

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

List Personal Access Tokens: Query Parameters

List Personal Access Tokens: XML and JSON Examples

Anchor
List Users
List Users
List Users

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

Anchor
Modify a User
Modify a User
Modify a User

Anchor
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads

Optionally Include Personal Access Tokens on Read/List User Payloads: User Read API

Optionally Include Personal Access Tokens on Read/List User Payloads: User List API

Optionally Include Personal Access Tokens on Read/List User Payloads: Query Parameters

Optionally Include Personal Access Tokens on Read/List User Payloads: Example Response

Anchor
Read a User
Read a User
Read a User

Anchor
Read a User URI Parameters

Read a User URI Parameters
Read a User: URI Parameters

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

Revoke Personal Access Token: Query Parameters

Anchor
Properties
Properties
Properties

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Anchor

Create Personal Access TokenCreate Personal Access TokenCreate Personal Access Token

Create Personal Access Token: Payload Properties (XML, JSON)

Create Personal Access Token: XML and JSON Examples

AnchorDelete a UserDelete a UserDelete a User

AnchorDelete a User URI ParametersDelete a User URI ParametersDelete a User: URI Parameters

AnchorList Personal Access TokensList Personal Access TokensList Personal Access Tokens

List Personal Access Tokens: Query Parameters

List Personal Access Tokens: XML and JSON Examples

AnchorList UsersList UsersList Users

AnchorList Users XML and JSON ExamplesList Users XML and JSON ExamplesList Users: XML and JSON Examples

AnchorModify a UserModify a UserModify a User

AnchorOptionally Include Personal Access Tokens on Read/List User PayloadsOptionally Include Personal Access Tokens on Read/List User PayloadsOptionally Include Personal Access Tokens on Read/List User Payloads

Optionally Include Personal Access Tokens on Read/List User Payloads: User Read API

Optionally Include Personal Access Tokens on Read/List User Payloads: User List API

Optionally Include Personal Access Tokens on Read/List User Payloads: Query Parameters

Optionally Include Personal Access Tokens on Read/List User Payloads: Example Response

AnchorRead a UserRead a UserRead a User

AnchorRead a User URI Parameters

Read a User URI ParametersRead a User: URI Parameters

AnchorRevoke Personal Access TokenRevoke Personal Access TokenRevoke Personal Access Token

Revoke Personal Access Token: Query Parameters

AnchorPropertiesPropertiesProperties

Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

Anchor
Delete a User
Delete a User
Delete a User

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

Anchor
List Users
List Users
List Users

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

Anchor
Modify a User
Modify a User
Modify a User

Anchor
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads
Optionally Include Personal Access Tokens on Read/List User Payloads

Anchor
Read a User
Read a User
Read a User

Anchor
Read a User URI Parameters

Read a User URI Parameters
Read a User: URI Parameters

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

Anchor
Properties
Properties
Properties