Access Token Operations

Owned by Eddie Webbinaro
Last updated: Jan 18, 2016
2 min read

Provides APIs to create and manage the access tokens required for other APIs

eSecurity

All operations on this page require an Authenticated Administrator

 

View All Tokens

Lists all current tokens and their authorization.

 Click here to expand sample CURL to modify for commands below.
curl -X POST -d'{

  "name": "informational name",

  "read": true,

  "change": false

}' \
http://10.45.80.11:8086/rest/agent-config/1.0/tokens/ \
-H "Content-Type: application/json" \
-uadmin:admin

 

 

 

GET /rest/agent-config/1.0/tokens/
 Click here to expand...
Response
[
  {
    "uuid": "d0ea6653-05e2-4d51-9d89-665cdfe86be6",
    "name": "readOnly",
    "read": true,
    "change": false
  },
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "read and write",
    "read": true,
    "change": true
  }
]

 

Create Token

Returns full details of the requested token, including assigned UUID.

POST /rest/agent-config/1.0/tokens/
 Click here to expand to see request...
Response
  {
    "name": "informational name",
    "read": true,
    "change": false
  }

Note: Response mirrors request but includes the UUID.

 Click here to expand response...
Response
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "informational name",
    "read": true,
    "change": false
  }

Update Token

Alter the name, or permissions of an existing token.

PUT /rest/agent-config/1.0/tokens/{tokenId}
 Click here to expand to see request...
Response
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

Note: Response mirrors request 

 Click here to expand response...
Response
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

 

Pre v1.5

 Click here to expand url paths for < 1.5

View All Tokens

Lists all current tokens and their authorization.

GET /rest/agent/1.0/tokens/
 Click here to expand...
Response
[
  {
    "uuid": "d0ea6653-05e2-4d51-9d89-665cdfe86be6",
    "name": "readOnly",
    "read": true,
    "change": false
  },
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "read and write",
    "read": true,
    "change": true
  }
]

 

Create Token

Returns full details of the requested token, including assigned UUID.

POST /rest/agent/1.0/tokens
 Click here to expand to see request...
Response
  {
    "name": "informational name",
    "read": true,
    "change": false
  }

Note: Response mirrors request but includes the UUID.

 Click here to expand response...
Response
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "informational name",
    "read": true,
    "change": false
  }

Update Token

Alter the name, or permissions of an existing token.

PUT /rest/agent/1.0/tokens/{tokenId}
 Click here to expand to see request...
Response
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

Note: Response mirrors request 

 Click here to expand response...
Response
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }