API authentication tokens API - POST token lookup
Gets metadata of the API token by its secret.
The request consumes and produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
POST |
|
Authentication
To execute this request, you need any permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | ApiTokenSecret |
The JSON body of the request. Contains the required token. |
body | optional |
Body format
The ApiTokenSecret object
Element | Type | Description | Required |
---|---|---|---|
token | string |
The API token. |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM"
}
Response
Response codes
Code | Description |
---|---|
200 | Success |
404 | Failed. The requested resource doesn't exist. |
Response body
The ApiToken object
Metadata of an API token.
Element | Type | Description |
---|---|---|
lastUsedDate | string | Token last used date in ISO 8601 format ( |
lastUsedIpAddress | string | Token last used IP address. |
expirationDate | string | Token expiration date in ISO 8601 format ( |
personalAccessToken | boolean | The token is a personal access token ( |
name | string | The name of the token. |
id | string | The ID of the token, consisting of prefix and public part of the token. |
owner | string | The owner of the token. |
creationDate | string | Token creation date in ISO 8601 format ( |
enabled | boolean | The token is enabled ( |
scopes | string[] | A list of scopes assigned to the token. |
{
"lastUsedDate": "2020-11-12T08:15:30.144Z",
"lastUsedIpAddress": "34.197.2.44",
"expirationDate": "2020-11-12T08:15:30.144Z",
"personalAccessToken": true,
"name": "myToken",
"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN",
"owner": "john.smith",
"creationDate": "2020-11-05T08:15:30.144Z",
"enabled": true,
"scopes": [
"string"
]
}