Additional References
9 min
to see a list of the default secure access policies input payload {'type' 'application'} request uri ``https //\<tenant domain>/api/v1/policies/secure access policies`` returned status code 200 returned json response {'items' \[], 'total' 0} to retrieve the default user auth server id input payload {} request uri ``https //\<tenant domain>/api/v1/policies/auth servers`` returned status code 200 returned json response { 'auth servers' \[{ 'id' '4a02312f7b1f4dd89f5350966feb528d', 'name' 'admin auth', 'type' 'local' }, { 'id' '706960d40e43451786f6f5d6c598d7fa', 'name' 'user auth', 'type' 'local' }], 'total' 2 } retrieving a list of the default user policies input payload {'type' 'sign in'} request uri https //\<tenant domain>/api/v1/policies/resources returned status code 200 returned json response { 'items' \[{ 'description' 'admin signin', 'id' 'f87680b7292242b9af247fec1b17347c', 'name' 'admin signin', 'sign in config' { 'id' 'f87680b7292242b9af247fec1b17347c', 'policy type' 'admin', 'primary auth server id' '4a02312f7b1f4dd89f5350966feb528d', 'realm' 'zta admin users', 'url pattern' ' /login/admin/', 'use as saml idp' false }, 'type' 'sign in' }, { 'description' 'enrollment signin', 'id' 'cb8753de76fb45d581e07d4bc700cb67', 'name' 'enrollment signin', 'sign in config' { 'id' 'cb8753de76fb45d581e07d4bc700cb67', 'policy type' 'enroll', 'primary auth server id' '706960d40e43451786f6f5d6c598d7fa', 'realm' 'zta enrollment', 'url pattern' ' /login/enroll/', 'use as saml idp' false }, 'type' 'sign in' }, { 'description' 'user signin', 'id' '21ff78e93fda4b0c86e7af96dfa75680', 'name' 'user signin', 'sign in config' { 'id' '21ff78e93fda4b0c86e7af96dfa75680', 'policy type' 'user', 'primary auth server id' '706960d40e43451786f6f5d6c598d7fa', 'realm' 'zta users', 'url pattern' ' /login/', 'use as saml idp' false }, 'type' 'sign in' }], 'total' 3 } adding a new user authentication server "auth server 1" of type "local" input payload { 'name' 'auth server 1', 'type' 'local', 'local config' { 'users' \[] } } request uri ``https //\<tenant domain>/api/v1/policies/auth servers`` returned status code 200 returned json response { 'allow delete' true, 'id' '0b634b96bcb04dc98072cf28c5129a91', 'name' 'auth server 1', 'type' 'local' } editing the user policy user signin by changing auth server to "auth server 1" input payload { 'name' 'user signin', 'description' 'user signin', 'sign in config' { 'policy type' 'user', 'primary auth server id' '0b634b96bcb04dc98072cf28c5129a91', 'realm' 'zta users', 'url pattern' ' /login/', 'use as saml idp' false }, 'type' 'sign in', 'id' '21ff78e93fda4b0c86e7af96dfa75680' } request uri ``https //\<tenant domain>/api/v1/policies/resources/21ff78e93fda4b0c86e7af96dfa75680`` returned status code 200 returned json response { 'allow delete' false, 'description' 'user signin', 'id' '21ff78e93fda4b0c86e7af96dfa75680', 'name' 'user signin', 'sign in config' { 'id' '21ff78e93fda4b0c86e7af96dfa75680', 'policy type' 'user', 'primary auth server config' { 'id' '0b634b96bcb04dc98072cf28c5129a91', 'name' 'auth server 1', 'type' 'local' }, 'primary auth server id' '0b634b96bcb04dc98072cf28c5129a91', 'realm' 'zta users', 'role mapping rules' \[{ 'attribute' 'is', 'id' 'bb77d22ae3b440bbb3d464f0df50f4af', 'name' 'allusers', 'type' 'username', 'value' ' ' }], 'url pattern' ' /login/', 'use as saml idp' false }, 'type' 'sign in' } adding user rule "user rule 1" of type "username" for an expression matching input payload { 'name' 'user rule 1', 'type' 'username', 'value' 'user rule 1', 'attribute' 'is' } request uri ``https //\<tenant domain>/api/v1/policies/role mapping rules`` returned status code 200 returned json response { 'attribute' 'is', 'id' 'b48d02408ad14992bfde266e9b5a43a8', 'name' 'user rule 1', 'type' 'username', 'value' 'user rule 1' } adding a user group "user group 1" of authentication policy type "user" input payload { 'name' 'user group 1', 'sign in policy id' '21ff78e93fda4b0c86e7af96dfa75680', 'description' 'user group 1', 'rules' \[] } request uri ``https //\<tenant domain>/api/v1/policies/user rule groups`` returned status code 200 returned json response { 'allow delete' true, 'description' 'user group 1', 'id' '71bc234b6c8f46a9806dfdc0e33df05d', 'name' 'user group 1', 'role config' { 'id' 'a44e4ac7ae114e009fd2f2bd457c1480', 'name' 'user group 1', 'redirect url' '/user', 'type' 'user' }, 'role id' 'a44e4ac7ae114e009fd2f2bd457c1480', 'sign in config' { 'id' '21ff78e93fda4b0c86e7af96dfa75680', 'policy type' 'user', 'primary auth server config' { 'id' '0b634b96bcb04dc98072cf28c5129a91', 'name' 'auth server 1', 'type' 'local' }, 'primary auth server id' '0b634b96bcb04dc98072cf28c5129a91', 'realm' 'zta users', 'url pattern' ' /login/', 'use as saml idp' false }, 'sign in policy id' '21ff78e93fda4b0c86e7af96dfa75680' } editing user group "user group 1" by adding user rule "user rule 1" input payload {} request uri ``https //\<tenant domain>/api/v1/policies/user rule groups/71bc234b6c8f46a9806dfdc0e33df05d/rule/b48d02408ad14992bfde266e9b5a43a8`` returned status code 204 editing user authentication server "auth server 1" by adding user "newuser1" input payload { 'name' 'newuser1', 'full name' 'newuser1', 'password' 'dana123' } request uri ``https //\<tenant domain>/api/v1/policies/auth servers/0b634b96bcb04dc98072cf28c5129a91/users`` returned status code 200 adding device policy rule "device rule 1" of type network rule input payload { 'name' 'device rule 1', 'description' 'device rule 1', 'network config' { 'ip address' '192 168 1 1', 'netmask' '255 255 255 0', 'mode' 'allow' }, 'label' 'moderate', 'type' 'network' } request uri ``https //\<tenant domain>/api/v1/policies/device policies/rules`` returned status code 200 returned json response { 'description' 'device rule 1', 'id' 'aab467febf0b45af99be71f25cb0fdbc', 'label' 'moderate', 'name' 'device rule 1', 'network config' { 'id' '98e55fe902b64d6abe45ec38012a64af', 'ip address' '192 168 1 1', 'mode' 'allow', 'netmask' '255 255 255 0' }, 'network config id' '98e55fe902b64d6abe45ec38012a64af', 'type' 'network' } adding device policy "device policy 1" input payload {} request uri ``https //\<tenant domain>/api/v1/policies/device policies/groups/deb6e20a2f1a4c5dac98772525a7d350/rules/aab467febf0b45af99be71f25cb0fdbc`` returned status code 204 editing device policy "device policy 1" by adding device policy rule "device rule 1" input payload { 'name' 'device policy 1', 'description' 'device policy 1' } request uri ``https //\<tenant domain>/api/v1/policies/device policies/groups`` returned status code 200 returned json response { 'description' 'device policy 1', 'id' 'deb6e20a2f1a4c5dac98772525a7d350', 'name' 'device policy 1', 'rules' \[] } adding a new application "app1" input payload { 'type' 'application', 'name' 'app1', 'description' 'app1', 'app config' { 'access type' 'application', 'name' 'app1', 'resource' 'https //www intuit com', 'resource type' 'url', 'bookmark config' { 'name' 'app1', 'type' 'web', 'description' 'app1', 'launch window' true, 'url' 'https //www intuit com', 'icon' '/admin/static/media/intuit512 2fdd1f2f svg' } } } request uri ``https //\<tenant domain>/api/v1/policies/resources`` returned status code 200 returned json response { 'allow delete' true, 'app config' { 'access type' 'application', 'bookmark config' { 'description' 'app1', 'icon' '/admin/static/media/intuit512 2fdd1f2f svg', 'id' '79418be3ce3a4ae4895d2d0223c2bf49', 'launch window' true, 'name' 'app1', 'type' 'web', 'url' 'https //www intuit com' }, 'id' 'd3328c9a86ed42d0aa1d90432e4f7fb7', 'name' 'app1', 'resource' 'https //www intuit com', 'resource type' 'url' }, 'description' 'app1', 'id' 'd3328c9a86ed42d0aa1d90432e4f7fb7', 'name' 'app1', 'type' 'application' } adding a new gateway "gw1" of type vsphere with manual settings input payload { 'name' 'gw1', 'orchestration' { 'type' 'vsphere' }, 'location' { 'city id' 97 } } request uri ``https //\<tenant domain>/api/gateways`` returned status code 200 returned json response { 'auto upgrade' true, 'created' '2020 09 10t05 29 39z', 'id' 'b7c3fca3993a4addaa4fe08958afa013', 'is ready' false, 'location' { 'city id' 97 }, 'name' 'gw1', 'notification channel status' 'offline', 'orchestration' { 'mode' 'manual', 'type' 'vsphere' }, 'sdp mode' 'pzt gateway', 'state' 'unregistered', 'updated' '2020 09 10t05 29 39z' } input payload { 'service account id' none, 'appliance config' { 'external gateway' '\<ip address>', 'external ip address' '\<ip address>', 'external subnet' '255 255 255 0', 'external vlan' ' 1', 'internal fqdn' '', 'internal gateway' '\<ip address>', 'internal ip address' '\<ip address>', 'internal subnet' '255 255 255 0', 'internal vlan' ' 1', 'management gateway' '\<ip address>', 'management ip address' '\<ip address>', 'management subnet' '255 255 255 0', 'management vlan' ' 1', 'primary dns' '\<ip address>', 'private domain name' 'psecure net', 'secondary dns' '\<ip address>', 'dns search domain' '\<domain>', 'public ip address' '\<ip address>' }, 'deployment config' none } request uri ``https //\<tenant domain>/api/gateways/b7c3fca3993a4addaa4fe08958afa013/orchestration`` returned status code 200 returned json response { 'appliance config' { 'dns search domain' 'psecure net', 'external fqdn' '\<server>', 'external gateway' '1\<ip address>', 'external ip address' '1\<ip address>', 'external subnet' '255 255 255 0', 'internal fqdn' '', 'internal gateway' '\<ip address>', 'internal ip address' '\<ip address>', 'internal subnet' '255 255 255 0', 'management gateway' '\<ip address>', 'management ip address' '\<ip address>', 'management subnet' '255 255 255 0', 'primary dns' '\<ip address>', 'private domain name' 'psecure net', 'public ip address' '\<ip address>', 'secondary dns' '\<ip address>', 'use dhcp' true, 'wins server' 'localhost' }, 'appliance id' 'b7c3fca3993a4addaa4fe08958afa013' } adding a new secure access policy for the above configurations input payload { 'type' 'application', 'resource type' 'single', 'user rule group id' '71bc234b6c8f46a9806dfdc0e33df05d', 'gateway type' 'single', 'gateway id' 'b7c3fca3993a4addaa4fe08958afa013', 'resource id' 'd3328c9a86ed42d0aa1d90432e4f7fb7', 'device policy id' 'deb6e20a2f1a4c5dac98772525a7d350' } request uri ``https //\<tenant domain>/api/v1/policies/secure access policies`` returned status code 200 returned json response { 'device policy config' { 'name' 'device policy 1' }, 'device policy id' 'deb6e20a2f1a4c5dac98772525a7d350', 'gateway id' 'b7c3fca3993a4addaa4fe08958afa013', 'gateway type' 'single', 'id' 'c90a3e348a0f4fed868d5acd09655aa6', 'resource config' { 'name' 'app1' }, 'resource id' 'd3328c9a86ed42d0aa1d90432e4f7fb7', 'resource type' 'single', 'type' 'application', 'user rule group config' { 'name' 'user group 1', 'role config' { 'id' 'a44e4ac7ae114e009fd2f2bd457c1480', 'name' 'user group 1', 'redirect url' '/user', 'type' 'user' } }, 'user rule group id' '71bc234b6c8f46a9806dfdc0e33df05d' }
