Search Application Token Account

1 min

POST

{{url}}/aioc-rest-web/rest/aapm/searchAapmAccounts

Request Overview

The Search Application Token Account API allows users to query application token accounts as a filter. If no value is entered, all records will be returned.

The important fields returned in the response are:

applicationName (string)
- Filters token accounts by their application name.
- Leave empty to return all accounts.
applicationIPs (array of strings)
- Filters accounts by allowed IP addresses in CIDR format (e.g., "0.0.0.0/0" or "192.168.1.1").
- Optional field.
sapmAccounts (array of integers)
- Filters tokens associated with specific SAPM account IDs.
- Optional field.

To list all tokens, send an empty body

Search Application Token Account parameters

POST /rest/aapm/searchAapmAccounts accepts AapmAccountSearchRequestModel. Sending {} applies no filters and returns all AAPM accounts accessible to the session user.

JSON field	Type	Required	Description
`dbId`	Array[Long]	No	Filter by AAPM account database IDs.
`token`	Array[String]	No	Filter by application tokens.
`level`	SecurityLevel	No	Filter by security level.
`applicationName`	String	No	Filter by application name. Empty string is ignored.
`applicationIPs`	Array[String]	No	Filter by allowed client IP addresses.
`eventUserId`	Array[String]	No	Filter by event-user UUIDs.
`sapmAccounts`	Array[Long]	No	Filter by linked SAPM account IDs.
`sapmGroups`	Array[Long]	No	Filter by linked SAPM group IDs.
`firstResult`	Integer	No	Zero-based result offset.
`maxResult`	Integer	No	Maximum number of results to return.

Path Parameters

urlstring
Default
url

Header Parameters

x-xsrf-tokenstring
Default
{{csrftoken}}

Body Parameters

bodyobject
Default
{ "applicationName": "ExampleApplication", "applicationIPs": [ "192.0.2.10" ], "sapmAccounts": [ 100001 ], "firstResult": 0, "maxResult": 50 }

Responses

200Search Application Token Account

curl

curl --request POST \
     --url {{url}}/aioc-rest-web/rest/aapm/searchAapmAccounts \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-xsrf-token: {{csrftoken}}' \
     --data '"{\n  \"applicationName\": \"ExampleApplication\",\n  \"applicationIPs\": [\n    \"192.0.2.10\"\n  ],\n  \"sapmAccounts\": [\n    100001\n  ],\n  \"firstResult\": 0,\n  \"maxResult\": 50\n}"'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-xsrf-token", "{{csrftoken}}");

var raw = JSON.stringify("{\n  \"applicationName\": \"ExampleApplication\",\n  \"applicationIPs\": [\n    \"192.0.2.10\"\n  ],\n  \"sapmAccounts\": [\n    100001\n  ],\n  \"firstResult\": 0,\n  \"maxResult\": 50\n}");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("{{url}}/aioc-rest-web/rest/aapm/searchAapmAccounts", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("{{url}}/aioc-rest-web/rest/aapm/searchAapmAccounts")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-xsrf-token"] = "{{csrftoken}}"
request.body = JSON.dump("{\n  \"applicationName\": \"ExampleApplication\",\n  \"applicationIPs\": [\n    \"192.0.2.10\"\n  ],\n  \"sapmAccounts\": [\n    100001\n  ],\n  \"firstResult\": 0,\n  \"maxResult\": 50\n}")

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "{{url}}/aioc-rest-web/rest/aapm/searchAapmAccounts"

payload = json.dumps("{\n  \"applicationName\": \"ExampleApplication\",\n  \"applicationIPs\": [\n    \"192.0.2.10\"\n  ],\n  \"sapmAccounts\": [\n    100001\n  ],\n  \"firstResult\": 0,\n  \"maxResult\": 50\n}")
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-xsrf-token': '{{csrftoken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

[
  {
    "dbId": 200001,
    "applicationName": "ExampleApplication",
    "applicationIPs": [
      "192.0.2.10/32"
    ],
    "sapmAccounts": [
      100001
    ],
    "sapmGroups": [],
    "restrictions": {
      "allowListingAccounts": true,
      "maxUsageCount": 50
    },
    "level": "BASIC_PIN_PATH_HASH",
    "properties": {},
    "token": "REDACTED_EXAMPLE_TOKEN",
    "lastAccessTime": null,
    "numberOfUsage": 0
  }
]