# Openpath Security Documentation

> Openpath Security provides access control for the modern workplace.

## Guides
- [Introduction](https://openpath.readme.io/docs/basics-to-start.md)
- [Key concepts](https://openpath.readme.io/docs/key-concepts.md): A quick intro to the business logic you'll need to understand and use the API
- [Authenticating with the API](https://openpath.readme.io/docs/using-the-api.md): Authenticate using the Login API or Basic Authentication
- [Query Parameters](https://openpath.readme.io/docs/query-parameters.md): A description of common query parameters when using GET APIs to retrieve a list of items
- [Results pagination](https://openpath.readme.io/docs/results-pagination.md)
- [Best Practices](https://openpath.readme.io/docs/best-practices.md): Best Practices for integrating with the API
- [Sample code](https://openpath.readme.io/docs/sample-code.md)
- [Overview](https://openpath.readme.io/docs/mobile-sdk.md)

## API Reference
- [Describe an access token's associated identity and scopes](https://openpath.readme.io/reference/describeaccesstoken.md): __Endpoint name__: describeAccessToken
- [Login](https://openpath.readme.io/reference/login.md): __Endpoint name__: login
- [Login all successful matches for email/password](https://openpath.readme.io/reference/loginall.md): __Endpoint name__: loginAll
- [Logout](https://openpath.readme.io/reference/logout.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: logout
- [Send email to reset password](https://openpath.readme.io/reference/resetpassword.md): __Endpoint name__: resetPassword
- [Send email with magic link to setup mobile](https://openpath.readme.io/reference/setupmobile.md): __Endpoint name__: setupMobile
- [Create a new access token with refreshed scopes and expiration time, invalidate old token](https://openpath.readme.io/reference/refreshlogin.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: refreshLogin
- [DEPRECATED - use /auth/sso/authorize instead](https://openpath.readme.io/reference/getoidcauthurl.md): __Endpoint name__: getOidcAuthUrl
- [Generate SSO authorize URL (may be OIDC or SAML)](https://openpath.readme.io/reference/getssoauthurl.md): __Endpoint name__: getSsoAuthUrl
- [Validate an access token for proper signature, format, expiration, and active status](https://openpath.readme.io/reference/validateaccesstoken.md): Possible error names: TokenExpiredError, JsonWebTokenError, TokenNotFoundError<br/><br/>__Endpoint name__: validateAccessToken
- [List an identity's nicknames](https://openpath.readme.io/reference/listidentitynicknames.md): __JWT is required for this endpoint with at least one of the following scopes__: i{params.identityId}:w,i{params.identityId}:r,i:w,i:r<br/><br/>__Endpoint name__: listIdentityNicknames
- [Bulk-update an identity's nicknames](https://openpath.readme.io/reference/updateidentitynicknames.md): __JWT is required for this endpoint with at least one of the following scopes__: i{params.identityId}:w,i:w<br/><br/>__Endpoint name__: updateIdentityNicknames
- [List all ACU models](https://openpath.readme.io/reference/listacumodels.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcuModels
- [Describe an ACU model](https://openpath.readme.io/reference/describeacumodel.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuModel
- [List all ACU port types](https://openpath.readme.io/reference/listacuporttypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcuPortTypes
- [Describe an ACU port type](https://openpath.readme.io/reference/describeacuporttype.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuPortType
- [List all owned or assigned ACUs](https://openpath.readme.io/reference/listacus.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt: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}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcus
- [Create an ACU](https://openpath.readme.io/reference/createacu.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-quickStart:w,o{params.orgId}-admin:w,o:w,s-o:w<br/><br/>__Endpoint name__: createAcu
- [Describe an owned or assigned ACU](https://openpath.readme.io/reference/describeacu.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcu
- [Update an ACU](https://openpath.readme.io/reference/updateacu.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateAcu
- [Delete an ACU](https://openpath.readme.io/reference/deleteacu.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteAcu
- [List ACU ports](https://openpath.readme.io/reference/listacuports.md): __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}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcuPorts
- [Describe an owned or assigned ACU's timezone](https://openpath.readme.io/reference/describeacutimezone.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeAcuTimezone
- [List location measurements for an ACU](https://openpath.readme.io/reference/listaculocationmeasurements.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcuLocationMeasurements
- [Get location restriction for an ACU](https://openpath.readme.io/reference/getaculocationrestriction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getAcuLocationRestriction
- [Delete location restriction for an ACU](https://openpath.readme.io/reference/deleteaculocationrestriction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteAcuLocationRestriction
- [Set location restriction for an ACU](https://openpath.readme.io/reference/setaculocationrestriction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: setAcuLocationRestriction
- [List all expansion boards belonging to an ACU](https://openpath.readme.io/reference/listacuexpansionboards.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAcuExpansionBoards
- [Create an expansion board for an ACU](https://openpath.readme.io/reference/createacuexpansionboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: createAcuExpansionBoard
- [Set expansion boards for an ACU](https://openpath.readme.io/reference/setacuexpansionboards.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setAcuExpansionBoards
- [Describe an expansion board belonging to an ACU](https://openpath.readme.io/reference/describeacuexpansionboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuExpansionBoard
- [Update an expansion board belonging to an ACU](https://openpath.readme.io/reference/updateacuexpansionboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateAcuExpansionBoard
- [Delete an expansion board belonging to an ACU](https://openpath.readme.io/reference/deleteacuexpansionboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteAcuExpansionBoard
- [Describe a location measurement for an ACU](https://openpath.readme.io/reference/describeaculocationmeasurement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuLocationMeasurement
- [Delete a location measurement for an ACU](https://openpath.readme.io/reference/deleteaculocationmeasurement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteAcuLocationMeasurement
- [Describe an ACU port](https://openpath.readme.io/reference/describeacuport.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuPort
- [Update an ACU port](https://openpath.readme.io/reference/updateacuport.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateAcuPort
- [Describe an ACU port's EOL settings](https://openpath.readme.io/reference/describeacuporteol.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeAcuPortEol
- [Update an ACU port's EOL settings](https://openpath.readme.io/reference/updateacuporteol.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateAcuPortEol
- [Trigger a software update for ACUs](https://openpath.readme.io/reference/triggeracussoftwareupdate.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: triggerAcusSoftwareUpdate
- [Run a command on an ACU](https://openpath.readme.io/reference/remoteacuruncommand.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-acu:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuRunCommand
- [Remotely trigger an ACU to restart its hardware communicator](https://openpath.readme.io/reference/remoteacurestarthardware.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuRestartHardware
- [Remotely trigger an ACU to restart its API server](https://openpath.readme.io/reference/remoteacurestartapi.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuRestartApi
- [Remotely trigger an ACU to identify itself via LED](https://openpath.readme.io/reference/remoteacuidentify.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuIdentify
- [Trigger a software update for a single ACU](https://openpath.readme.io/reference/triggeracusoftwareupdate.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: triggerAcuSoftwareUpdate
- [Remotely trigger an ACU to refresh its device shadow](https://openpath.readme.io/reference/remoteacurefreshshadow.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuRefreshShadow
- [Remotely trigger an ACU to restart its cloud communicator](https://openpath.readme.io/reference/remoteacurestartcloud.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: remoteAcuRestartCloud
- [ACU sets a location measurement for itself](https://openpath.readme.io/reference/setaculocationmeasurementself.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o{params.orgId}-acu{params.acuId}:orgAcu-locationMeasurementSelf:w<br/><br/>__Endpoint name__: setAcuLocationMeasurementSelf
- [Set a location measurement for an ACU](https://openpath.readme.io/reference/setaculocationmeasurement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: setAcuLocationMeasurement
- [Set an ACU's status and nucleon config group name](https://openpath.readme.io/reference/setacustatus.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-acu{params.acuId}:orgAcu-setAcuStatus:w,o:w<br/><br/>__Endpoint name__: setAcuStatus
- [List all contact sensors](https://openpath.readme.io/reference/listcontactsensors.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listContactSensors
- [Describe a contact sensor](https://openpath.readme.io/reference/describecontactsensor.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeContactSensor
- [Update a contact sensor](https://openpath.readme.io/reference/updatecontactsensor.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateContactSensor
- [List all credential types](https://openpath.readme.io/reference/listcredentialtypes.md): __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}-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}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCredentialTypes
- [Describe a credential type](https://openpath.readme.io/reference/describecredentialtype.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCredentialType
- [List all no tour credential commands for which the given credential is the target](https://openpath.readme.io/reference/listtargetoforgnotourcredentialcommands.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTargetOfOrgNoTourCredentialCommands
- [List all no tour credential commands for the given credential](https://openpath.readme.io/reference/listorgnotourcredentialcommands.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgNoTourCredentialCommands
- [Set the no tour credential commands for a credential](https://openpath.readme.io/reference/updateorgnotourcredentialcommands.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w<br/><br/>__Endpoint name__: updateOrgNoTourCredentialCommands
- [List all no tour credential sectors needed for this credential](https://openpath.readme.io/reference/listorgnotourcredentialsectorspost.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgNoTourCredentialSectorsPost
- [List all custom field types](https://openpath.readme.io/reference/listcustomfieldtypes.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCustomFieldTypes
- [Describe a custom field type](https://openpath.readme.io/reference/describecustomfieldtype.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCustomFieldType
- [List all custom fields](https://openpath.readme.io/reference/listcustomfields.md): __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}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCustomFields
- [Create a custom field](https://openpath.readme.io/reference/createcustomfield.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createCustomField
- [Bulk update custom fields](https://openpath.readme.io/reference/updatecustomfields.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateCustomFields
- [Describe a custom field](https://openpath.readme.io/reference/describecustomfield.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCustomField
- [Update a custom field](https://openpath.readme.io/reference/updatecustomfield.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateCustomField
- [Delete a custom field](https://openpath.readme.io/reference/deletecustomfield.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteCustomField
- [List all custom field dropdown items](https://openpath.readme.io/reference/listcustomfielddropdownitems.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCustomFieldDropdownItems
- [Create a custom field dropdown item](https://openpath.readme.io/reference/createcustomfielddropdownitem.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createCustomFieldDropdownItem
- [Bulk update custom field dropdown items](https://openpath.readme.io/reference/updatecustomfielddropdownitems.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateCustomFieldDropdownItems
- [Describe a custom field dropdown item](https://openpath.readme.io/reference/describecustomfielddropdownitem.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCustomFieldDropdownItem
- [Update a custom field dropdown item](https://openpath.readme.io/reference/updatecustomfielddropdownitem.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateCustomFieldDropdownItem
- [Delete a custom field dropdown item](https://openpath.readme.io/reference/deletecustomfielddropdownitem.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteCustomFieldDropdownItem
- [List all entries](https://openpath.readme.io/reference/listentries.md): Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-musterReport:w,o{params.orgId}-musterReport:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntries
- [Create an entry](https://openpath.readme.io/reference/createentry.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createEntry
- [Describe an entry](https://openpath.readme.io/reference/describeentry.md): Possible comma separated values for the options parameter include: withEffectiveLocationRestriction, withShadows. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt: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<br/><br/>__Endpoint name__: describeEntry
- [Update an entry](https://openpath.readme.io/reference/updateentry.md): __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<br/><br/>__Endpoint name__: updateEntry
- [Delete an entry](https://openpath.readme.io/reference/deleteentry.md): __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<br/><br/>__Endpoint name__: deleteEntry
- [List all cameras of an entry](https://openpath.readme.io/reference/listentrycameras.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-opvideoDevice:r,o{params.orgId}-opvideoDevice:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryCameras
- [List all third party reader - wiegands of an entry](https://openpath.readme.io/reference/listentrythirdpartywiegands.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryThirdPartyWiegands
- [List all wiegands of an entry](https://openpath.readme.io/reference/listentrywiegands.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryWiegands
- [List all contactSensors of an entry](https://openpath.readme.io/reference/listentrycontactsensors.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryContactSensors
- [List all readers of an entry](https://openpath.readme.io/reference/listentryreaders.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryReaders
- [List all active users that have access to an entry](https://openpath.readme.io/reference/listentryusers.md): __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<br/><br/>__Endpoint name__: listEntryUsers
- [List all active users, with their associated schedule(s), that have access to an entry](https://openpath.readme.io/reference/listentryuserschedules.md): __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}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryUserSchedules
- [List all relays of an entry](https://openpath.readme.io/reference/listentryrelays.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryRelays
- [List all rexs of an entry](https://openpath.readme.io/reference/listentryrexs.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryRexs
- [List all third party reader - OSDPs of an entry](https://openpath.readme.io/reference/listentrythirdpartyreaders.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryThirdPartyReaders
- [List all controls (readers, rexs, contact sensors, wiegands, relays) of an entry](https://openpath.readme.io/reference/listentrycontrols.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryControls
- [Get an entry's activity](https://openpath.readme.io/reference/getentryactivity.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-entry:w,o{params.orgId}-entry:r,o{params.orgId}-entry{params.entryId}:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getEntryActivity
- [Remove any temporary override state from the entry's schedule](https://openpath.readme.io/reference/revertentrytempstate.md): __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<br/><br/>__Endpoint name__: revertEntryTempState
- [List all entries](https://openpath.readme.io/reference/listentriespost.md): Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-musterReport:w,o{params.orgId}-musterReport:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntriesPost
- [Remotely trigger an entry to identify itself via LED and buzzer of associated readers](https://openpath.readme.io/reference/remoteentryidentify.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: remoteEntryIdentify
- [Add a temporary override state to the entry's schedule](https://openpath.readme.io/reference/setentrytempstate.md): __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<br/><br/>__Endpoint name__: setEntryTempState
- [Remove a third party reader - OSDP from an entry](https://openpath.readme.io/reference/removethirdpartyreaderfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeThirdPartyReaderFromEntry
- [Set a third party reader - OSDP to an entry](https://openpath.readme.io/reference/setthirdpartyreadertoentry.md): __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}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setThirdPartyReaderToEntry
- [Remove a rex from an entry](https://openpath.readme.io/reference/removerexfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeRexFromEntry
- [Set a rex to an entry](https://openpath.readme.io/reference/setrextoentry.md): __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{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: setRexToEntry
- [Remove a relay from an entry](https://openpath.readme.io/reference/removerelayfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeRelayFromEntry
- [Set a relay to an entry](https://openpath.readme.io/reference/setrelaytoentry.md): __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}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setRelayToEntry
- [Remove a reader from an entry](https://openpath.readme.io/reference/removereaderfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeReaderFromEntry
- [Set a reader to an entry](https://openpath.readme.io/reference/setreadertoentry.md): __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}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setReaderToEntry
- [Remove a contactSensor from an entry](https://openpath.readme.io/reference/removecontactsensorfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeContactSensorFromEntry
- [Set a contactSensor to an entry](https://openpath.readme.io/reference/setcontactsensortoentry.md): __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{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: setContactSensorToEntry
- [Remove a wiegand from an entry](https://openpath.readme.io/reference/removewiegandfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeWiegandFromEntry
- [Set a wiegand to an entry](https://openpath.readme.io/reference/setwiegandtoentry.md): __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}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setWiegandToEntry
- [Remove a third party reader - wiegand from an entry](https://openpath.readme.io/reference/removethirdpartywiegandfromentry.md): __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}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeThirdPartyWiegandFromEntry
- [Set a third party reader - wiegand to an entry](https://openpath.readme.io/reference/setthirdpartywiegandtoentry.md): __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}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: setThirdPartyWiegandToEntry
- [List all entry states](https://openpath.readme.io/reference/listentrystates.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,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}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntryStates
- [Create a custom entry state](https://openpath.readme.io/reference/createentrystate.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-entryState:w,o:w,s-o:w<br/><br/>__Endpoint name__: createEntryState
- [Describe an entry state](https://openpath.readme.io/reference/describeentrystate.md): __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}-entryState:w,o{params.orgId}-entryState:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeEntryState
- [Update a custom entry state](https://openpath.readme.io/reference/updateentrystate.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-entryState:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateEntryState
- [Delete a custom entry state](https://openpath.readme.io/reference/deleteentrystate.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-entryState:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteEntryState
- [Set a custom entry state's entire list of trigger methods](https://openpath.readme.io/reference/setentrystatetriggermethodids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-entryState:w,o:w,s-o:w<br/><br/>__Endpoint name__: setEntryStateTriggerMethodIds
- [List all access groups](https://openpath.readme.io/reference/listgroups.md): listGroups takes the following options:<br/><br/>withSites - to include the group's sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>__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}-user:w,o{params.orgId}-user:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroups
- [Create an access group](https://openpath.readme.io/reference/creategroup.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createGroup
- [Describe an access group](https://openpath.readme.io/reference/describegroup.md): describeGroup takes the following options:<br/><br/>withSites - to include the group's sites<br/><br/>__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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeGroup
- [Update an access group](https://openpath.readme.io/reference/updategroup.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateGroup
- [Delete an access group](https://openpath.readme.io/reference/deletegroup.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteGroup
- [List all entries an access group has access to](https://openpath.readme.io/reference/listgroupentries.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupEntries
- [List all zones of an access group](https://openpath.readme.io/reference/listgroupzones.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupZones
- [List all users of an access group](https://openpath.readme.io/reference/listgroupusers.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupUsers
- [List all zones (and their associated configurations) an access group has access to](https://openpath.readme.io/reference/listgroupzonegroups.md): listGroupZoneGroups takes the following options:<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>__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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupZoneGroups
- [Bulk-update an access groups's zones (and their associated configurations)](https://openpath.readme.io/reference/updategroupzonegroups.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateGroupZoneGroups
- [Set an access groups's zones (and their associated configurations) by replacing the entire set with this one](https://openpath.readme.io/reference/setgroupzonegroups.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setGroupZoneGroups
- [Bulk-update an access group's users](https://openpath.readme.io/reference/updategroupuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateGroupUserIds
- [List all access groups](https://openpath.readme.io/reference/listgroupspost.md): listGroups takes the following options:<br/><br/>withSites - to include the group's sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>__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}-user:w,o{params.orgId}-user:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupsPost
- [Set an access group's users by replacing the entire set with this one](https://openpath.readme.io/reference/setgroupuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setGroupUserIds
- [Remove a user from an access group](https://openpath.readme.io/reference/removeuserfromgroup.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeUserFromGroup
- [Add a user to an access group](https://openpath.readme.io/reference/setusertogroup.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setUserToGroup
- [Set an access group's zones by replacing the entire set with this one](https://openpath.readme.io/reference/setgroupzoneids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setGroupZoneIds
- [List all user IDs of a group](https://openpath.readme.io/reference/listgroupuserids.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroupUserIds
- [Bulk-update a group's sites](https://openpath.readme.io/reference/updategroupsiteids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateGroupSiteIds
- [Set a group's sites by replacing the entire set with this one](https://openpath.readme.io/reference/setgroupsiteids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setGroupSiteIds
- [List all identity provider types](https://openpath.readme.io/reference/listidentityprovidertypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listIdentityProviderTypes
- [Describe a identity provider type](https://openpath.readme.io/reference/describeidentityprovidertype.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeIdentityProviderType
- [List all identity providers](https://openpath.readme.io/reference/listidentityproviders.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listIdentityProviders
- [Describe an identity provider](https://openpath.readme.io/reference/describeidentityprovider.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeIdentityProvider
- [List an identity provider's groups](https://openpath.readme.io/reference/listidentityprovidergroups.md): __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}-integrations:w,o{params.orgId}-integrations:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listIdentityProviderGroups
- [Describe an identity provider's group relations](https://openpath.readme.io/reference/getidentityprovidergrouprelations.md): __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}-integrations:w,o{params.orgId}-integrations:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getIdentityProviderGroupRelations
- [Set an identity provider's group relations](https://openpath.readme.io/reference/setidentityprovidergrouprelations.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: setIdentityProviderGroupRelations
- [Sync users](https://openpath.readme.io/reference/syncusersidentityprovider.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncUsersIdentityProvider
- [Generate OAuth2 authorize URL](https://openpath.readme.io/reference/getidentityproviderauthurl.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-integrations:w<br/><br/>__Endpoint name__: getIdentityProviderAuthUrl
- [Remove a group relation from an identity provider](https://openpath.readme.io/reference/deleteidentityprovidergrouprelation.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-user:w,o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteIdentityProviderGroupRelation
- [Add a group relation to an identity provider](https://openpath.readme.io/reference/setidentityprovidergrouprelation.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-user:w,o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: setIdentityProviderGroupRelation
- [Inactivate an identity provider and all associated identities and users](https://openpath.readme.io/reference/inactivateidentityprovider.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: inactivateIdentityProvider
- [List all org pictures](https://openpath.readme.io/reference/listorgpictures.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgPictures
- [Create an org picture](https://openpath.readme.io/reference/createorgpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: createOrgPicture
- [Describe an org picture](https://openpath.readme.io/reference/describeorgpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: describeOrgPicture
- [Update an org picture](https://openpath.readme.io/reference/updateorgpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateOrgPicture
- [Delete an org picture](https://openpath.readme.io/reference/deleteorgpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteOrgPicture
- [List all palettes](https://openpath.readme.io/reference/listpalettes.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listPalettes
- [Describe a palette](https://openpath.readme.io/reference/describepalette.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describePalette
- [List all owned or assigned readers](https://openpath.readme.io/reference/listreaders.md): Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only readers with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listReaders
- [Create a reader](https://openpath.readme.io/reference/createreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: createReader
- [Describe an owned or assigned reader](https://openpath.readme.io/reference/describereader.md): Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only readers with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash: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<br/><br/>__Endpoint name__: describeReader
- [Update a reader](https://openpath.readme.io/reference/updatereader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: updateReader
- [Delete a reader](https://openpath.readme.io/reference/deletereader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteReader
- [Remotely trigger a reader to restart](https://openpath.readme.io/reference/remotereaderrestart.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: remoteReaderRestart
- [Remotely trigger a reader to identify itself via LED and buzzer](https://openpath.readme.io/reference/remotereaderidentify.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: remoteReaderIdentify
- [List all relay hardware types](https://openpath.readme.io/reference/listrelayhardwaretypes.md): __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}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listRelayHardwareTypes
- [Describe a relay hardware type](https://openpath.readme.io/reference/describerelayhardwaretype.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeRelayHardwareType
- [List all relays](https://openpath.readme.io/reference/listrelays.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listRelays
- [Describe a relay](https://openpath.readme.io/reference/describerelay.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeRelay
- [Update a relay](https://openpath.readme.io/reference/updaterelay.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateRelay
- [Get the search and display unix timestamp ranges for relative times based on the device with a timezone in the min utc offset](https://openpath.readme.io/reference/getdevicetimezonedependentrelativetimeranges.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-occupancyReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getDeviceTimeZoneDependentRelativeTimeRanges
- [Get entry access activity](https://openpath.readme.io/reference/getactivity.md): Note: Please use `/org/{orgId}/reports/activity/events` API when possible as it replaces this API and is faster.<br/><br/>Returns activity events for the `time` specified date range. This API does not handle large date range requests. If not specified, the default search time span is 24 hours ago to now.<br/><br/>This API can return 422 Unprocessable Entity status code. A 422 is returned when the `time` filter specified a date range with more data than can be retrieved within the 55 second API timeout period. Please try narrowing the query date range or use the `/org/{orgId}/reports/activity/events` API as an alternative. The `/org/{orgId}/reports/activity/events` API does not have the 422 status code problem.<br/><br/>The difference between entryName, zoneName, and siteName vs. entryName2, zoneName2, and siteName2 is that the `*Name2` fields can potentially return "Multiple" as the name. This occurs when the entries array indicates multiple unique ids for that resource type. Whereas the entryId, entryName, zoneId, zoneName, siteId, and siteName values always equal their entries[0] (the first one) equivalent values.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getActivity
- [Search/filter/return audit logs for UI](https://openpath.readme.io/reference/getauditlogsui.md): Returns audit log UI events for the `timestamp` specified date range. Default search time span is 1 hour ago to now.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-portalAudit:w,o{params.orgId}-portalAudit:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getAuditLogsUi
- [Get presence bucket reports](https://openpath.readme.io/reference/getpresencebucketsreport.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-presence:w,o{params.orgId}-presence:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getPresenceBucketsReport
- [Get access activity events](https://openpath.readme.io/reference/getactivityevents-1.md): Returns activity events for the `uiData.time` specified date range. This API can handle large date range requests. If not specified, the default search time span is 24 hours ago to now.<br/><br/>To filter by time, use a `filter` value of `uiData.time:(utcEpochSeconds-<utcEpochSeconds)` or any other valid time range specification, where utcEpochSeconds is replaced by your desired start and end times in unix epoch seconds. To filter by an array field like userGroups, use a `filter` value of `uiData.userGroups.id:(4822,5729)`. This will filter the results to only those that have a `uiData.userGroups.id` value of 4822 or 5729. New partial results are returned for each API call. The query is complete when the API returns `false` for `cursors.hasNextPage`. The caller is required to pass the same filter parameter across all calls of the same query.<br/><br/>Commonly, the `limit` parameter provides an upper bound on the number of results returned by the API. That is not the case here. For performance reasons, this API endpoint treats the `limit` parameter as a suggestion. This endpoint commonly returns substantially more results than the specified `limit` value. If your client is concerned about a large number of events in the response, the client can first issue a request for 1 hour of data. The 1 hour response size can then be used to calculate the time based paging necessary to maintain a rough amount of response data.<br/><br/>The `uiDataOnly` option will cause only uiData elements to be returned, filtering out the hookEvents sub-object from the response. This can reduce client JSON processing time and memory utilization if uiData is only needed.<br/><br/>The difference between entryName, zoneName, and siteName vs. entryName2, zoneName2, and siteName2 is that the `*Name2` fields can potentially return "Multiple" as the name. This occurs when the entries array indicates multiple unique ids for that resource type. Whereas the entryId, entryName, zoneId, zoneName, siteId, and siteName values will always equal their entries[0] (the first one) equivalent values.<br/><br/>For traceability purposes, it is helpful if your API always provides the `option` parameter value of `searchId:{shortPurpose}-{orgId}-{startTimeMillisecs}-{callNum}`. Where `{shortPurpose}` might be `logGather` or whatever unique purpose you have in calling the API; `{orgId}` is your orgId; `{startTimeMillisecs}` is the time in milliseconds for the first call and remains unchanged for all `{callNum}` calls; `{callNum}` starts at 0 and increments for each API call when paging through each returned cursor until complete. An example the first call to this API might have a `searchId:logGather-12345-1675964642144-0` for the logGather purpose, 12345 orgId, with the first API call at 2023-02-09T17:44:02.144, and a 0 callNum for the 1st API call. The second API call with the cursor set would be `searchId:logGather-12345-1675964642144-1`, the 3rd call `...642144-2` and so on. Providing your searchId to an Openpath representative can significantly aid in resolving inqueries.<br/><br/>Please use this API over the slower `/orgs/{orgId}/reports/activity` API when possible.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: 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}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getActivityEvents
- [Get alarm events](https://openpath.readme.io/reference/getalarmevents.md): Returns alarm events for the `uiData.time` specified date range. This API can handle large date range requests. If not specified, the default search time span is 24 hours ago to now.<br/><br/>To filter by time, use a `filter` value of `uiData.time:(utcEpochSeconds-<utcEpochSeconds)` or any other valid time range specification, where utcEpochSeconds is replaced by your desired start and end times in unix epoch seconds. New partial results are returned for each API call. The query is complete when the API returns `false` for `cursors.hasNextPage`. The caller is required to pass the same filter parameter across all calls of the same query.<br/><br/>Commonly, the `limit` parameter provides an upper bound on the number of results returned by the API. That is not the case here. For performance reasons, this API endpoint treats the `limit` parameter as a suggestion. This endpoint commonly returns substantially more results than the specified `limit` value.<br/><br/>The `uiDataOnly` option will cause only uiData elements to be returned, filtering out the hookEvents sub-object from the response. This can reduce client JSON processing time and memory utilization if uiData is only needed.<br/><br/>The entryName2 and siteName2 fields can potentially return "Multiple" as the name. This occurs when the entries indicate multiple unique ids for that resource type. Whereas the entryId and siteId values will always equal their first entry or site value.<br/><br/>For traceability purposes, it is helpful if your API always provides the `option` parameter value of `searchId:{shortPurpose}-{orgId}-{startTimeMillisecs}-{callNum}`. Where `{shortPurpose}` might be `logGather` or whatever unique purpose you have in calling the API; `{orgId}` is your orgId; `{startTimeMillisecs}` is the time in milliseconds for the first call and remains unchanged for all `{callNum}` calls; `{callNum}` starts at 0 and increments for each API call when paging through each returned cursor until complete. An example the first call to this API might have a `searchId:logGather-12345-1675964642144-0` for the logGather purpose, 12345 orgId, with the first API call at 2023-02-09T17:44:02.144, and a 0 callNum for the 1st API call. The second API call with the cursor set would be `searchId:logGather-12345-1675964642144-1`, the 3rd call `...642144-2` and so on. Providing your searchId to an Openpath representative can significantly aid in resolving inqueries.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptAlarm:w,o{params.orgId}-rptAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: getAlarmEvents
- [List all REXs](https://openpath.readme.io/reference/listrexs.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listRexs
- [Describe a REX](https://openpath.readme.io/reference/describerex.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeRex
- [Update a REX](https://openpath.readme.io/reference/updaterex.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateRex
- [List all roles](https://openpath.readme.io/reference/listroles.md): __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}-role:w,o{params.orgId}-role:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoles
- [Create a role](https://openpath.readme.io/reference/createrole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: createRole
- [Describe a role](https://openpath.readme.io/reference/describerole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: describeRole
- [Update a role](https://openpath.readme.io/reference/updaterole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: updateRole
- [Delete a role](https://openpath.readme.io/reference/deleterole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: deleteRole
- [List all users of a role](https://openpath.readme.io/reference/listroleusers.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoleUsers
- [List all scope ids of a role](https://openpath.readme.io/reference/listrolescopeids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o-role:r,o-role:w<br/><br/>__Endpoint name__: listRoleScopeIds
- [Set a role's scopes by replacing the entire set with this one](https://openpath.readme.io/reference/setrolescopeids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w<br/><br/>__Endpoint name__: setRoleScopeIds
- [Bulk-update a role's users](https://openpath.readme.io/reference/updateroleuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: updateRoleUserIds
- [Set a role's users by replacing the entire set with this one](https://openpath.readme.io/reference/setroleuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setRoleUserIds
- [Remove a user from a role](https://openpath.readme.io/reference/removeuserfromrole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: removeUserFromRole
- [Add a user to a role](https://openpath.readme.io/reference/setusertorole.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setUserToRole
- [Set a role's sites by replacing the entire set with this one](https://openpath.readme.io/reference/setrolesiteids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w,o-role:w<br/><br/>__Endpoint name__: setRoleSiteIds
- [List all schedule types](https://openpath.readme.io/reference/listscheduletypes.md): __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<br/><br/>__Endpoint name__: listScheduleTypes
- [Describe a schedule type](https://openpath.readme.io/reference/describescheduletype.md): __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<br/><br/>__Endpoint name__: describeScheduleType
- [List all schedules](https://openpath.readme.io/reference/listschedules.md): __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}-user:w,o{params.orgId}-user:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSchedules
- [Create a schedule](https://openpath.readme.io/reference/createschedule.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-user:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createSchedule
- [Describe a schedule](https://openpath.readme.io/reference/describeschedule.md): By default this endpoint joins the schedule with the shared zones that use it. These operations can be expensive. This data is not needed for most uses. Use an `options` value of `withoutZoneUsers,withoutZoneGroups` where possible for better performance. The caller can also specify one option without the other option if required. The syntax is as such: `/orgs/{orgId}/schedules/{scheduleId}?options=withoutZoneUsers,withoutZoneGroups`.<br/><br/>__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}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeSchedule
- [Update a schedule](https://openpath.readme.io/reference/updateschedule.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSchedule
- [Delete a schedule](https://openpath.readme.io/reference/deleteschedule.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteSchedule
- [Determine whether the API caller has access to modify this schedule via their admin permissions](https://openpath.readme.io/reference/determinescheduleaccess.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: determineScheduleAccess
- [List all schedule events](https://openpath.readme.io/reference/listevents.md): __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}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEvents
- [Create a schedule event](https://openpath.readme.io/reference/createevent.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createEvent
- [Bulk update schedule events](https://openpath.readme.io/reference/updateevents.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateEvents
- [Describe a schedule event](https://openpath.readme.io/reference/describeevent.md): __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}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeEvent
- [Update a schedule event](https://openpath.readme.io/reference/updateevent.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateEvent
- [Delete a schedule event](https://openpath.readme.io/reference/deleteevent.md): __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}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteEvent
- [List all scope resources](https://openpath.readme.io/reference/listscoperesources.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listScopeResources
- [Describe a scope resource](https://openpath.readme.io/reference/describescoperesource.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeScopeResource
- [List all sites](https://openpath.readme.io/reference/listsites.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt: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}-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}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:w,s-o:r,o{params.orgId}-sos:w,o{params.orgId}-videoAdmin:w<br/><br/>__Endpoint name__: listSites
- [Create a site](https://openpath.readme.io/reference/createsite.md): __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{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-sos:w,o:w,s-o:w<br/><br/>__Endpoint name__: createSite
- [Describe a site](https://openpath.readme.io/reference/describesite.md): __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}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-sos:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeSite
- [Update a site](https://openpath.readme.io/reference/updatesite.md): __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{params.orgId}-sos:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSite
- [Delete a site](https://openpath.readme.io/reference/deletesite.md): __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}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w,o{params.orgId}-sos:w<br/><br/>__Endpoint name__: deleteSite
- [List all users of a site](https://openpath.readme.io/reference/listsiteusers.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSiteUsers
- [List location measurements for a site](https://openpath.readme.io/reference/listsitelocationmeasurements.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSiteLocationMeasurements
- [Get location restriction for a site](https://openpath.readme.io/reference/getsitelocationrestriction.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getSiteLocationRestriction
- [Delete location restriction for a site](https://openpath.readme.io/reference/deletesitelocationrestriction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteSiteLocationRestriction
- [Set location restriction for a site](https://openpath.readme.io/reference/setsitelocationrestriction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w<br/><br/>__Endpoint name__: setSiteLocationRestriction
- [Describe a location measurement for a site](https://openpath.readme.io/reference/describesitelocationmeasurement.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeSiteLocationMeasurement
- [Delete a location measurement for a site](https://openpath.readme.io/reference/deletesitelocationmeasurement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteSiteLocationMeasurement
- [Bulk-update a site's users](https://openpath.readme.io/reference/updatesiteuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSiteUserIds
- [Set a site's users by replacing the entire set with this one](https://openpath.readme.io/reference/setsiteuserids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setSiteUserIds
- [Remove a user from a site](https://openpath.readme.io/reference/removeuserfromsite.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeUserFromSite
- [Add a user to a site](https://openpath.readme.io/reference/setusertosite.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setUserToSite
- [Set a location measurement for a site](https://openpath.readme.io/reference/setsitelocationmeasurement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o:w,s-o:w<br/><br/>__Endpoint name__: setSiteLocationMeasurement
- [List all groups of a site](https://openpath.readme.io/reference/listsitegroups.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSiteGroups
- [Remove a group from a site](https://openpath.readme.io/reference/removegroupfromsite.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: removeGroupFromSite
- [Add a group to a site](https://openpath.readme.io/reference/setgrouptosite.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setGroupToSite
- [Bulk-update a site's groups](https://openpath.readme.io/reference/updatesitegroupids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSiteGroupIds
- [Set a site's groups by replacing the entire set with this one](https://openpath.readme.io/reference/setsitegroupids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setSiteGroupIds
- [List all REST Hook subscriptions](https://openpath.readme.io/reference/listsubscriptions.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSubscriptions
- [Create a REST Hook subscription](https://openpath.readme.io/reference/createsubscription.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: createSubscription
- [Describe a REST Hook subscription](https://openpath.readme.io/reference/describesubscription.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeSubscription
- [Update a REST Hook subscription](https://openpath.readme.io/reference/updatesubscription.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSubscription
- [Delete a REST Hook subscription](https://openpath.readme.io/reference/deletesubscription.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteSubscription
- [List all trigger methods](https://openpath.readme.io/reference/listtriggermethods.md): __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}-entryState:w,o{params.orgId}-entryState:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTriggerMethods
- [Describe a trigger method](https://openpath.readme.io/reference/describetriggermethod.md): __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}-entryState:w,o{params.orgId}-entryState:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeTriggerMethod
- [orgs/users](https://openpath.readme.io/reference/orgsusers.md)
- [List all users](https://openpath.readme.io/reference/listusers.md): listUsers takes the following options:<br/><br/>withPicture - to include the full size and thumbnail user picture urls<br/><br/>withUserSites - to include the user's sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>withBuildings - includes nested building/floor/units attached to the user<br/><br/>isAttachedToAtLeastOneIntercom - filters to just users attached to an intercom<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-user:w,o{params.orgId}-user: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}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-configurations:r,o{params.orgId}-configurations:w,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w,o-role:r,o-role:w<br/><br/>__Endpoint name__: listUsers
- [Create a user](https://openpath.readme.io/reference/createuser.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: createUser
- [Describe a user](https://openpath.readme.io/reference/describeuser.md): describeUser takes the following options:<br/><br/>withPicture - to include the full size and thumbnail user picture urls<br/><br/>withUserSites - to include the user's sites<br/><br/>withRoles - to include the user's roles<br/><br/>__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}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: describeUser
- [Update a user](https://openpath.readme.io/reference/updateuser.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateUser
- [Describe user badge](https://openpath.readme.io/reference/describeuserbadge.md): __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}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o{params.orgId}-user{params.userId}:orgUserBadge-describeUserBadge:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeUserBadge
- [List all zones a user has access to](https://openpath.readme.io/reference/listuserzones.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserZones
- [List all ACUs a user has access to](https://openpath.readme.io/reference/listuseracus.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserAcus
- [List all sites of a user](https://openpath.readme.io/reference/listusersites.md): __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}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserSites
- [List all roles of a user](https://openpath.readme.io/reference/listuserroles.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserRoles
- [Get a user's preference set](https://openpath.readme.io/reference/describeuserpreferenceset.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o:w,o:r<br/><br/>__Endpoint name__: describeUserPreferenceSet
- [Update a user's preference set](https://openpath.readme.io/reference/updateuserpreferenceset.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o:w<br/><br/>__Endpoint name__: updateUserPreferenceSet
- [List all MFA credentials (for users in the local org namespace only)](https://openpath.readme.io/reference/listusermfacredentials.md): __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:w,o:r,s-o:w,s-o:r,o-user:w,o-user:r<br/><br/>__Endpoint name__: listUserMfaCredentials
- [List all user pictures](https://openpath.readme.io/reference/listuserpictures.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listUserPictures
- [Create a user picture](https://openpath.readme.io/reference/createuserpicture.md): This endpoint is deprecated. Use setUserAvatarPicture instead.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createUserPicture
- [List all groups of a user](https://openpath.readme.io/reference/listusergroups.md): __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}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserGroups
- [List all entries a user has access to](https://openpath.readme.io/reference/listuserentries.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserEntries
- [List all zones (and their associated configurations) a user has access to](https://openpath.readme.io/reference/listuserzoneusers.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: listUserZoneUsers
- [Bulk-update a user's zones and their associated configurations](https://openpath.readme.io/reference/updateuserzoneusers.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateUserZoneUsers
- [Set a user's zones (and their associated configurations) by replacing the entire set with this one](https://openpath.readme.io/reference/setuserzoneusers.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setUserZoneUsers
- [List all user credentials](https://openpath.readme.io/reference/listcredentials.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-user{params.userId}:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-portalAudit:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o:w,o:r,s-o:w,s-o:r,o{params.orgId}-user{params.userId}:orgUser-listCredentials:r<br/><br/>__Endpoint name__: listCredentials
- [Create a user credential](https://openpath.readme.io/reference/createcredential.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createCredential
- [List all user custom fields](https://openpath.readme.io/reference/listusercustomfields.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listUserCustomFields
- [Update all user custom fields](https://openpath.readme.io/reference/updateusercustomfields.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateUserCustomFields
- [Get a user's intercom notification preferences](https://openpath.readme.io/reference/describeuserintercomnotificationpreferenceset.md): __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}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: describeUserIntercomNotificationPreferenceSet
- [Update a user's intercom notification preferences](https://openpath.readme.io/reference/updateuserintercomnotificationpreferenceset.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateUserIntercomNotificationPreferenceSet
- [Describe a user custom field](https://openpath.readme.io/reference/describeusercustomfield.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeUserCustomField
- [Update a user custom field](https://openpath.readme.io/reference/updateusercustomfield.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateUserCustomField
- [Describe a user credential](https://openpath.readme.io/reference/describecredential.md): __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}-user{params.userId}:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCredential
- [Update a user credential](https://openpath.readme.io/reference/updatecredential.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateCredential
- [Delete a user credential](https://openpath.readme.io/reference/deletecredential.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteCredential
- [Get a user's entry activity](https://openpath.readme.io/reference/getuseractivity.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-user{params.userId}:r,o{params.orgId}-user{params.userId}:orgUser-getUserActivity:r,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w<br/><br/>__Endpoint name__: getUserActivity
- [Describe a user picture](https://openpath.readme.io/reference/describeuserpicture.md): This endpoint is deprecated. Use getUserAvatarPicture instead.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: describeUserPicture
- [Update a user picture](https://openpath.readme.io/reference/updateuserpicture.md): This endpoint is deprecated. Use setUserAvatarPicture instead.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateUserPicture
- [Delete a user picture](https://openpath.readme.io/reference/deleteuserpicture.md): This endpoint is deprecated. Use deleteUserAvatarPicture instead.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteUserPicture
- [List all no tour credential sector validation data for this user](https://openpath.readme.io/reference/listorgnotourcredentialsectorsvalidationdata.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgNoTourCredentialSectorsValidationData
- [Send email to user to verify email](https://openpath.readme.io/reference/verifyemail.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: verifyEmail
- [List all users](https://openpath.readme.io/reference/listuserspost.md): listUsers takes the following options:<br/><br/>withPicture - to include the full size and thumbnail user picture urls<br/><br/>withUserSites - to include the user's sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>withBuildings - includes nested building/floor/units attached to the user<br/><br/>isAttachedToAtLeastOneIntercom - filters to just users attached to an intercom<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-user:w,o{params.orgId}-user: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}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-configurations:r,o{params.orgId}-configurations:w,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:w,s-o:r,o-user:r,o-user:w,o-role:r,o-role:w<br/><br/>__Endpoint name__: listUsersPost
- [Receives feedback from the user and store it](https://openpath.readme.io/reference/submitcobaltuserfeedback.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-user{params.userId}:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: submitCobaltUserFeedback
- [Use a cloudKey credential to request triggering a lockdown plan](https://openpath.readme.io/reference/cloudkeytriggerlockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w<br/><br/>__Endpoint name__: cloudKeyTriggerLockdownPlan
- [Use a cloudKey credential to request a cloud-unlock of an entry](https://openpath.readme.io/reference/cloudkeyentryunlock.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: cloudKeyEntryUnlock
- [Generate new setup mobile token for credential](https://openpath.readme.io/reference/generatesetupmobiletoken.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: generateSetupMobileToken
- [Send email to user to set up their mobile credential](https://openpath.readme.io/reference/setupmobilecredential.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o-support:w,o:w,s-o:w<br/><br/>__Endpoint name__: setupMobileCredential
- [Generate new cloudKey unlock token for a specific entry.](https://openpath.readme.io/reference/generatecloudkeyunlocktoken.md): The response includes key fields with the following meanings:<br/><br/>**cloudKeyUnlockToken**: returns the unlock token authorized to unlock the specified entries.<br/><br/>**apiUrl**: returns the URL that, if POST-ed to, will immediately unlock the specified entries. E.g. curl -XPOST https://api.openpath.com/tokens/...<redacted-token>.../use immediately unlocks the specified entries.<br/><br/>**fullWebUrl**: returns the URL that if launched in a web browser will display a "Tap to Unlock an Entry:" set of buttons for each entry specified. E.g. browser browse to https://control.openpath.com/cloudKeyUnlock?token=...<redacted-token>...<br/><br/>**webUrl**: same functionality as fullWebUrl but uses a shortCode as the authorizing credential. This can be better for manual typing or other use-cases where a shorter URL provides value. E.g. browser browse to https://control.openpath.com/cloudKeyUnlock?shortCode=...<redacted-short-code>...<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: generateCloudKeyUnlockToken
- [Generate new cloudKey token for a specific action on a specific lockdown plan](https://openpath.readme.io/reference/generatecloudkeylockdownplanactiontoken.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: generateCloudKeyLockdownPlanActionToken
- [Use a cloudKey credential to request reverting a lockdown plan](https://openpath.readme.io/reference/cloudkeyrevertlockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w<br/><br/>__Endpoint name__: cloudKeyRevertLockdownPlan
- [Generate new cloudKey unlock token for a specific entry](https://openpath.readme.io/reference/generatecloudkeyunlocktokenbymodelid.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user{params.userId}:orgUser-generateUnlockToken:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: generateCloudKeyUnlockTokenByModelId
- [Bulk-update a user's groups](https://openpath.readme.io/reference/updateusergroupids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateUserGroupIds
- [Set a user's groups by replacing the entire set with this one](https://openpath.readme.io/reference/setusergroupids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setUserGroupIds
- [Bulk-update a user's sites](https://openpath.readme.io/reference/updateusersiteids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: updateUserSiteIds
- [Set a user's sites by replacing the entire set with this one](https://openpath.readme.io/reference/setusersiteids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setUserSiteIds
- [Set a user's status](https://openpath.readme.io/reference/setuserstatus.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setUserStatus
- [Set a user's zones by replacing the entire set with this one](https://openpath.readme.io/reference/setuserzoneids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: setUserZoneIds
- [Set a user's roles by replacing the entire set with this one](https://openpath.readme.io/reference/setuserroleids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o:w,s-o:w<br/><br/>__Endpoint name__: setUserRoleIds
- [Delete a user](https://openpath.readme.io/reference/deleteuser.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w,o-user:w<br/><br/>__Endpoint name__: deleteUser
- [Send email to user to set up their wallet credential](https://openpath.readme.io/reference/setupwalletcredential.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o-support:w,o:w,s-o:w<br/><br/>__Endpoint name__: setupWalletCredential
- [Sync Apple Wallet Device](https://openpath.readme.io/reference/syncwalletappledevice.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncWalletAppleDevice
- [Update Apple Wallet Device](https://openpath.readme.io/reference/updatewalletappledevice.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWalletAppleDevice
- [Get the user avatar picture](https://openpath.readme.io/reference/getuseravatarpicture.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-user{params.userId}:w,o{params.orgId}-user{params.userId}:r,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-quickStart:r,o{params.orgId}-quickStart:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: getUserAvatarPicture
- [Delete the user avatar picture](https://openpath.readme.io/reference/deleteuseravatarpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteUserAvatarPicture
- [Set the user avatar picture](https://openpath.readme.io/reference/setuseravatarpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: setUserAvatarPicture
- [List all wiegands](https://openpath.readme.io/reference/listwiegands.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listWiegands
- [Describe a wiegand](https://openpath.readme.io/reference/describewiegand.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeWiegand
- [Update a wiegand](https://openpath.readme.io/reference/updatewiegand.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateWiegand
- [List all owned or shared zones](https://openpath.readme.io/reference/listzones.md): __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,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-rpt:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listZones
- [Create a zone](https://openpath.readme.io/reference/createzone.md): __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<br/><br/>__Endpoint name__: createZone
- [Describe an owned or shared zone](https://openpath.readme.io/reference/describezone.md): __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<br/><br/>__Endpoint name__: describeZone
- [Update a zone](https://openpath.readme.io/reference/updatezone.md): __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<br/><br/>__Endpoint name__: updateZone
- [Delete a zone](https://openpath.readme.io/reference/deletezone.md): __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<br/><br/>__Endpoint name__: deleteZone
- [List all zone anti-passback areas](https://openpath.readme.io/reference/listzoneapbareas.md): __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<br/><br/>__Endpoint name__: listZoneApbAreas
- [Create a zone anti-passback area](https://openpath.readme.io/reference/createzoneapbarea.md): __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<br/><br/>__Endpoint name__: createZoneApbArea
- [List all groups of a zone](https://openpath.readme.io/reference/listzonegroups.md): __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<br/><br/>__Endpoint name__: listZoneGroups
- [List all group IDs of a zone](https://openpath.readme.io/reference/listzonegroupids.md): __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<br/><br/>__Endpoint name__: listZoneGroupIds
- [List all users of a zone](https://openpath.readme.io/reference/listzoneusers.md): __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<br/><br/>__Endpoint name__: listZoneUsers
- [List all shares of this zone](https://openpath.readme.io/reference/listzoneshares.md): __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<br/><br/>__Endpoint name__: listZoneShares
- [List all users (and their associated configurations) of a zone](https://openpath.readme.io/reference/listzonezoneusers.md): __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<br/><br/>__Endpoint name__: listZoneZoneUsers
- [Bulk-update a zone's users (and their associated configurations)](https://openpath.readme.io/reference/updatezonezoneusers.md): __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<br/><br/>__Endpoint name__: updateZoneZoneUsers
- [Set a zone's users (and their associated configurations) by replacing the entire set with this one](https://openpath.readme.io/reference/setzonezoneusers.md): __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<br/><br/>__Endpoint name__: setZoneZoneUsers
- [List all groups (and their associated configurations) of a zone](https://openpath.readme.io/reference/listzonezonegroups.md): __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<br/><br/>__Endpoint name__: listZoneZoneGroups
- [Bulk-update a zone's groups (and their associated configurations)](https://openpath.readme.io/reference/updatezonezonegroups.md): __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<br/><br/>__Endpoint name__: updateZoneZoneGroups
- [Set a zone's groups (and their associated configurations) by replacing the entire set with this one](https://openpath.readme.io/reference/setzonezonegroups.md): __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<br/><br/>__Endpoint name__: setZoneZoneGroups
- [Describe a zone anti-passback area](https://openpath.readme.io/reference/describezoneapbarea.md): __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<br/><br/>__Endpoint name__: describeZoneApbArea
- [Update a zone anti-passback area](https://openpath.readme.io/reference/updatezoneapbarea.md): __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<br/><br/>__Endpoint name__: updateZoneApbArea
- [Delete a zone anti-passback area](https://openpath.readme.io/reference/deletezoneapbarea.md): __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<br/><br/>__Endpoint name__: deleteZoneApbArea
- [Reset anti-passback for a zone and/or user](https://openpath.readme.io/reference/resetapb.md): __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<br/><br/>__Endpoint name__: resetApb
- [Relinquish shared zone from shared-to org](https://openpath.readme.io/reference/relinquishzoneshare.md): __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<br/><br/>__Endpoint name__: relinquishZoneShare
- [Share zone](https://openpath.readme.io/reference/sharezone.md): __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<br/><br/>__Endpoint name__: shareZone
- [Unshare zone](https://openpath.readme.io/reference/unsharezone.md): __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<br/><br/>__Endpoint name__: unshareZone
- [Remove a group from a zone](https://openpath.readme.io/reference/removegroupfromzone.md): __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<br/><br/>__Endpoint name__: removeGroupFromZone
- [Add a group to a zone](https://openpath.readme.io/reference/setgrouptozone.md): __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<br/><br/>__Endpoint name__: setGroupToZone
- [Remove a user from a zone](https://openpath.readme.io/reference/removeuserfromzone.md): __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<br/><br/>__Endpoint name__: removeUserFromZone
- [Add a user to a zone](https://openpath.readme.io/reference/setusertozone.md): __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<br/><br/>__Endpoint name__: setUserToZone
- [Set a zone's groups by replacing the entire set with this one](https://openpath.readme.io/reference/setzonegroupids.md): __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<br/><br/>__Endpoint name__: setZoneGroupIds
- [Set a zone's users by replacing the entire set with this one](https://openpath.readme.io/reference/setzoneuserids.md): __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<br/><br/>__Endpoint name__: setZoneUserIds
- [Set this zone's shares by replacing the entire set with this one](https://openpath.readme.io/reference/setzoneshareorgids.md): __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<br/><br/>__Endpoint name__: setZoneShareOrgIds
- [Use a cloudKey token to remotely trigger or revert a lockdown plan](https://openpath.readme.io/reference/usecloudkeylockdownplanactiontoken.md): __Endpoint name__: useCloudKeyLockdownPlanActionToken
- [Use a cloudKey token to remotely unlock an entry](https://openpath.readme.io/reference/usecloudkeyunlocktoken.md): __Endpoint name__: useCloudKeyUnlockToken
- [List all billable features](https://openpath.readme.io/reference/globallistbillablefeatures.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: globalListBillableFeatures
- [List all wireless lock gateways](https://openpath.readme.io/reference/listwirelesslockgateways.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o{params.orgId}-hw:r,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:r,o{params.orgId}-dashCust:w,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockGateways
- [Create a wirelessLock gateway](https://openpath.readme.io/reference/createwirelesslockgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessLockGateway
- [Describe a wireless lock gateway](https://openpath.readme.io/reference/describewirelesslockgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o:r,s-o:r<br/><br/>__Endpoint name__: describeWirelessLockGateway
- [Update a wirelessLock gateway](https://openpath.readme.io/reference/updatewirelesslockgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockGateway
- [Remove a wireless lock gateway](https://openpath.readme.io/reference/deletewirelesslockgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessLockGateway
- [Update the firmware for multiple wireless lock gateways to the latest version](https://openpath.readme.io/reference/updatewirelesslockgatewayfirmwarebatch.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockGatewayFirmwareBatch
- [Sync devices for a wireless lock gateway](https://openpath.readme.io/reference/syncwirelesslockgatewaydevices.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncWirelessLockGatewayDevices
- [Update the firmware for a wireless lock gateway to a specific version](https://openpath.readme.io/reference/updatewirelesslockgatewayfirmware.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockGatewayFirmware
- [List all wireless locks](https://openpath.readme.io/reference/listwirelesslocks.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLocks
- [Create a wireless lock](https://openpath.readme.io/reference/createwirelesslock.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessLock
- [Describe a wireless lock](https://openpath.readme.io/reference/describewirelesslock.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeWirelessLock
- [Update a wireless lock](https://openpath.readme.io/reference/updatewirelesslock.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLock
- [Remove a wireless lock](https://openpath.readme.io/reference/deletewirelesslock.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessLock
- [Update the firmware for multiple wireless locks to the latest version](https://openpath.readme.io/reference/updatewirelesslockfirmwarebatch.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockFirmwareBatch
- [Update the firmware for a wireless lock to a specific version](https://openpath.readme.io/reference/updatewirelesslockfirmware.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockFirmware
- [Blink the reader or inside-push-button LED for a wireless lock to identify it.](https://openpath.readme.io/reference/blinkwirelesslockled.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: blinkWirelessLockLed
- [List all video provider types](https://openpath.readme.io/reference/listvideoprovidertypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listVideoProviderTypes
- [List all unused inputs](https://openpath.readme.io/reference/listunusedinputs.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listUnusedInputs
- [Describe an unused input](https://openpath.readme.io/reference/describeunusedinput.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeUnusedInput
- [Update an unused input](https://openpath.readme.io/reference/updateunusedinput.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateUnusedInput
- [List all recent alarms](https://openpath.readme.io/reference/listrecentalarms.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r<br/><br/>__Endpoint name__: listRecentAlarms
- [List all available package plans](https://openpath.readme.io/reference/listorgpackageplans.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgPackagePlans
- [Describe a package plan](https://openpath.readme.io/reference/describeorgpackageplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeOrgPackagePlan
- [List all maintenance windows maps](https://openpath.readme.io/reference/listorgmaintenancewindowmap.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: listOrgMaintenanceWindowMap
- [Create/Update/Delete maintenance window maps for an organization](https://openpath.readme.io/reference/updateorgmaintenancewindowmap.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: updateOrgMaintenanceWindowMap
- [Describe a maintenance window](https://openpath.readme.io/reference/describeorgmaintenancewindowmap.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: describeOrgMaintenanceWindowMap
- [List all maintenance windows](https://openpath.readme.io/reference/listorgmaintenancewindowdefinition.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: listOrgMaintenanceWindowDefinition
- [Create a maintenance window for an organization](https://openpath.readme.io/reference/createorgmaintenancewindowdefinition.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: createOrgMaintenanceWindowDefinition
- [Describe a maintenance window](https://openpath.readme.io/reference/describeorgmaintenancewindowdefinition.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: describeOrgMaintenanceWindowDefinition
- [Delete an organization's maintenance window](https://openpath.readme.io/reference/deleteorgmaintenancewindowdefinition.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: deleteOrgMaintenanceWindowDefinition
- [Get an organization's enabled features](https://openpath.readme.io/reference/listorgfeatures.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-map:r,o{params.orgId}-map:w,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-portalAudit:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-erpParentStore:w,o{params.orgId}-erpParentCenter:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-opvideoDevice:r,o{params.orgId}-opvideoDevice:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r,o{params.orgId}-sos:w,o{params.orgId}-videoAdmin:w<br/><br/>__Endpoint name__: listOrgFeatures
- [List all EOL supervisions](https://openpath.readme.io/reference/listeolsupervisions.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEolSupervisions
- [Describe an EOL supervision](https://openpath.readme.io/reference/describeeolsupervision.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeEolSupervision
- [List all email alert types](https://openpath.readme.io/reference/listemailalerttypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEmailAlertTypes
- [Describe an email alert type](https://openpath.readme.io/reference/describeemailalerttype.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeEmailAlertType
- [List all credential action types](https://openpath.readme.io/reference/listcredentialactiontypes.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCredentialActionTypes
- [Describe a credential action type](https://openpath.readme.io/reference/describecredentialactiontype.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCredentialActionType
- [List all credentials from all users within the org](https://openpath.readme.io/reference/listorgcredentials.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgCredentials
- [List all credential actions](https://openpath.readme.io/reference/listcredentialactions.md): __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:w,o:r,o-support:w,o-support:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCredentialActions
- [Create a credential action](https://openpath.readme.io/reference/createcredentialaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: createCredentialAction
- [Describe a credential action](https://openpath.readme.io/reference/describecredentialaction.md): __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:w,o:r,o-support:w,o-support:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCredentialAction
- [Update a credential action](https://openpath.readme.io/reference/updatecredentialaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: updateCredentialAction
- [Delete a credential action](https://openpath.readme.io/reference/deletecredentialaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: deleteCredentialAction
- [List all entry card formats](https://openpath.readme.io/reference/listcardformats.md): __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}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCardFormats
- [Describe a card format](https://openpath.readme.io/reference/describecardformat.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCardFormat
- [Get list of X.509 authentication certificates](https://openpath.readme.io/reference/listauthcerts.md): Get all X.509 certificates for an org. Check the following link for how to authenticate https://openpath.readme.io/docs/using-the-api#using-signed-jwt-for-authentication<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o{params.orgId}-cert:w,o{params.orgId}-cert:r<br/><br/>__Endpoint name__: listAuthCerts
- [Create an X.509 authentication certificate](https://openpath.readme.io/reference/createauthcert.md): Create an X.509 certificate for an org to be used as a means of authentication against the api. The caller must have a superset of the scopes to be assigned via the roleId. Check the following link for how to authenticate https://openpath.readme.io/docs/using-the-api#using-signed-jwt-for-authentication<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o{params.orgId}-cert:w,o{params.orgId}-cert:r<br/><br/>__Endpoint name__: createAuthCert
- [Get an X.509 authentication certificate](https://openpath.readme.io/reference/describeauthcert.md): Get an X.509 certificate for an org. Check the following link for how to authenticate https://openpath.readme.io/docs/using-the-api#using-signed-jwt-for-authentication<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o{params.orgId}-cert:w,o{params.orgId}-cert:r,o{params.orgId}-cert{params.authCertId}:w,o{params.orgId}-cert{params.authCertId}:r<br/><br/>__Endpoint name__: describeAuthCert
- [Update an X.509 authentication certificate](https://openpath.readme.io/reference/updateauthcert.md): Update an X.509 certificate for an org. If this resource is being updated has the canOnlySelfModify property set, then cert-based JWT authentication is required using a JWT signed using that same cert's private key. Check the following link for how to authenticate https://openpath.readme.io/docs/using-the-api#using-signed-jwt-for-authentication<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o{params.orgId}-cert:w,o{params.orgId}-cert{params.authCertId}:w<br/><br/>__Endpoint name__: updateAuthCert
- [Delete an X.509 authentication certificate](https://openpath.readme.io/reference/deleteauthcert.md): Delete an X.509 certificate for an org. If this resource is being updated has the canOnlySelfModify property set, then cert-based JWT authentication is required using a JWT signed using that same cert's private key. Check the following link for how to authenticate https://openpath.readme.io/docs/using-the-api#using-signed-jwt-for-authentication<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o{params.orgId}-cert:w,o{params.orgId}-cert{params.authCertId}:w<br/><br/>__Endpoint name__: deleteAuthCert
- [List all alarm statuses](https://openpath.readme.io/reference/listalarmstatuses.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: listAlarmStatuses
- [Describe an alarm status](https://openpath.readme.io/reference/describealarmstatus.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: describeAlarmStatus
- [List all alarm severities](https://openpath.readme.io/reference/listalarmseverities.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: listAlarmSeverities
- [Describe an alarm severity](https://openpath.readme.io/reference/describealarmseverity.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: describeAlarmSeverity
- [List all ACU ports](https://openpath.readme.io/reference/listallacuports.md): __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}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAllAcuPorts
- [List all wireless lock readers](https://openpath.readme.io/reference/listwirelesslockreaders.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o{params.orgId}-hw:r,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockReaders
- [Create a wirelessLock reader](https://openpath.readme.io/reference/createwirelesslockreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessLockReader
- [Describe a wireless lock reader](https://openpath.readme.io/reference/describewirelesslockreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o:r,s-o:r<br/><br/>__Endpoint name__: describeWirelessLockReader
- [Update a wirelessLock reader](https://openpath.readme.io/reference/updatewirelesslockreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessLockReader
- [Remove a wireless lock reader](https://openpath.readme.io/reference/deletewirelesslockreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessLockReader
- [List all wireless lock providers](https://openpath.readme.io/reference/listwirelesslockproviders.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviders
- [Create a wireless lock provider](https://openpath.readme.io/reference/createwirelesslockprovider.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessLockProvider
- [Describe a wireless lock provider](https://openpath.readme.io/reference/describewirelesslockprovider.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: describeWirelessLockProvider
- [Remove a wireless lock provider and all related devices](https://openpath.readme.io/reference/deletewirelesslockprovider.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessLockProvider
- [List all operators for a wireless lock provider](https://openpath.readme.io/reference/listwirelesslockprovideroperators.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviderOperators
- [List all firmwares available for a wireless lock provider by device](https://openpath.readme.io/reference/listwirelesslockproviderfirmwares.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviderFirmwares
- [Invite self to be a site operator for a wireless lock provider](https://openpath.readme.io/reference/invitewirelesslockprovideroperator.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: inviteWirelessLockProviderOperator
- [Sync devices for a wireless lock provider](https://openpath.readme.io/reference/syncwirelesslockproviderdevices.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncWirelessLockProviderDevices
- [List all widget types](https://openpath.readme.io/reference/listwidgettypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listWidgetTypes
- [Describe a widget type](https://openpath.readme.io/reference/describewidgettype.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeWidgetType
- [Get mobile app config](https://openpath.readme.io/reference/describemobileappconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-configurations:r,o{params.orgId}-configurations:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeMobileAppConfig
- [Update mobile app config](https://openpath.readme.io/reference/updatemobileappconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateMobileAppConfig
- [Delete mobile app config](https://openpath.readme.io/reference/deletemobileappconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteMobileAppConfig
- [Get email alerts](https://openpath.readme.io/reference/listemailalerts.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEmailAlerts
- [List all hook events](https://openpath.readme.io/reference/listhookevents.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listHookEvents
- [Describe a hook event](https://openpath.readme.io/reference/describehookevent.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeHookEvent
- [List all I/Os](https://openpath.readme.io/reference/listios.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: listIos
- [Describe an I/O](https://openpath.readme.io/reference/describeio.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeIo
- [List all location measurement source types](https://openpath.readme.io/reference/listlocationmeasurementsourcetypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listLocationMeasurementSourceTypes
- [Describe a location measurement source type](https://openpath.readme.io/reference/describelocationmeasurementsourcetype.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeLocationMeasurementSourceType
- [List all lockdown plans](https://openpath.readme.io/reference/listlockdownplans.md): __JWT is required for this endpoint with at least one of the following scopes__: 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}-map:r,o{params.orgId}-map:w,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-entryState:w,o{params.orgId}-entryState:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-alertSettings:w,o{params.orgId}-alertSettings:r,o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-portalAudit:r,o{params.orgId}-portalAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-erpParentCenter:w,o{params.orgId}-erpParentStore:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o{params.orgId}-videoIntercom:r,o{params.orgId}-videoIntercom:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o:w,o:r,s-o:w,s-o:r,o{params.orgId}-sos:w<br/><br/>__Endpoint name__: listLockdownPlans
- [Create a lockdown plan](https://openpath.readme.io/reference/createlockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: createLockdownPlan
- [Describe a lockdown plan](https://openpath.readme.io/reference/describelockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeLockdownPlan
- [Update a lockdown plan](https://openpath.readme.io/reference/updatelockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateLockdownPlan
- [Delete a lockdown plan](https://openpath.readme.io/reference/deletelockdownplan.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteLockdownPlan
- [Set a lockdown plan's zone states](https://openpath.readme.io/reference/setlockdownplanzonestates.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: setLockdownPlanZoneStates
- [Set a lockdown plan's user and group permissions](https://openpath.readme.io/reference/setlockdownplanpermissions.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o:w,s-o:w<br/><br/>__Endpoint name__: setLockdownPlanPermissions
- [Describe an organization's maintenance window](https://openpath.readme.io/reference/describeorgmaintenancewindow.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: describeOrgMaintenanceWindow
- [Update an organization's maintenance window](https://openpath.readme.io/reference/updateorgmaintenancewindow.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: updateOrgMaintenanceWindow
- [Delete an organization's maintenance window](https://openpath.readme.io/reference/deleteorgmaintenancewindow.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: deleteOrgMaintenanceWindow
- [Create or update an organization's maintenance window](https://openpath.readme.io/reference/createorgmaintenancewindow.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: createOrgMaintenanceWindow
- [List all namespaces for the org (including IDP namespaces associated with the org)](https://openpath.readme.io/reference/listnamespaces.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listNamespaces
- [List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)](https://openpath.readme.io/reference/listsharedusers.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSharedUsers
- [Describe a user that has access to at least one zone from this org (including users from other orgs via zone sharing)](https://openpath.readme.io/reference/describeshareduser.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeSharedUser
- [List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)](https://openpath.readme.io/reference/listshareduserspost.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSharedUsersPost
- [List all third party OSDP readers](https://openpath.readme.io/reference/listthirdpartyreaders.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listThirdPartyReaders
- [Describe a third party OSDP reader](https://openpath.readme.io/reference/describethirdpartyreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeThirdPartyReader
- [Update a third party OSDP reader](https://openpath.readme.io/reference/updatethirdpartyreader.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateThirdPartyReader
- [List all third party wiegand readers](https://openpath.readme.io/reference/listthirdpartywiegands.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listThirdPartyWiegands
- [Describe a third party wiegand reader](https://openpath.readme.io/reference/describethirdpartywiegand.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw: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<br/><br/>__Endpoint name__: describeThirdPartyWiegand
- [Update a third party wiegand reader](https://openpath.readme.io/reference/updatethirdpartywiegand.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,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<br/><br/>__Endpoint name__: updateThirdPartyWiegand
- [List all alarm actions](https://openpath.readme.io/reference/listalarmactions.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: listAlarmActions
- [Describe an alarm action](https://openpath.readme.io/reference/describealarmaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: describeAlarmAction
- [List all alarm configurations](https://openpath.readme.io/reference/listalarmconfigurations.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r<br/><br/>__Endpoint name__: listAlarmConfigurations
- [Create an alarm configuration](https://openpath.readme.io/reference/createalarmconfiguration.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmConfigurations:w,o:w<br/><br/>__Endpoint name__: createAlarmConfiguration
- [Describe an alarm configuration](https://openpath.readme.io/reference/describealarmconfiguration.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o:w,o:r<br/><br/>__Endpoint name__: describeAlarmConfiguration
- [Update an alarm configuration](https://openpath.readme.io/reference/updatealarmconfiguration.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmConfigurations:w,o:w<br/><br/>__Endpoint name__: updateAlarmConfiguration
- [List all cameras of an alarm configuration](https://openpath.readme.io/reference/listalarmconfigurationcameras.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o:w,o:r<br/><br/>__Endpoint name__: listAlarmConfigurationCameras
- [Remove a camera from an alarm configuration](https://openpath.readme.io/reference/deletealarmconfigurationcameraid.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmConfigurations:w,o:w<br/><br/>__Endpoint name__: deleteAlarmConfigurationCameraId
- [Add a camera to an alarm configuration](https://openpath.readme.io/reference/addalarmconfigurationcameraid.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmConfigurations:w,o:w<br/><br/>__Endpoint name__: addAlarmConfigurationCameraId
- [Set an alarm configuration's cameras by replacing the entire set with this one](https://openpath.readme.io/reference/setalarmconfigurationcameraids.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmConfigurations:w,o:w<br/><br/>__Endpoint name__: setAlarmConfigurationCameraIds
- [List all badge configs](https://openpath.readme.io/reference/listbadgeconfigs.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listBadgeConfigs
- [Create a new badge config](https://openpath.readme.io/reference/createbadgeconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-badgePrinting:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: createBadgeConfig
- [Describe a badge config](https://openpath.readme.io/reference/describebadgeconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeBadgeConfig
- [Update a badge config](https://openpath.readme.io/reference/updatebadgeconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-badgePrinting:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateBadgeConfig
- [Delete a badge config of an Org](https://openpath.readme.io/reference/deletebadgeconfig.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-badgePrinting:w,o{params.orgId}-mobileAppSettings:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteBadgeConfig
- [List all dashboards](https://openpath.readme.io/reference/listdashboards.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listDashboards
- [Create a new dashboard](https://openpath.readme.io/reference/createdashboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: createDashboard
- [Describe a dashboard](https://openpath.readme.io/reference/describedashboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeDashboard
- [Update an existing dashboard](https://openpath.readme.io/reference/updatedashboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateDashboard
- [Delete a dashboard](https://openpath.readme.io/reference/deletedashboard.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteDashboard
- [List all dashboard widgets](https://openpath.readme.io/reference/listwidgets.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listWidgets
- [Create a new dashboard widget](https://openpath.readme.io/reference/createwidget.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWidget
- [Describe a dashboard widget](https://openpath.readme.io/reference/describewidget.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeWidget
- [Update a dashboard widget](https://openpath.readme.io/reference/updatewidget.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWidget
- [Delete a dashboard widget](https://openpath.readme.io/reference/deletewidget.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWidget
- [List all allegion fob credentials within the org](https://openpath.readme.io/reference/listorgfoballegions.md): __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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgFobAllegions
- [Create an allegion fob credential](https://openpath.readme.io/reference/createorgfoballegion.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createOrgFobAllegion
- [Describe an allegion fob credential](https://openpath.readme.io/reference/describeorgfoballegion.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeOrgFobAllegion
- [Update an allegion fob credential](https://openpath.readme.io/reference/updateorgfoballegion.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateOrgFobAllegion
- [List all generic inputs](https://openpath.readme.io/reference/listgenericinputs.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGenericInputs
- [Describe a generic input](https://openpath.readme.io/reference/describegenericinput.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeGenericInput
- [Update a generic input](https://openpath.readme.io/reference/updategenericinput.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-site:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateGenericInput
- [List all hook actions](https://openpath.readme.io/reference/listhookactions.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listHookActions
- [Create a hook action](https://openpath.readme.io/reference/createhookaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: createHookAction
- [Describe a hook action](https://openpath.readme.io/reference/describehookaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeHookAction
- [Update a hook action](https://openpath.readme.io/reference/updatehookaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateHookAction
- [Delete a hook action](https://openpath.readme.io/reference/deletehookaction.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-outboundWebhooks:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteHookAction
- [List all identity providers](https://openpath.readme.io/reference/listorgidentities.md): __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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgIdentities
- [List active mailrooms](https://openpath.readme.io/reference/listmailrooms.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listMailrooms
- [Create a mailroom](https://openpath.readme.io/reference/createmailroom.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: createMailroom
- [Get all mailroom statistics](https://openpath.readme.io/reference/describeallmailroomstatistics.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: describeAllMailroomStatistics
- [Describe a mailroom](https://openpath.readme.io/reference/describemailroom.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: describeMailroom
- [Update a mailroom](https://openpath.readme.io/reference/updatemailroom.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateMailroom
- [Delete a mailroom](https://openpath.readme.io/reference/deletemailroom.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteMailroom
- [Get single mailroom statistics](https://openpath.readme.io/reference/describemailroomstatistics.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: describeMailroomStatistics
- [Cancel mailroom](https://openpath.readme.io/reference/cancelmailroom.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o:w,s-o:w<br/><br/>__Endpoint name__: cancelMailroom
- [List all selected package plans](https://openpath.readme.io/reference/listorgpackageplansselected.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-role:w,o{params.orgId}-role:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-map:r,o{params.orgId}-map:w,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-videoIntercom:r,o{params.orgId}-videoIntercom:w,o{params.orgId}-videoProviderLive:w,o{params.orgId}-videoProviderPlayback:w,o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r,s-o-video:r,s-o-video:w,o{params.orgId}-sos:w<br/><br/>__Endpoint name__: listOrgPackagePlansSelected
- [Request a package plan upgrade](https://openpath.readme.io/reference/requestpackageupgrade.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-ldp:w,o{params.orgId}-dash:w,o{params.orgId}-dashActivity:w,o{params.orgId}-user:w,o{params.orgId}-credential:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-hw:w,o{params.orgId}-entryState:w,o{params.orgId}-admin:w,o{params.orgId}-integrations:w,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-configurations:w,o{params.orgId}-account:w,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-alertSettings:w,o{params.orgId}-role:w,o{params.orgId}-quickStart:w,o{params.orgId}-rpt:w<br/><br/>__Endpoint name__: requestPackageUpgrade
- [List active parcels](https://openpath.readme.io/reference/listparcels.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcels
- [Create a parcel](https://openpath.readme.io/reference/createparcel.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: createParcel
- [Bulk update parcels](https://openpath.readme.io/reference/updateparcels.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateParcels
- [Delete multiple parcels](https://openpath.readme.io/reference/deleteparcels.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteParcels
- [Describe a parcel](https://openpath.readme.io/reference/describeparcel.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: describeParcel
- [Update a parcel](https://openpath.readme.io/reference/updateparcel.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateParcel
- [Delete a parcel](https://openpath.readme.io/reference/deleteparcel.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteParcel
- [Lists activity for parcels](https://openpath.readme.io/reference/getparcelactivity.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:r,o:w,s-o:r,s-o:w<br/><br/>__Endpoint name__: getParcelActivity
- [Self-pickup - List parcels](https://openpath.readme.io/reference/listrecipientparcels.md): __Endpoint name__: listRecipientParcels
- [Lists parcel history](https://openpath.readme.io/reference/listparcelhistory.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcelHistory
- [List parcel pictures](https://openpath.readme.io/reference/listparcelpictures.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcelPictures
- [Create a parcel picture](https://openpath.readme.io/reference/createparcelpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: createParcelPicture
- [Get a parcel picture](https://openpath.readme.io/reference/describeparcelpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: describeParcelPicture
- [Update a parcel picture](https://openpath.readme.io/reference/updateparcelpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateParcelPicture
- [Delete a parcel picture](https://openpath.readme.io/reference/deleteparcelpicture.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteParcelPicture
- [Send custom email to recipients](https://openpath.readme.io/reference/sendcustomparcelemail.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: sendCustomParcelEmail
- [Self-pickup - resend parcel reminder](https://openpath.readme.io/reference/sendrecipientparcelreminder.md): __Endpoint name__: sendRecipientParcelReminder
- [Self-pickup - Update parcel status](https://openpath.readme.io/reference/updateparcelpickedupstatus.md): __Endpoint name__: updateParcelPickedUpStatus
- [Get a parcel signature](https://openpath.readme.io/reference/getparcelsignature.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: getParcelSignature
- [Sign parcels](https://openpath.readme.io/reference/signparcels.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: signParcels
- [List all parcel message types](https://openpath.readme.io/reference/listparcelmessagetypes.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcelMessageTypes
- [List all parcel statuses](https://openpath.readme.io/reference/listparcelstatuses.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcelStatuses
- [List all signed Terms of Service agreements](https://openpath.readme.io/reference/listtermsagreements.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTermsAgreements
- [Create a signed Terms of Service agreement - DEPRECATED use /orgs/{orgId}/termsAgreements/sign instead](https://openpath.readme.io/reference/createtermsagreement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w<br/><br/>__Endpoint name__: createTermsAgreement
- [Check if org has signed an acceptable Terms Agreement for an app or application](https://openpath.readme.io/reference/checksignedorgtermsagreement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o:w,o:r,s-o:w,s-o:r,s-o-video:w,s-o-video:r<br/><br/>__Endpoint name__: checkSignedOrgTermsAgreement
- [Sign an acceptable Terms Agreement for an app or application](https://openpath.readme.io/reference/signorgtermsagreement.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o{params.orgId}-integrations:w<br/><br/>__Endpoint name__: signOrgTermsAgreement
- [Describe an alarm](https://openpath.readme.io/reference/describealarm.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptAlarm:w,o{params.orgId}-rptAlarm:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmActions:w,o:w,o:r<br/><br/>__Endpoint name__: describeAlarm
- [Update an alarm](https://openpath.readme.io/reference/updatealarm.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmActions:w,o:w<br/><br/>__Endpoint name__: updateAlarm
- [Bulk update alarms](https://openpath.readme.io/reference/updatealarms.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-alarmActions:w,o:w<br/><br/>__Endpoint name__: updateAlarms
- [List all report tasks](https://openpath.readme.io/reference/listtasksreports.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTasksReports
- [Create a new batch report task.](https://openpath.readme.io/reference/createtasksreport.md): The report's time filter can be specified either via the `relativeTime` field or via the `filter` field.<br/><br/>The `relativeTime` field supports these possible values: today, thisWeek, thisMonth, thisQuarter, thisYear, lastHour, last4Hours, last12Hours, last24Hours, last7Days, last30Days, yesterday, lastFullWeek, lastFullMonth, lastFullQuarter, lastFullYear, last6FullMonths, last12FullMonths.<br/><br/>The `options` field supports `withWeekends` which is used for `occupancyOrg` reports.The `filter` field specifies the report date and time range and other filters. It uses the same syntax and field names from the `/orgs/{orgId}/reports/activity` API. Example: `"filter": "time:(1609459200--1612137600)"` means filter to all records with a `/orgs/{orgId}/reports/activity` `time` field value of `Jan 1, 2021 00:00:00 UTC` inclusive to `Feb 1, 2021 00:00:00 UTC` inclusive. If you also wanted to filter for `sideIds`, you would specify `"filter": "time:(1609459200--1612137600) siteId:(123,456,789)"`. That will return results for that same date range plus filtering for `siteIds` 123, 456, or 789.<br/><br/>The `columns` field is an in-order list of CSV columns to output. Possible values depend on the report type: For activityLogsOrg, the possible values are `time`, `category`, `subCategory`, `result`, `device`, `deviceDetail`, `deviceDetailName`, `deviceTimezone`, `deviceTime`, `user`, `userEmail`, `userOrg`, `userIdpName`, `userExternalId`, `initialCredentialTypeName`, `initialCredentialDetail`, `credentialTypeName`, `credentialDetail`, `target`, `initialRequest`, `request`, `location`, `entryName`, `entryName2`, `zoneName`, `zoneName2`, `siteName`, `siteName2`, `source`, `deniedReason`, `requestId`. For alarmsOrg, the possible values are `alarmId`, `alarmConfigName`, `time`, `eventName`, `siteName2`, `zoneName2`, `entryName2`, `alarmActionName`, `userName`, `assignee`, `alarmStatusName`, `acuName`, `readerName`, `note`. For occupancyOrg, the possible values are `user`, `userEmail`, `userGroups`. Include a `customFieldIdx#` column name to specify `customFieldIds` column placement. Example: where `customFieldId` for id `49` has a name of `Department` and the payload is `..., "columns": ["time", "category", "customFieldIdx0"], "customFieldIds": [49], ...` means output `"time", "category", "Department"` column headers and subsequent lines with respective values in that `columns` specified order. In this example, customFieldIdx0 is the 0th index in the `customFieldsIds` array.<br/><br/>The difference between entryName, zoneName, and siteName vs. entryName2, zoneName2, and siteName2 is that the `*Name2` fields can potentially return "Multiple" as the name. This occurs when there are multiple unique ids for that resource type. Whereas the entryId, entryName, zoneId, zoneName, siteId, and siteName values always equal the first entry's values (entries[0]).<br/><br/>The expiresAfter specification can be specified either via a concrete date in `expiresAfter` or via a relative number of days from the `expiresAfterDays` field.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o-support:w,o:w,s-o:w<br/><br/>__Endpoint name__: createTasksReport
- [Get a specific report task by id.](https://openpath.readme.io/reference/describetasksreport.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptDownload:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeTasksReport
- [Delete a specific report task by id.](https://openpath.readme.io/reference/deletetasksreport.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteTasksReport
- [List all schedules for all the report tasks](https://openpath.readme.io/reference/listtasksreportsschedules.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTasksReportsSchedules
- [Create a new scheduled report task.](https://openpath.readme.io/reference/createtasksreportsschedule.md): The cronTime value uses a restricted cron time format: `minute hour day-of-month month days-of-week`.Specifically, the cronTime is restricted to support only a daily, weekly, monthly or 1st day of the quarter. Daily is supported through a `min hr * * *` cronTime for daily execution at hr:min time. Weekly is supported through a `min hr * * <day-of-week1>,<dow2>,...` cronTime for weekly execution at hr:min time on `<dow#>` days (e.g. 0=Sunday, 1=Monday). Monthly is supported through a `min hr day * *` cronTime for monthly execution on <day> at hr:min time. 1st day of quarter is supported through a `min hr 1 1,4,7,10 *` cronTime for 1st day of quarter execution at hr:min time.<br/><br/>The randomDelaySecs provides the number of seconds to delay the start of execution. The minimum required delay is 3 hours.<br/><br/>The params field provides the report specific options. See /orgs/{orgId}/tasks/reports help for details.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createTasksReportsSchedule
- [Get a specific task report schedule by id.](https://openpath.readme.io/reference/describetasksreportsschedule.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeTasksReportsSchedule
- [Update a specific task report schedule](https://openpath.readme.io/reference/updatetasksreportsschedule.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateTasksReportsSchedule
- [Delete a specific task report schedule by id.](https://openpath.readme.io/reference/deletetasksreportsschedule.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteTasksReportsSchedule
- [Get a link to the specific report task result by id.](https://openpath.readme.io/reference/describetasksreportlink.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptDownload:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeTasksReportLink
- [Describe a recent alarm](https://openpath.readme.io/reference/describerecentalarm.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: describeRecentAlarm
- [Trigger recalculation/broadcast of entry permissions (as if an actual permissions-changing event had occurred)](https://openpath.readme.io/reference/triggerpermissionschange.md): This API forces the immediate recalculation and broadcast of all entry permissions for the specified org. Do not repeatedly call this for regular permissions recalculations.<br/><br/>This API request is often called once after a series of x-op-triggers:bypass header related permission change API calls.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: triggerPermissionsChange
- [Receives a generateActivityLogsFilter request and passes it to cobalt to execute](https://openpath.readme.io/reference/generateactivitylogsfilter.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: generateActivityLogsFilter
- [List all wireless gateways](https://openpath.readme.io/reference/listwirelessgateways.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o{params.orgId}-hw:r,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessGateways
- [Create a wireless gateway](https://openpath.readme.io/reference/createwirelessgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessGateway
- [Describe a wireless gateway](https://openpath.readme.io/reference/describewirelessgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-integrations:r,o:r,s-o:r<br/><br/>__Endpoint name__: describeWirelessGateway
- [Remove a wireless gateway](https://openpath.readme.io/reference/deletewirelessgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessGateway
- [Update a wireless gateway](https://openpath.readme.io/reference/updatewirelessgateway.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessGateway
- [Update the firmware for multiple wireless gateways to the latest version](https://openpath.readme.io/reference/updatewirelessgatewayfirmwarebatch.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessGatewayFirmwareBatch
- [Sync devices for a wireless gateway](https://openpath.readme.io/reference/syncwirelessgatewaydevices.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncWirelessGatewayDevices
- [Update the firmware for a wireless gateway to a specific version](https://openpath.readme.io/reference/updatewirelessgatewayfirmware.md): __JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWirelessGatewayFirmware
- [List all wireless lock templates](https://openpath.readme.io/reference/listwirelesslocktemplates.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: listWirelessLockTemplates
- [Create a wireless lock template](https://openpath.readme.io/reference/createwirelesslocktemplate.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: createWirelessLockTemplate
- [Get a wireless lock template](https://openpath.readme.io/reference/describewirelesslocktemplate.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: describeWirelessLockTemplate
- [Delete a wireless lock template](https://openpath.readme.io/reference/deletewirelesslocktemplate.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: deleteWirelessLockTemplate
- [Update a wireless lock template](https://openpath.readme.io/reference/updatewirelesslocktemplate.md): __JWT is required for this endpoint with at least one of the following scopes__: undefined<br/><br/>__Endpoint name__: updateWirelessLockTemplate
- [Get ACU diagnostics report](https://openpath.readme.io/reference/getacudiagnosticsreport.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o:r,s-o:w,s-o:r,o-basic:w,o-basic:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r<br/><br/>__Endpoint name__: getAcuDiagnosticsReport
- [Create an ACU diagnostics report](https://openpath.readme.io/reference/createacudiagnosticsreport.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,s-o:w,o-basic:w,o{params.orgId}-hw:w<br/><br/>__Endpoint name__: createAcuDiagnosticsReport
- [Set/update the background image for an opvideo device facade](https://openpath.readme.io/reference/setopvideodevicefacadebackgroundimage.md): __JWT is required for this endpoint with at least one of the following scopes__: o:r,o-basic:r,s-o:r,o{params.orgId}-opvideoDevice:r<br/><br/>__Endpoint name__: setOpVideoDeviceFacadeBackgroundImage
- [Delete a background image for an opvideo device facade](https://openpath.readme.io/reference/deleteopvideodevicefacadebackgroundimage.md): __JWT is required for this endpoint with at least one of the following scopes__: o:w,o-basic:w,s-o:w,o{params.orgId}-opvideoDevice:w<br/><br/>__Endpoint name__: deleteOpVideoDeviceFacadeBackgroundImage