Users can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of users.
...
GET (Using Query Parameters)
This GET service will return a list of users in the form of JSON objects based on the query parameters user name, first name, last name and group id. Users are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of users.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/administration/security/user? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:userName={userName} firstName={firstName} * lastName={lastName} * groupId={groupId} Examples:To search by user name only:http://host:port/flexdeploy/rest/topology/administration/security/user?userName=fdadmin To search by first name and last name:http://host:port/flexdeploy/rest/topology/administration/security/user?firstName=John&lastName=Smith To search by group idhttp://host:port/flexdeploy/rest/topology/administration/security/user?groupId=11101 |
* searching by first and last name returns all users that contain the specified string in their first or last name
...
name
...
Request
| Attributes | Type | Required | Description |
|---|---|---|---|
| groupId | Query - Long | No | Find users that are member of specific group |
| userName | Query - String | No | Equals search |
| firstName | Query - String | No | Contains ignore case search |
| lastName | Query - String | No | Contains ignore case search |
| Include Page | ||||
|---|---|---|---|---|
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"attributes": [
{
"description": "Notify on Approval Required",
"attributeName": "SUBMITTER_PENDING_APPROVAL",
"attributeValue": "false",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
},
{
"description": "Notify on Request Scheduled",
"attributeName": "SUBMITTER_SCHEDULED",
"attributeValue": "true",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
},
{
"description": "Notify on Request Failed",
"attributeName": "SUBMITTER_FAILED",
"attributeValue": "true",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
},
{
"description": "Notify on Request Deploying",
"attributeName": "SUBMITTER_READY",
"attributeValue": "true",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
},
{
"description": "Notify on Request Completed",
"attributeName": "SUBMITTER_COMPLETED",
"attributeValue": "true",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
},
{
"description": "Notify on Request Rejected",
"attributeName": "SUBMITTER_REJECTED",
"attributeValue": "true",
"attributeGroup": "EMAIL_COMMUNICATION",
"attributeDataType": "Boolean"
}
],
"userId": 10000,
"userName": "newusername",
"password": "*****",
"groups": [],
"isActive": true,
"email": "newemail@company.com",
"lastName": "Lastname",
"firstName": "Firstname",
"isLocalUser": true
} |
PATCH
This PATCH service will update an existing user with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the user. Groups that are included in a PATCH will be added, but existing groups will still remain.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/administration/security/user/{Id} |
...