Remedy SSO administrator Login and Logout calls
Logs the Remedy Single Sign-On (Remedy SSO or RSSO) administrator in and out of the Remedy SSO server.
This topic includes the following sections:
Login
Request
HTTP method: Post
URL: https://<HOST>:<PORT>/rsso/config/login
Request body properties
Parameter | Type | Required | Description | Values | Default value |
|---|---|---|---|---|---|
username | String | Yes | Remedy SSO admin user name | User-provided value | NA |
password | String | Yes | Remedy SSO admin password | User-provided value | NA |
Example request JSON
"username" : "admin",
"password" : "adminpassword"
}
Response
If successful, this method logs you into the Remedy SSO server, which creates a user session token and returns a redirect response with a Remedy SSO token cookie in the SET-COOKIE header to the client.
Response body properties
Property | Description |
|---|---|
code | Status code (see Status codes and messages) |
msg | Response Message |
data | Response data |
Example response
The header looks like the following example:
Cache-Control: no-cachePragma: no-cache
Set-Cookie: JSESSIONID=FB2388170112F103FD295F160653DAB0; Path=/rsso/; HttpOnly; XSRF-TOKEN=YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh Path=/
Content-Type: application/json;
charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 16 Jun 2016 20:00:26 GMT
The body looks like the following example:
"code": 200"
msg": "OK"
"data": {}
}
From the response, save the text string returned in the SET-COOKIE: line. (Your REST client may use multiple Set-Cookie lines to provide this information.) The text string provides the authentication token, which you need for future requests. The authentication token is made up of the JSESSIONID and XSRF-TOKEN.
For example, in the previous header response, the authentication token is
JSESSIONID=FB2388170112F103FD295F160653DAB0; Path=/rsso/; HttpOnly; XSRF-TOKEN=YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh; Path=/
In future requests, use this information in the headers, setting the headers as follows:
charset: UTF-8
X-XSRF-TOKEN:YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh
Cookie: JSESSIONID=FB2388170112F103FD295F160653DAB0;XSRF-TOKEN=YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh;
Status codes and messages
HTTP code | Message | Description |
|---|---|---|
200 |
| Request succeeded |
401 | Wrong username/password |
|
Logout
Request
HTTP method: Post
URL: https://<HOST>:<PORT>/rsso/config/logout
Request parameters
There are no request parameters.
Request body properties
This call does not require a request body.
Example request
charset: UTF-8
X-XSRF-TOKEN:YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh
Cookie: JSESSIONID=FB2388170112F103FD295F160653DAB0;XSRF-TOKEN=YfS5wcz5lJHHxsJ9kftspIDqAh873U33XNvgvE0VkcRJZ8dldQIqRXMRcojPJwHh;
Response
If successful, this method logs you out of the Remedy SSO server.
Response body properties
Property | Description |
|---|---|
code | Status code (see Status codes and messages) |
msg | Status |
data | Status information data |
Example response
"code": 200
"msg": "OK"
"data": {"status": "Logged out"}
}
Status codes and messages
HTTP code | Message | Description |
|---|---|---|
200 |
| Request succeeded |
Video demonstration
The following BMC Communities video (4:50) is part 1 of a 5-part series on using the
the REST API. It introduces REST and RESTful web services and demonstrates how to log into and out of Remedy SSO.
For the other videos in this series, see the following topics:
- Part 2: Local-user-and-role-management-API
- Part 3: Upload-resource-to-repository
- Part 4: Adapter-management-API
- Part 5: Module-management-API
Related topics
Local-user-and-role-management-API