...
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 |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | |
User Properties | |
User Permission Properties | |
User Role Properties | See User Role Properties. |
...
Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|
| Unique ID for this User. | Y |
| |
| Name used within the Controller to identify this User. | Maximum 40 alphanumerics. | Y |
|
Optionally Include Personal Access Tokens on User Payloads: Read User API
The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.
...
Description
...
URI
...
http://host_name/uc/resources/user
...
HTTP Method
...
GET
...
Description
...
List the user tokens
...
Example URI
...
http://localhost:9090/uc/resources/user?username=test&showTokens=true
http://localhost:9090/uc/resources/user?userid=1234567&showTokens=false
...
Authentication
...
HTTP Basic
...
Produces Content-Type
...
Application/XML, Application/JSON
...
Consumes Content-Type
...
Example Responses
...
Status 200
Successful user details
Status 400
Error message.
Status 403
Operation prohibited due to security constraints.
Status 404
A user with name “{name}” does not exist.
A user with id "{uuid}" does not exist.
Status 500
Unexpected request failure. See log(s) for more details.
Optinally Include Personal Access Tokens on Read a User Payloads: Query Parameters
The following request parameters will be needed for the service.
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
userid | N/A | UUID of the user | UUID of the user | Y | username |
username | N/A | User Name | String value of User name | Y |
|
| N/A | Show tokens | Boolean
| N |
| Anchor | ||||
|---|---|---|---|---|
|
...