| Anchor | ||||
|---|---|---|---|---|
|
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/security/user |
| Table of Contents | ||
|---|---|---|
|
Each function returns a JSON user object. The user object has these attributes:
| Attributes | Type | Description |
|---|---|---|
| userId | Long | The id of the user |
| attributes | List<Attribute> | The list of attributes associated with the user |
| userName | String | The user name of the user |
| password | String | The user's password. Note: this value is displayed as "*****" when retrieved. |
| groups | List<Long> | The ids of the groups that the user is a member of |
| isLocalUser | Boolean | Whether or not the user was made in FlexDeploy or imported from outside |
| isActive | Boolean | Whether or not the user is active |
| String | The user's email | |
| firstName | String | The first name of the user |
| lastName | String | The last name of the user |
Additionally, each attribute in the list of attributes contains these attributes
| Attributes | Type | Description |
|---|---|---|
| description | String | The description of the attribute |
| attributeName | String | The name of the attribute |
| attributeValue | String | The value of the attribute |
| attributeGroup | String | The group that the attribute is associated with |
| attributeDataType | String | The type of data that the value is |
...
GET
There are two implementations of GET. One will find a user with the given Id and return the JSON representation of the user . The other will find a list of users matching the parameters supplied to it.
...
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/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 |
...
This POST service will create a new user with the same attributes as the given JSON object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/administration/security/user |
Parameters
| Attributes | Type | Required | Description |
|---|---|---|---|
| userId | Long | No | The id of the user. This id is set when creating and returned in the JSON. |
| attributes | List<Attribute> | No | The list of attributes associated with the user. They will be defaulted if not provided |
| userName | String | Yes | The user name of the user |
| password | String | Yes | The user's password. Note: this value is displayed as "*****" when retrieved. |
| groups | List<Long> | No | The ids of the groups that the user is a member of |
| isLocalUser | Boolean | No | Whether or not the user was made in FlexDeploy. Set to true upon creation. |
| isActive | Boolean | No | Whether or not the user is active. Defaulted to true if not provided. |
| String | Yes | The user's email | |
| firstName | String | Yes | The first name of the user |
| lastName | String | Yes | The last name of the user |
...
This PUT service will update all attributes of a user with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will become their default values.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/administration/security/user/{Id} |
Parameters
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | The PUT will be performed on the user with the specified id that is found in the URL. |
| userId | Long | No | The id of the user. This Id is ignored in PUT, but it is returned as the proper user Id. |
| attributes | List<Attribute> | No | The list of attributes associated with the user. They will be defaulted if not provided |
| userName | String | Yes | The user name of the user |
| password | String | Yes | The user's password. Note: this value is displayed as "*****" when retrieved. |
| groups | List<Long> | No | The ids of the groups that the user is a member of |
| isLocalUser | Boolean | No | Whether or not the user was made in FlexDeploy. Cannot be changed. |
| isActive | Boolean | No | Whether or not the user is active. Defaulted to true if not provided. |
| String | Yes | The user's email | |
| firstName | String | Yes | The first name of the user |
| lastName | String | Yes | The last name of the user |
Example
If we had a user in our database with an Id of 10000 and had the following attributes
...
...
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} |
Parameters
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | The PUT will be performed on the user with the specified id that is found in the URL. |
| userId | Long | No | The id of the user. This Id is ignored in PUT, but it is returned as the proper user Id. |
| attributes | List<Attribute> | No | The list of attributes associated with the user. Only provided attributes will be changed. |
| userName | String | No | The user name of the user |
| password | String | No | The user's password. Note: this value is displayed as "*****" when retrieved. |
| groups | List<Long> | No | The ids of the groups that the user is a member of |
| isLocalUser | Boolean | No | Whether or not the user was made in FlexDeploy. |
| isActive | Boolean | No | Whether or not the user is active. |
| String | No | The user's email | |
| firstName | String | No | The first name of the user |
| lastName | String | No | The last name of the user |
...