Manage the SPS license
You can display information about the currently used SPS license from the https://<IP-address-of-SPS>/api/configuration/management/license endpoint.
|
|
Caution:
Accessing the One Identity Safeguard for Privileged Sessions (SPS) host directly using SSH is not recommended or supported, except for troubleshooting purposes. In such case, the One Identity Support Team will give you exact instructions on what to do to solve the problem. For security reasons, disable SSH access to SPS when it is not needed. For details, see "Enabling SSH access to the One Identity Safeguard for Privileged Sessions (SPS) host" in the Administration Guide. |
The following encryption algorithms are configured on the local SSH service of SPS:
-
Key exchange (KEX) algorithms:
diffie-hellman-group-exchange-sha256
-
Ciphers:
aes256-ctr,aes128-ctr
-
Message authentication codes:
hmac-sha2-512,hmac-sha2-256
URL
GET https://<IP-address-of-SPS>/api/configuration/management/license
Cookies
| Cookie name | Description | Required | Values |
|---|---|---|---|
| session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the configuration options.
curl --cookie cookies -H "Content-Type: application/json" https://10.30.255.28/api/configuration/management/license
Response
The following is a sample response received.
For details of the meta object, see Message format.
{
"body": {
"customer": "Example",
"limit": 5000,
"limit_type": "host",
"serial": "b937d212-db7d-0f2f-4c87-295e3c57024a",
"valid_not_after": "2018-11-07",
"valid_not_before": "2017-11-06"
},
"key": "license",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/license",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/root_password",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/health_monitoring",
"remaining_seconds": 600,
"transaction": "/api/transaction",
"upload": "/api/upload/license"
}
}
| Element | Type | Description | ||
|---|---|---|---|---|
| key | string | Top level element, contains the ID of the endpoint. | ||
| body | Top level element (string) | Contains the parameters of the license. | ||
| customer | string | The company permitted to use the license (for example, Example Ltd.). | ||
| limit | integer | The actual value of the session or host limit (see limit_type). | ||
| limit_type | host | session |
| ||
| serial | string |
The unique serial number of the license. | ||
| valid_not_after | date |
The date when the license expires. The dates are displayed in YYYY/MM/DD format. | ||
| valid_not_before | date |
The date after which the license is valid. The dates are displayed in YYYY/MM/DD format. | ||
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| Code | Description | Notes |
|---|---|---|
| 401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
| 404 | NotFound | The requested object does not exist. |
Upload a new license
To upload a new license file, complete the following steps.
-
Download your license file from support portal.
-
Open a transaction.
For details, see Open a transaction.
-
Upload the license file.
Upload the file to the https://<IP-address-of-SPS>/api/upload/license endpoint. For example:
curl --cookie cookies -F 'data=@/path/license.txt' -H "Expect:" --insecure https://<IP-address-of-SPS>/api/upload/license
-
Restart the traffic on SPS.
SPS will not use the new license to ongoing sessions. For the new license to take full effect, you must restart all traffic on the Basic Settings > System > Traffic control page of the SPS web interface.
curl --cookie cookies -F 'data=@/path/license.txt' -H "Expect:" --insecure https://<IP-address-of-SPS>/api/upload/license
-
Commit your changes.
For details, see Commit a transaction.