{ "opencollection": "1.0.0", "info": { "name": "Openpath API Documentation auth orgs/zones API", "version": "1.0.0" }, "items": [ { "info": { "name": "orgs/zones", "type": "folder" }, "items": [ { "info": { "name": "List all owned or shared zones", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w" }, { "info": { "name": "Create a zone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones", "params": [ { "name": "orgId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w

__Endpoint name__: createZone" }, { "info": { "name": "Describe an owned or shared zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: describeZone" }, { "info": { "name": "Update a zone", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: updateZone" }, { "info": { "name": "Delete a zone", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: deleteZone" }, { "info": { "name": "List all zone anti-passback areas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/apbAreas", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneApbAreas" }, { "info": { "name": "Create a zone anti-passback area", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/apbAreas", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: createZoneApbArea" }, { "info": { "name": "List all group IDs of a zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/groupIds", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneGroupIds" }, { "info": { "name": "Set a zone's groups by replacing the entire set with this one", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/groupIds", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setZoneGroupIds" }, { "info": { "name": "List all users (and their associated configurations) of a zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneUsers", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneZoneUsers" }, { "info": { "name": "Set a zone's users (and their associated configurations) by replacing the entire set with this one", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneUsers", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setZoneZoneUsers" }, { "info": { "name": "Bulk-update a zone's users (and their associated configurations)", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneUsers", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: updateZoneZoneUsers" }, { "info": { "name": "List all users of a zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/users", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" }, { "name": "options", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneUsers" }, { "info": { "name": "List all shares of this zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/shares", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneShares" }, { "info": { "name": "List all groups of a zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/groups", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" }, { "name": "options", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneGroups" }, { "info": { "name": "List all groups (and their associated configurations) of a zone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneGroups", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listZoneZoneGroups" }, { "info": { "name": "Set a zone's groups (and their associated configurations) by replacing the entire set with this one", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneGroups", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setZoneZoneGroups" }, { "info": { "name": "Bulk-update a zone's groups (and their associated configurations)", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/zoneGroups", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: updateZoneZoneGroups" }, { "info": { "name": "Describe a zone anti-passback area", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/apbAreas/:apbAreaId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "apbAreaId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: describeZoneApbArea" }, { "info": { "name": "Update a zone anti-passback area", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/apbAreas/:apbAreaId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "apbAreaId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: updateZoneApbArea" }, { "info": { "name": "Delete a zone anti-passback area", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/apbAreas/:apbAreaId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "apbAreaId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: deleteZoneApbArea" }, { "info": { "name": "Reset anti-passback for a zone and/or user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones/apbReset", "params": [ { "name": "orgId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: resetApb" }, { "info": { "name": "Unshare zone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/unshare", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: unshareZone" }, { "info": { "name": "Share zone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/share", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: shareZone" }, { "info": { "name": "Relinquish shared zone from shared-to org", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/relinquishShare", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: relinquishZoneShare" }, { "info": { "name": "Add a user to a zone", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/users/:userId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setUserToZone" }, { "info": { "name": "Remove a user from a zone", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/users/:userId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: removeUserFromZone" }, { "info": { "name": "Add a group to a zone", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/groups/:groupId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setGroupToZone" }, { "info": { "name": "Remove a group from a zone", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/groups/:groupId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: removeGroupFromZone" }, { "info": { "name": "Set a zone's users by replacing the entire set with this one", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/userIds", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setZoneUserIds" }, { "info": { "name": "Set this zone's shares by replacing the entire set with this one", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/orgs/:orgId/zones/:zoneId/shareOrgIds", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "zoneId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w

__Endpoint name__: setZoneShareOrgIds" } ] } ], "bundled": true }