To authenticate Third-Party Device-ID API requests, you must use the signed certificate
and API token you obtained during onboarding in the Cloud Identity Engine
user interface.
The Third-Party Device-ID service allows a maximum of two tokens for any tenant and
vendor ID combination. You can perform five attempts to refresh the token. After you
have reached the maximum number of token attempts, you can perform two additional token
requests every hour.
Synopsis
URI
/api/v1/token/token:refresh
(recommended API
method)
/api/v1/token/{apiKey}/token:refresh
(legacy API method)
HTTP Method
GET
Success Response
Upon success, the HTTP response code is 200. In addition, the response
contains a JSON object with the following fields:
Field
Description
token
The newly-created token.
expiry
The expiration date of the token.
deletedToken
The name of the token that was deleted.
If there are more than
the two tokens already in use, the oldest token is deleted and
its name returned in the deletedToken response. If there
is no deleted token, deletedToken returns an empty
string.
For example:
Header: {
"apiKey": "string"
}
Error Response
Upon error, the HTTP response code is one of the following:
Response Code
Description
400
Invalid request.
401
Unauthorized. Try regenerating your API certificate. If that
doesn’t work, contact support.
409
Conflict. The request couldn’t be processed because there is
another ongoing update or delete job. Try again after the other job
finishes.
429
Too many requests. The request could not be processed because too
many requests have been issued in a specific period of time.
In addition, the response body contains the following fields:
