/
OP
openpath
/
Openpath API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
auth
10
get
Describe an access token's associated identity and scopes
post
Login
post
Login all successful matches for email/password
post
Logout
post
Send email to reset password
post
Send email with magic link to setup mobile
post
Create a new access token with refreshed scopes and expiration time, invalidate old token
post
DEPRECATED - use /auth/sso/authorize instead
post
Generate SSO authorize URL (may be OIDC or SAML)
post
Validate an access token for proper signature, format, expiration, and active status
billableFeatures
1
identities
2
orgs/acuModels
2
orgs/acuPorts
1
orgs/acuPortTypes
2
orgs/acus
36
orgs/alarmActions
2
orgs/alarmConfigurations
8
orgs/alarmSeverities
2
orgs/alarmsExt
3
orgs/alarmStatuses
2
orgs/authCerts
5
orgs/badgeConfigs
5
orgs/cardFormats
2
orgs/cobalt
1
orgs/contactSensors
3
orgs/credentialActionTypes
2
orgs/credentials
6
orgs/credentialTypes
6
orgs/customFields
12
orgs/customFieldTypes
2
orgs/dashboards
10
orgs/emailAlerts
1
orgs/emailAlertTypes
2
orgs/entries
35
orgs/entryStates
6
orgs/eolSupervisions
2
orgs/features
1
orgs/fobAllegions
4
orgs/genericInputs
3
orgs/groups
20
orgs/hookActions
5
orgs/hookEvents
2
orgs/identityProviders
10
orgs/identityProviderTypes
2
orgs/ios
2
orgs/locationMeasurementSourceTypes
2
orgs/lockdownPlans
7
orgs/mailrooms
8
orgs/maintenanceWindow
4
orgs/maintenanceWindowDefinition
4
orgs/maintenanceWindowMap
3
orgs/mobileAppConfig
3
orgs/namespaces
1
orgs/opvideo-devices
2
orgs/orgIdentities
1
orgs/orgPackagePlans
2
orgs/orgPictures
5
orgs/packagePlans
2
orgs/palettes
2
orgs/parcelMessageTypes
1
orgs/parcels
20
orgs/parcelStatuses
1
orgs/readers
7
orgs/recentAlarms
1
orgs/recentAlarmsExt
1
orgs/relayHardwareTypes
2
orgs/relays
3
orgs/reports
6
orgs/rexs
3
orgs/roles
13
orgs/schedules
12
orgs/scheduleTypes
2
orgs/scopeResources
2
orgs/sharedUsers
3
orgs/sites
22
orgs/subscriptions
5
orgs/tasks
10
orgs/termsAgreements
4
orgs/thirdPartyReaders
3
orgs/thirdPartyWiegands
3
orgs/triggerMethods
2
orgs/triggerPermissionsChange
1
orgs/unusedInputs
3
orgs/users
60
orgs/videoProviderTypes
1
orgs/widgetTypes
2
orgs/wiegands
3
orgs/wirelessGateways
8
orgs/wirelessLockGateways
8
orgs/wirelessLockProviders
8
orgs/wirelessLockReaders
5
orgs/wirelessLocks
8
orgs/wirelessLockTemplates
5
orgs/zones
31
tokens
2
auth
Generate SSO authorize URL (may be OIDC or SAML)
Endpoint name
: getSsoAuthUrl
post
/auth/sso/authorize
Request body
object
required
namespaceId
integer
namespaceNickname
string
email
string
uuid
string
redirectUrlDirect
boolean
redirectUrl
string
forMobileLogin
boolean
Response
Successful
object
required
data
object
meta
object
Changes