APIs for Remedy Single Sign-On configuration for BMC Cloud Lifecycle Management

The following REST APIs are used for configuring Remedy Single Sign-On (Remedy SSO) with BMC Cloud Lifecycle Management.

To login to Remedy SSO

URL: http://<hostName>:<portNumber>/rsso/api/v1.1/admin/login
Method: POST

Request:

{
"username":"Admin",
"password":"RSSO#Admin#"
}

Response:

{"admin_token":"eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJRV1J0YVc0PS5leUpoYkdjaU9pSklVekkxTmlKOS5leUpwWVhRaU9qRTFOVE15TlRVeU16a3NJbVY0Y0NJNk1UVTFNekkxT0Rnek9Td2lhWE56SWpvaVFXUnRhVzRpZlEub2oyQW1aVFRMelRlUmhZRkwwamVZeTh6THdXRFVTMjRTdlN6WUs4ZHEwMCJ9.PiSRe0y6TuFSiCrIO_An2E0qM5ucCgnpFYxdCj6j9iw"}

Note: Remedy SSO Rest API behaviour with SAML

If Remedy SSO is configured with SAML, users of Platform Manager REST API (for example, Brownfield utility or AO customizations) can not use Remedy SSO authentication and must use AR local authentication. This is an RSSO limitation. Remedy SSO REST API for login does not support SAML.

To login as Remedy SSO user

URL : http://<hostName>:<portNumber>/rsso/api/v1.0/token
Method: POST

Request:

content-type application/json; charset=utf-8
{
"username":"UserA",
"password":"bmcAdm1n",
"realm":"*"
}

Response:

{"rsso_token":"_46fcfeba-c846-4593-918c-2ecf04f6327d"}

To fetch user using the RSSO token

URL: http://<hostName>:<portNumber>/rsso/checktoken?token=<tokenValue>
Method: GET
Response:

{"realm":"*","user-id":"UserA","tenant-id":"","response-sessionStatus":"sessionStatus-OK"}

To validate RSSO token

URL: http://<hostName>:<portNumber>/rsso/checktoken?token=<tokenValue>
Method: GET

Responses:

For a valid token:

{"realm":"*","user-id":"UserA","tenant-id":"","response-sessionStatus":"sessionStatus-OK"}

If the token is not found or expired before 5-10 minutes:
```
{"response-sessionStatus":"sessionStatus-notFound"}
```

if the token expired within 5 minutes:

{"response-sessionStatus":"sessionStatus-timeoutOccured"}

To delete RSSO token

URL: http://<hostName>:<portNumber>/rsso/api/v1.0/token/<token_value>
Method : DELETE

To retrieve RSSO configuration details

URL: http://<hostName>:<portNumber>/rsso/checkconfig
Method : GET