Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version 5

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

Property

UI Field Name

Description

Specifications

Required

Anchor
active - USER
active - USER
active

Active

Specification for whether or not the user is active. An active user can log in to the Controller. An inactive user cannot log in to the Controller, and the user will not appear in user lists.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
browserAccess - USER
browserAccess - USER
browserAccess

Web Browser Access

Specification for whether or not the user can log in to the user interface.

Valid Values:


Html bobswift
<ul>
<li> As String = -- System Default --, As Value = 0
<li> As String = Yes, As Value = 1
<li> As String = No, As Value = 2
</ul>


Default is – System Default – (0).

N

Anchor
businessPhone - USER
businessPhone - USER
businessPhone

Business Phone

Business phone number of this user.


N

Anchor
commandLineAccess - USER
commandLineAccess - USER
commandLineAccess

Command Line Access

Specification for whether or not the user can log in to the Universal Controller Command Line Interface (CLI).

Valid values:Default is –


Html bobswift
<ul>
<li> As String = -- System Default --, As Value = 0
<li> As String = Yes, As Value = 1
<li> As String = No, As Value = 2
</ul>


Default is – System Default – (0).

N

Anchor
department - USER
department - USER
department

Department

Business department of this user.


N

Anchor
email - USER
email - USER
email

Email

Email address of this user.


N

Anchor
excludeRelated - USER
excludeRelated - USER
excludeRelated

n/a

For the Modify User web service; specification for whether or not to exclude related records (User Permissions, User Roles) from the update, even if they are provided in the request.
 


Note
titleNote

In XML, excludeRelated is specified as an attribute in the <user> element.

Valid values: true/false (default is false).

N

Anchor
firstName - USER
firstName - USER
firstName

First Name

First Name of this user.


N

Anchor
lastName - USER
lastName - USER
lastName

Last Name

Last Name of this user.


N

Anchor
lockedOut - USER
lockedOut - USER
lockedOut

Locked out

Specification for whether or not the user is locked out of the Controller.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
loginMethod - USER
loginMethod - USER
loginMethod

Login Methods

Login method(s) that the user can authenticate with.

Valid Values:

N


Anchor
manager - USER
Html bobswift
<ul>
<li> Standard
<li> Single Sign-On
<li> Standard, Single Sign-On
</ul>

N

Anchor
manager - USER
manager - USER
manager

Manager

Business manager of this user.

Manager user ID

N

Anchor
middleName - USER
middleName - USER
middleName

Middle Name

Middle Name of this user.


N

Anchor
mobilePhone - USER
mobilePhone - USER
mobilePhone

Mobile Phone

Mobile phone number of this user.


N

Anchor
passwordNeedsReset - USER
passwordNeedsReset - USER
passwordNeedsReset

Password Requires Reset

Specification for whether or not the user will be prompted to reset the password at next login.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
retainSysIds - User
retainSysIds - User
retainSysIds

n/a

Persisted only if retainSysIds is set to true

Specification for whether or not the Create a User web service will persist the sysId property.

Note
titleNote

In XML, retainSysIds is specified as an attribute in the <user> element.

Valid values: true/false (default is true).

N

AnchorsysId - USERsysId - USERsysId

n/a

System ID field in the database for this record.


Html bobswift
<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and  <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. 
</ul>



Note
titleNote

In XML, retainSysIds is specified as an attribute in the <user> element.

Valid values: true/false (default is true).

N

Time zone of this

Anchor
timeZone sysId - USERtimeZone
sysId - USER
timeZone

Time Zone

sysId

n/a

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

Anchor
timeZone - USER
timeZone - USER
timeZone

Time Zone

Time zone of this user.

When this user logs in, all scheduling times will be shown in the user's time zone, unless the trigger specifies a different time zone.

N

Anchor
title - USER
title - USER
title

Title

Business title of this user.


N

Anchor
userName - USER
userName - USER
userName

User ID

Log in ID for this user.


Y

Anchor
userPassword - USER
userPassword - USER
userPassword

Password

Password of this user.
 
If userPassword is included in the request, userPassword will be updated.

Used only by the Create a User and Modify a User web services.

Y
(for Create
a User)

Anchor
webServiceAccess - USER
webServiceAccess - USER
webServiceAccess

Web Service Access

Specification for whether or not the user can log in to the Universal Controller RESTful Web Services API.

Valid values:

Default is – System Default – (0).

N


Html bobswift
<ul>
<li> As String = -- System Default --, As Value = 0
<li> As String = Yes, As Value = 1
<li> As String = No, As Value = 2
</ul>


Default is – System Default – (0).

N

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

opReadopUpdateUpdate
Boolean. Valid Values: true/false. Default is false.
 
If the Strict Business Service Membership Read

Property

UI Field Name

Description

Specifications

Required

Anchor
allGroups - PERM
allGroups - PERM
allGroups

Member of Any Business Service or Unassigned

Specification for whether or not this permission applies both to records that belong to any Business Service and to records that do not belong to any Business Service.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
commands - PERM
commands - PERM
commands

Commands

Commands that are associated with each permission.

Valid values: see #Command Permissions, below.

N

Anchor
defaultGroup - PERM
defaultGroup - PERM
defaultGroup

Unassigned to Business Service

Specification for whether or not this permission applies to records that do not belong to any Business Service.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
nameWildcard - PERM
nameWildcard - PERM
nameWildcard

Name

Specification to apply this permission to records whose name matches the string specified here.

Wildcards (*'s) can be used.

Y

Anchor
opCreate - PERM
opCreate - PERM
opCreate

Create

Allows the user to create records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
Cannot be set to true if permissionType is Agent.

N

Anchor
opDelete - PERM
opDelete - PERM
opDelete

Delete

Allows the user to delete records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.

N

Anchor
opExecute - PERM
opExecute - PERM
opExecute

Execute

Allows the user to execute records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
If the Strict Connection Execute Constraints Universal Controller system property is false:

If the Strict Connection Execute Constraints Universal Controller system property is true:

N

Anchor
opRead - PERM


opRead - PERM

Read

Allows the user to read records of the specified permissionType.

Anchor
opUpdate - PERMopUpdate - PERM
Html bobswift
<ul>
<li> <code>opExecute</code> can be set to true only if <code>permissionType</code> is Agent, Credential, Script, or Virtual Resource.
</ul>


If the Strict Connection Execute Constraints Universal Controller system property is falsetrue:

N


Html bobswift
<ul>
<li> <code>opExecute</code> can be set to true only if <code>permissionType</code> is Agent, Credential, Database Connection, Email Connection, SAP Connection, Script, SNMP Manager, or Virtual Resource.
</ul>

N

Anchor
opRead - PERM
opRead - PERM
opRead

Read

Allows the user to update read records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 

Must be set to true if opCreate is set to true.

N

AnchoropswiseGroups - PERMopswiseGroups - PERMopswiseGroups

Member of Business Services

Applies this permission to records that are members of the selected Business Service(s).
 
XML

Panel

 
JSON

Panel

N

AnchorpermissionType - PERMpermissionType - PERMpermissionType

Type

Type of permission for this user.

Valid values:If the Strict Business Service Membership Read Constraints Universal Controller system property is false:


Html bobswift
<ul>
<li> <code>opRead</code> must be set to true if <code>permissionType</code> is Agent, Agent Cluster, Calendar, Credential, Database Connection, Email Connection, SAP Connection, Email Template, SNMP Manager, or Virtual Resource.
</ul>

N

Anchor
opUpdate - PERM
opUpdate - PERM
opUpdate

Update

Allows the user to update records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
Must be set to true if opCreate is set to true.

N

Anchor
opswiseGroups - PERM
opswiseGroups - PERM
opswiseGroups

Member of Business Services

Applies this permission to records that are members of the selected Business Service(s).
 
XML


Panel
Html bobswift
<pre>
&lt;opswiseGroups&gt;
  &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt;
&lt;/opswiseGroups&gt;
</pre>


 
JSON


Panel
Html bobswift
<pre>
"opswiseGroups": ["test"]
</pre>


N

Anchor
permissionType - PERM
permissionType - PERM
permissionType

Type

Type of permission for this user.

Valid values:


Html bobswift
<ul>
<li> As String = Agent, As Value = 1
<li> As String = Calendar, As Value = 2
<li> As String = Credential, As Value = 3
<li> As String = Task, As Value = 4
<li> As String = Task Instance, As Value = 5
<li> As String = Trigger, As Value = 6
<li> As String = Application, As Value = 7
<li> As String = Script, As Value = 8
<li> As String = Variable, As Value = 9
<li> As String = Virtual Resource, As Value = 10
<li> As String = Agent Cluster, As Value = 11
<li> As String = Email Template, As Value = 12
<li> As String = Email Connection, As Value = 13
<li> As String = Database Connection, As Value = 14
<li> As String = SAP Connection, As Value = 15
<li> As String = SNMP Manager, As Value = 16
<li> As String = PeopleSoft Connection, As Value = 17
<li> As String = Bundle, As Value = 18
<li> As String = Promotion Target, As Value = 19
<li> As String = OMS Server, As Value = 20
</ul>

Y

Anchor
sysId - PERM
sysId - PERM
sysId

n/a

System ID field in the database for a record.

Persisted only if retainSysIds is set to true.

N

...