Renew login tokens for client authentication
GET method to renew user login tokens for session authentication within the RESTful API, which is used to submit workload from an IBM® Spectrum Symphony client.
| Method | URL | Description |
|---|---|---|
| GET | https://host_name:port/platform/rest/symrest/v1/auth/renew | Renews login tokens for session authentication. Tokens are valid for 8 hours and must be renewed before they expire. The token can be renewed through the /auth/renew API, or regenerated by calling the /auth/login API again. |
Request
GET https://host_name:port/platform/rest/symrest/v1/auth/renew?parameter| Category | Name | Description |
|---|---|---|
| Header | Cookie | The platform.rest.token and platform.rest.certificate cookies that are obtained from the previous call to the /login method. |
| Parameter | csrftoken | The csrftoken that is obtained by the previous call to the /login method. |
If you use curl, the command might look like the following example when the cookies are saved to /tmp/cookie:
curl --header 'Accept: application/json' -b /tmp/cookie --cacert /opt/ibm/spectrumcomputing/wlp/usr/shared/resources/security/cacert.pem --tlsv1.2 -X GET https://mysymresthost.example.com:8050/platform/rest/symrest/v1/auth/renew?csrftoken=915ee7644f431e630dac68b9ab3e40bcThis example uses the default self-signed CA certificate for the --cacert option (which is Installation_top\wlp\usr\shared\resources\security\cacert.pem for Windows and $EGO_TOP/wlp/usr/shared/resources/security/cacert.pem for Linux®). For your production cluster, use a properly chained certificate that is signed by a trusted CA. Alternatively, instead of the --cacert option, use the -k option to specify an insecure connection.
Response
| Status code | Description | ||
|---|---|---|---|
| Category | Name | Description | |
| 200 | OK - Successfully renewed tokens. | ||
| Header | Set-Cookie |
The platform.rest.token and platform.rest.certificate cookies that are successfully renewed. | |
| Content | csrftoken |
The csrftoken that is successfully renewed. | |
| 400 | Bad Request – The platform.rest.token is not found in the request. | ||
| 401 | Unauthorized - Cannot renew platform.rest.token. | ||
| 403 | Forbidden – The csrftoken is not found in the request. | ||