Admin Login-related APIs
nSA User Rule Groups
Copy
Get api/v1/policies/ui2/user/rule-groups' \
--data-raw '{"limit":10,"offset":0,"sort_by":"name","sort_order":"asc","filters":[],"type":"admin"}'
Response
{
"count": 2,
"items": [
{
"allow_delete": false,
"auto_created": false,
"id": "2891190c7952409687e7db43ed77a8b6",
"is_default": true,
"name": "Administrators",
"role_config": {
"id": "bcebb37e1e85405db98f188cb4a7cca9",
"name": ".Administrators",
"redirect_url": "/admin",
"type": "admin"
},
"role_id": "bcebb37e1e85405db98f188cb4a7cca9",
"rules": [
{
"allow_delete": false,
"attribute": "is",
"id": "ab94fbc66a17458fb7a0aa09fee549ee",
"is_default": true,
"name": "AllAdminUsers",
"type": "username",
"value": "*"
}
],
"sign_in_config": {
"id": "f87680b7292242b9af247fec1b17347c",
"policy_type": "admin",
"primary_auth_server_config": {
"id": "4a02312f7b1f4dd89f5350966feb528d",
"name": "Admin Auth",
"type": "Local"
},
"primary_auth_server_id": "4a02312f7b1f4dd89f5350966feb528d",
"realm": "ZTA Admin Users",
"url_pattern": "*/login/admin/",
"use_as_saml_idp": false
},
"sign_in_policy_id": "f87680b7292242b9af247fec1b17347c",
"sign_in_policy_name": "Admin Signin"
},
{
"allow_delete": false,
"auto_created": false,
"description": "",
"id": "2aa011b9593a4bc8abbbd68e819bfec8",
"is_default": false,
"name": "newAdminUG",
"rules": [
{
"allow_delete": true,
"attribute": "is",
"id": "3db526aed1bf467bbff6022280307168",
"is_default": false,
"name": "newadminrule",
"type": "username",
"value": "*"
}
],
"sign_in_config": {
"id": "ddd3909af4bc407c83be7b9bdc61f988",
"policy_type": "admin",
"primary_auth_server_config": {
"id": "ac7c1729f34a4a0483738b45ca8ee0a6",
"name": "newadminauth",
"type": "Local"
},
"primary_auth_server_id": "ac7c1729f34a4a0483738b45ca8ee0a6",
"realm": "newadminpolicy",
"url_pattern": "*/login/newadmin/",
"use_as_saml_idp": false
},
"sign_in_policy_id": "ddd3909af4bc407c83be7b9bdc61f988",
"sign_in_policy_name": "newadminpolicy"
}
],
"offset": 0,
"total": 2
}
nSA Roles
Copy
Get /api/v1/policies/roles
Response
{
"count": 4,
"items": [
{
"allow_delete": false,
"description": "All pages accessible",
"id": "bcebb37e1e85405db98f188cb4a7cca9",
"is_default": true,
"name": ".Administrators",
"redirect_url": "/admin",
"type": "admin",
"user_group_name": ""
},
{
"allow_delete": true,
"description": "Insights Dashboards, Logs, Reports and Subscriptions",
"id": "985ed98560e64c9dac40b4446218f30b",
"is_default": true,
"name": ".CxOs",
"redirect_url": "/admin",
"type": "admin",
"user_group_name": ""
},
{
"allow_delete": true,
"description": "Gateways Overview and Logs only",
"id": "30c586d61c6e43fcbc79f5b405b6b5bd",
"is_default": true,
"name": ".Network Administrators",
"redirect_url": "/admin",
"type": "admin",
"user_group_name": ""
},
{
"allow_delete": true,
"description": "All except Workflows , Subscriptions , Upgrade and Admin Role",
"id": "5cf6acc4109f41a5b176ef797422d6df",
"is_default": true,
"name": ".Read-Only Administrators",
"redirect_url": "/admin",
"type": "admin",
"user_group_name": ""
}
],
"offset": 0,
"total": 4
}
Create Admin Role
Copy
/api/v1/policies/roles' \
--data-raw '{"name":"newAdminRole","redirect_url":"/admin","type":"admin","description":""}'
Response
{
"allow_delete": true,
"description": "",
"id": "8d876ab32ab14542be79218f3443fddf",
"is_default": false,
"name": "newAdminRole",
"redirect_url": "/admin",
"type": "admin",
"user_groups": []
}
Delete Admin Role
Copy
/api/v1/policies/roles?role_ids=8d876ab32ab14542be79218f3443fddf \
Method: 'DELETE'
Response: 204
Install ESAP
Copy
https://<Controller hostname>/api/pcs-configs/multinode/install_esap
Request
{
"gatewayIds":["4cce0aad63e74ec695d981a06530bb7f"],
"clusterIds":[],
"version":"4.0.5"
}
Response
{
"message": "Successful upgrade"
}