Tokens API - GET token metadata

Lists metadata of a DESK API authentication token by the ID of the token. The token itself is not exposed.

Alternatively, you can retrieve metadata by submitting the token itself with the POST token metadata call.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/v1/tokens/{id} SaaS https://{your-environment-id}.live.dexp.ae/api/v1/tokens/{id}

Authentication

To execute this request, you need the Tenant Token Management permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required token.	path	required

Response format

Response parameters JSON model

The TokenMetadata object

Metadata of a token.

Element	Type	Description
id	string	The ID of the token.
name	string	The name of the token.
userId	string	The owner of the token.
revoked	boolean	Revocation status of the token. Revoked tokens are disabled.
created	integer	The creation time as a unix timestamp in milliseconds.
expires	integer	The expiration time as a unix timestamp in milliseconds.
lastUse	integer	The unix timestamp in milliseconds when the token was last used.
scopes	string[]	The list of permissions, assigned to the token.

    
{
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "label": "myToken",
  "userId": "john.smith",
  "revoked": "true",
  "created": "1554076800000",
  "expires": "1585976400000",
  "lastUse": "1554354000000",
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Example

In this example, the request queries the metadata of the admin token, which has the ID of d5836312-5790-4e80-afcf-09971954c3ea.

The API token is passed in the Authorization header.

The token, as displayed in the DESK interface, has the following settings:

DESK API authentication token

Curl

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/v1/tokens/d5836312-5790-4e80-afcf-09971954c3ea \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/tokens/d5836312-5790-4e80-afcf-09971954c3ea

Response body

{
  "id": "d5836312-5790-4e80-afcf-09971954c3ea",
  "name": "admin",
  "userId": "admin@mysampleenv.com",
  "created": "2019-03-13T09:45:40Z",
  "lastUse": "2019-04-04T09:13:23Z",
  "scopes": [
    "ExternalSyntheticIntegration",
    "DataPrivacy",
    "WriteConfig",
    "DssFileManagement",
    "LogExport",
    "DTAQLAccess",
    "ReadConfig",
    "CaptureRequestData",
    "ReadSyntheticData",
    "DataExport",
    "UserSessionAnonymization",
    "MaintenanceWindows",
    "LogImport",
    "TenantTokenManagement"
  ]
}

Response code

200