Panel | ||||
---|---|---|---|---|
|
...
XML | JSON | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Delete a User
...
Description
...
URI
...
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.
...
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
...
List Users
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves information on all Users.
...
Example URI
...
http://localhost:8080/uc/resources/user/list
http://localhost:9090/uc/resources/user/list?showTokens=true
...
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.
List Users: URI Parameters
...
Name
...
Description
...
Specifications
...
Required
...
showTokens
...
Show personal access tokens.
...
Boolean
True - Includes the Token details
False (Default) - Empty Token List
...
List Users: XML and JSON Examples
XML | JSON | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Expand |
|
Anchor | ||||
---|---|---|---|---|
|
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 | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Delete a User: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this user. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this user. | String; URI parameter. | Y (unless |
|
Anchor | ||||
---|---|---|---|---|
|
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 http://localhost:9090/uc/resources/user/list?showTokens=true |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | |
User Properties | See User Properties. |
User Permission Properties | |
User Role Properties | See User Role Properties. |
List Users: URI Parameters
Name | Description | Specifications | Required |
---|---|---|---|
| Show personal access tokens. | Boolean
| N |
Anchor | ||||
---|---|---|---|---|
|
List Users: XML and JSON Examples
XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allGroups | Member of Any Business Service or Unassigned Business Service Criteria
| 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 | ||||||||||||||
commands | Commands | Commands that are associated with each permission. | Valid values: see #Command Permissions, below. | N | ||||||||||||||
defaultGroup | Unassigned to Business Service Business Service Criteria
| 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 | ||||||||||||||
nameWildcard | Name | Specification to apply this permission to records whose name matches the string specified here. | Wildcards (*'s) can be used. | Y | ||||||||||||||
| Not Member of Business Services Business Service Criteria
| Specification for whether or not this permission applies to records that are a member of opswiseGroups or not a member of opswiseGroups . | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||
opCreate | Create | Allows the user to create records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||
opDelete | Delete | Allows the user to delete records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||
opExecute | Execute | Allows the user to execute records of the specified | Boolean. Valid Values: true/false. Default is false.
If the Strict Connection Execute Constraints Universal Controller system property is true:
| N | ||||||||||||||
opRead | Read | Allows the user to read records of the specified | Boolean. Valid Values: true/false. Default is false.
| N | ||||||||||||||
opUpdate | Update | Allows the user to update records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||
opswiseGroups | Member of Business Services | Applies this permission to records that are members of the selected Business Service(s).
| N | |||||||||||||||
permissionType | Type | Type of permission for this user. | Valid values:
| Y | ||||||||||||||
sysId | n/a | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N |
...
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 |
...