Test whether a token works.
/user/tokens/verify
get
User API Tokens
user-api-tokens-verify-token
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"expires_on": {
"description": "The expiration time on or after which the JWT MUST NOT be accepted for processing.",
"example": "2020-01-01T00:00:00Z",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Token identifier tag.",
"example": "ed17574386854bf78a67040be0a770b0",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"not_before": {
"description": "The time before which the token MUST NOT be accepted for processing.",
"example": "2018-07-01T05:20:00Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the token.",
"enum": [
"active",
"disabled",
"expired"
],
"example": "active",
"type": "string"
}
},
"required": [
"id",
"status"
]
}
},
"type": "object"
}
]
}
}
},
"description": "Verify Token response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"expires_on": {
"description": "The expiration time on or after which the JWT MUST NOT be accepted for processing.",
"example": "2020-01-01T00:00:00Z",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Token identifier tag.",
"example": "ed17574386854bf78a67040be0a770b0",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"not_before": {
"description": "The time before which the token MUST NOT be accepted for processing.",
"example": "2018-07-01T05:20:00Z",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Status of the token.",
"enum": [
"active",
"disabled",
"expired"
],
"example": "active",
"type": "string"
}
},
"required": [
"id",
"status"
]
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Verify Token response failure"
}
}[
{
"api_token": []
}
]