| Panel | |
|---|---|
On this page:
|
User
URI Templates
HTTP Action | Media Type | URI Templates | Description |
|---|---|---|---|
| GET | application/json | user | Get information about current user requesting REST API. |
JSON Representation
Properties | Description | Type | Occurs |
|---|---|---|---|
| href | Auto reference | URI | 1 |
| name | User name | String | 1 |
| contextUuid | A unique identifier of the current user session | String | 1 |
| administrator | Check whether the user has "ADMIN" role | Boolean | 1 |
| superConsumer | Check whether the user has permission to consume all applications without restriction | Boolean | 1 |
| qualityManager | Check whether the user has "QUALITY_MANAGER" role | Boolean | 1 |
| exclusionManager | Check whether the user has "EXCLUSION_MANAGER" role | Boolean | 1 |
| qualityAutomationManager | Check whether the user has "QUALITY_AUTOMATION_MANAGER" role | Boolean | 1 |
JSON Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"href": "user",
"name": "CIO",
"contextUuid": "031b54ae-5f26-45f7-9e34-84fa222ce4e1",
"administrator": false,
"superConsumer": true,
"qualityManager": false,
"exclusionManager": false,
"qualityAutomationManager": true
} |
Login
Pseudo REST service to trigger a creation of end user session. Require an "Authorization" header containing user name and password
Prior to any request, REST client must authenticate on behalf of the current end-user, using the "login" request. This request must contain an HTTP header containing the credentials UserName:Password encoded in base 64.
| Code Block |
|---|
GET /.../rest/user/login HTTP/1.1 Authorization: Basic Y2FzdDpjYXN0 |
If credendials are invalid then the server replies: HTTP/1.1 470 Authentication required
Note: a Set-Cookie HTTP header is sent back from the server in the first server response.
URI Templates
HTTPAction | Media Type | URI Templates | Description |
|---|---|---|---|
| GET | application/json | user/login | Pseudo REST service to trigger a creation of end user session. Require an "Authorization" header containing user name and password |
Logout
Pseudo REST service to end a user's session
The following request closes the current session and replies "HTTP/1.1 401 Unauthorized"
| Code Block |
|---|
GET /.../rest/user/logout HTTP/1.1 |
Note : This URL is declared in WEB-INF\application-security.xml configuration file.
URI Templates
HTTPAction | Media Type | URI Templates | Description |
|---|---|---|---|
| GET | application/json | user/logout | Pseudo REST service to end a user's session |
Ping
Pseudo REST service to test whether current client can access to the server, use the "ping" request
URI Templates
HTTPAction | Media Type | URI Templates | Description |
|---|---|---|---|
| GET | application/json | user/ping | Pseudo REST service to test a user session. |