Resource ia:tokens

Overview

The ia:tokens resource represents the list of tokens in the system.

Properties

The ia:tokens resource has the following properties:

tokens

An array of JSON objects. If ID was a full name of the token there would be only the one element, otherwise there should be multiple objects. Each JSON object represents one token and has the following sub properties:

  • name: name of the token, acts as ID

  • value: string representation of token value

The ia:tokens resource has no link relations.

Description

The ia:tokens resource represents the list of tokens in the system.

Examples

Example: Token ID equals to "Q_DEAD"
 
{
  "tokens": [
    {
      "name": "Q_DEAD",
      "value": "dead"
    }
  ],
  "_links": {
    "self": {
      "href": "https://host/.."
    }
  }
}
 

Example: Token ID equals to "D_"
 
{
  "tokens": [
    {
      "name": "D_AUTHORIZED",
      "value": "Not allowed"
    },
    {
      "name": "D_BADARG",
      "value": "Bad argument"
    },
    {
      "name": "D_BADDEST",
      "value": "Bad destination"
    },
    {
      "name": "D_ERROR",
      "value": "System error"
    },
    {
      "name": "D_NOARG",
      "value": "Needs argument"
    },
    {
      "name": "D_OFFLINE",
      "value": "Offline"
    },
    {
      "name": "D_UNKNOWN",
      "value": "Unknown command"
    }
  ],
  "_links": {
    "self": {
      "href": "https://host/.."
    }
  }
}