renew

Overview

This method issues a new API access token without needing to supply a username and password again. It returns a new token that can be used for subsequent requests.

Use this API to keep a session active before the current access token expires.

Permissions

No API permission is required to run this method. A valid access token from the authenticate API must be supplied.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/renew https://api.{{environment}}.catch-e.com/renew https://api.test.catch-e.com/renew

Input Fields (Header)

Key	Format	Notes	Mandatory
Authorization	string	`Bearer [ACCESS-TOKEN]`, using the current, unexpired access token.	Yes

This method has no request body.

Response Details

Success

201 - Created

Field	Format	Notes
access_token	string	The new token to pass in the `Authorization` header of subsequent requests.
expires_in	integer	Token expiry time in seconds.
token_type	string	Always `bearer`.

{ "access_token": "[ACCESS-TOKEN]", "expires_in": 3600, "token_type": "bearer" }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }