| Cloud Admin | Enterprise Admin | User |
|---|---|---|
 |
 |
|
Contents:
Users Resource offers the functionality of managing the users of an enterprise in a logical way.
User Data Model
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| name | String | 1 | true | The user's name. |
| surname | String | 1 | true | The user's surname |
| nick | String | 1 | true | The user's nick name |
| description | String | 1 | true | A description on who is that user. |
| String | 1 | true | The user's email. | |
| locale | String | 1 | true | The user's locale and language, i.e en_US |
| password | String | 1 | false | The user's password as a MD5 hash. We never return it in any document but need it to create the user |
| active | Integer | 1 | true | Whether the user is active or not |
| deleted | Integer | 1 | true | Whether the user was deleted or not |
| enterprise | Link | 1 | true | A link to the enterprise resource that the user belongs |
| role | Link | 1 | true | A link to the role of the user |
Methods related to Users Resource
Retrieve a list of users
Synopsis: GET http://example.com/api/admin/enterprises/{$enterpriseId}/users
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request example: Retrieve all users of an enterprise
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprises
Response Status: 201, 400, 401, 403.
Response example: The creation response
Create a new user
Synopsis: POST http://example.com/api/admin/enterprises/{$enterpriseId}/users
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: User.
Request example: Create new User
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise
Response Status: 201, 400, 401, 403.
Response example: The creation response
Retrieve a User
Synopsis: GET http://example.com/api/admin/enterprises/{$enterpriseId}/users/{$userId}
Request Headers: Accept, Content-Type.
*Request Parameters: N/A.
*Request Message Body: N/A.
Example Request: Retrieve information about a user.
Response Headers: Content-Length, Content-Type.
*Response Message Body: Enterprise.
Response Status: 200, 401, 403.
Example Response: Response of the GET over a user
Updates an existing user.
Synopsis: PUT http://example.com/api/admin/enterprises/{$enterpriseId}/users/{$userId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
*Request Message Body: Enterprise.
Example Request: Update information about a user.
Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 400, 401, 403.
Example Response: Response of the update
Delete an existing user.
Synopsis: DELETE http://example.com/server/admin/enterprises/{$enterpriseId}/users/{$userId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Delete information about a user.
Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 204, 401, 403, 409
Example Response: Response of the deletion
