Licensing and Subscriptions
6 min
Subscriptions
Get /api/licenses/subscriptions
Response
{
"items": [
{
"category": "PCS",
"display_name": "21.x PCS",
"end_date": "2022-12-01T00:00:00Z",
"features": {
"allow_support": true,
"named_users": 100000
},
"id": "cfc9ec4b-788a-484f-954d-4f736069021e",
"serial_number": "11-4038621",
"start_date": "2021-01-01T00:00:00Z"
},
{
"category": "ZTA",
"display_name": "zta subscription",
"end_date": "2025-12-04T00:00:00Z",
"features": {
"allow_support": true,
"named_users": 50000
},
"id": "94f5904a-113d-416b-9aa4-3b0755632c8c",
"serial_number": "abc-1200AB",
"start_date": "2022-01-01T00:00:00Z"
}
],
"total": 2
}Delete Users from nSA Named Users Table
Post https://<Controller hostname>/api/licenses/subscribers/products/pcs/delete/named-users
{
"usernames": [
"john_doe"
],
"devices": [
"device 1"
]
}
Response
{
"error": {
"message": "Unexpected Error"
}
}User Details
Post https://<Controller hostname>/api/licenses/subscribers/products/nsa/get-named-users
{
"start": 0,
"limit": 10,
"update_details_from_analytics": true,
"include_gateway_names": true,
"sort": "username",
"direction": "asc",
"operation": "AND",
"status": "active"
}
Response
{
"items": [
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": ["86f1fb8b2c1e4eebb16af281468a14d7"],
"gateway_names": ["ivanti1"],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "IV1"
},
...
],
"total": 100
}License Consumption Count
https://<Controller hostname>/api/licenses/subscribers/products/nsa/named-users-info
Response
{
"consumed": 5,
"total": 100
}Search String
Post https://<Controller hostname>/api/licenses/subscribers/products/nsa/get-named-users
{
"start":0,
"limit":10,
"update_details_from_analytics":true,
"include_gateway_names":true,
"operation":"AND",
"search_string":"SG1",
"sort":"username",
"direction":"asc",
"status":"active"}
}
Response
{
"items": [
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG1"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG10"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG100"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG11"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG12"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG13"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG14"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG15"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG16"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG17"
}
],
"total": 12
}Advanced Filter
Post https://<Controller hostname>/api/licenses/subscribers/products/nsa/get-named-users
{
"operation":"AND",
"filters":[{"key":"gateway","value":"86f1fb8b4c7e4eebb16af281468a14e7"}],
"start":0,
"limit":10,
"update_details_from_analytics":true,
"include_gateway_names":true,
"sort":"username",
"direction":"asc"}
}
Response
{
"items": [
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG1"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG10"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG100"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG11"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG14"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG15"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG16"
},
{
"created": "2025-07-29T09:14:24Z",
"gateway_ids": [
"86f1fb8b4c7e4eebb16af281468a14e7"
],
"gateway_names": [
"gojo6"
],
"status": "active",
"updated": "2025-07-29T09:14:24Z",
"username": "SG17"
}
],
"total": 101
}