...
Description | |
---|---|
URI | http://host_name/uc/resources/user |
HTTP Method | GET |
Description | Retrieves information on a specific User. |
URI Parameters | See Read a User: URI Parameters, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
User Properties | See User Properties. |
User Permission Properties | |
User Role Properties | See User Role Properties. |
Example Response |
|
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
userid
...
Unique ID for this User.
...
Y
(unless username
is specified)
...
username
...
username
...
Name used within the Controller to identify this User.
...
Maximum 40 alphanumerics.
...
Y
(unless userid
is specified)
...
userid
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 |
|
...
Anchor | ||
---|---|---|
|
...
The following request parameters will be needed for the service.
...
Property
...
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
|
N/A
UUID of the user
UUID of the user
Unique ID for this User. | Y |
| |
|
N/A
User Name
String value of User name
Name used within the Controller to identify this User. | Maximum 40 alphanumerics. | Y |
| |
| N/A | Show tokens | Boolean
| N |
Anchor | ||||
---|---|---|---|---|
|
...