How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Openpath orgs/users API

Users and Credentials

Openpath orgs/users API is one of 89 APIs that Openpath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orgs/users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 60 operations across 41 paths. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.openpath.com.

60 operations 41 paths 0 schemas 4 DELETE22 GET11 PATCH16 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.openpath.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Openpath orgs/users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (jwt).

Paths & Operations 60

Across 41 paths, the API surfaces 60 operations — 4 DELETE, 22 GET, 11 PATCH, 16 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

orgs/users 60

Users and Credentials

GET
/orgs/{orgId}/users
List all users
listUsers 13 params → 200
POST
/orgs/{orgId}/users
Create a user
createUser 2 params → 201
GET
/orgs/{orgId}/users/{userId}
Describe a user
describeUser 3 params → 200
DELETE
/orgs/{orgId}/users/{userId}
Delete a user
deleteUser 3 params → 204
PATCH
/orgs/{orgId}/users/{userId}
Update a user
updateUser 3 params → 200
GET
/orgs/{orgId}/users/{userId}/userPictures
List all user pictures
listUserPictures 9 params → 200
POST
/orgs/{orgId}/users/{userId}/userPicturesdeprecated
Create a user picture (DEPRECATED)
createUserPicture 3 params → 201
GET
/orgs/{orgId}/users/{userId}/mfaCredentials
List all MFA credentials (for users in the local org namespace only)
listUserMfaCredentials 9 params → 200
GET
/orgs/{orgId}/users/{userId}/badge
Describe user badge
describeUserBadge 2 params → 200
GET
/orgs/{orgId}/users/{userId}/zones
List all zones a user has access to
listUserZones 9 params → 200
GET
/orgs/{orgId}/users/{userId}/acus
List all ACUs a user has access to
listUserAcus 9 params → 200
GET
/orgs/{orgId}/users/{userId}/sites
List all sites of a user
listUserSites 9 params → 200
GET
/orgs/{orgId}/users/{userId}/roles
List all roles of a user
listUserRoles 9 params → 200
GET
/orgs/{orgId}/users/{userId}/groups
List all groups of a user
listUserGroups 9 params → 200
GET
/orgs/{orgId}/users/{userId}/entries
List all entries a user has access to
listUserEntries 2 params → 200
GET
/orgs/{orgId}/users/{userId}/zoneUsers
List all zones (and their associated configurations) a user has access to
listUserZoneUsers 9 params → 200
PATCH
/orgs/{orgId}/users/{userId}/zoneUsers
Bulk-update a user's zones and their associated configurations
updateUserZoneUsers 3 params → 204
PUT
/orgs/{orgId}/users/{userId}/zoneUsers
Set a user's zones (and their associated configurations) by replacing the entire set with this one
setUserZoneUsers 3 params → 204
GET
/orgs/{orgId}/users/{userId}/credentials
List all user credentials
listCredentials 9 params → 200
POST
/orgs/{orgId}/users/{userId}/credentials
Create a user credential
createCredential 3 params → 201
GET
/orgs/{orgId}/users/{userId}/customFields
List all user custom fields
listUserCustomFields 9 params → 200
PATCH
/orgs/{orgId}/users/{userId}/customFields
Update all user custom fields
updateUserCustomFields 3 params → 204
GET
/orgs/{orgId}/users/{userId}/intercomNotificationPreferenceSet
Get a user's intercom notification preferences
describeUserIntercomNotificationPreferenceSet 2 params → 200
PATCH
/orgs/{orgId}/users/{userId}/intercomNotificationPreferenceSet
Update a user's intercom notification preferences
updateUserIntercomNotificationPreferenceSet 3 params → 204
GET
/orgs/{orgId}/users/{userId}/preferenceSet
Get a user's preference set
describeUserPreferenceSet 2 params → 200
PATCH
/orgs/{orgId}/users/{userId}/preferenceSet
Update a user's preference set
updateUserPreferenceSet 3 params → 204
GET
/orgs/{orgId}/users/{userId}/userPictures/avatar
Get the user avatar picture
getUserAvatarPicture 3 params → 200
DELETE
/orgs/{orgId}/users/{userId}/userPictures/avatar
Delete the user avatar picture
deleteUserAvatarPicture 2 params → 204
PUT
/orgs/{orgId}/users/{userId}/userPictures/avatar
Set the user avatar picture
setUserAvatarPicture 3 params → 201
GET
/orgs/{orgId}/users/{userId}/customFields/{customFieldId}
Describe a user custom field
describeUserCustomField 3 params → 200
PATCH
/orgs/{orgId}/users/{userId}/customFields/{customFieldId}
Update a user custom field
updateUserCustomField 4 params → 204
GET
/orgs/{orgId}/users/{userId}/credentials/{credentialId}
Describe a user credential
describeCredential 3 params → 200
DELETE
/orgs/{orgId}/users/{userId}/credentials/{credentialId}
Delete a user credential
deleteCredential 3 params → 204
PATCH
/orgs/{orgId}/users/{userId}/credentials/{credentialId}
Update a user credential
updateCredential 4 params → 204
GET
/orgs/{orgId}/users/{userId}/reports/activity
Get a user's entry activity
getUserActivity 9 params → 200
GET
/orgs/{orgId}/users/{userId}/noTourCredentialSectors/validationData
List all no tour credential sector validation data for this user
listOrgNoTourCredentialSectorsValidationData 2 params → 200
GET
/orgs/{orgId}/users/{userId}/userPictures/{userPictureId}deprecated
Describe a user picture (DEPRECATED)
describeUserPicture 3 params → 200
DELETE
/orgs/{orgId}/users/{userId}/userPictures/{userPictureId}deprecated
Delete a user picture (DEPRECATED)
deleteUserPicture 3 params → 204
PATCH
/orgs/{orgId}/users/{userId}/userPictures/{userPictureId}deprecated
Update a user picture (DEPRECATED)
updateUserPicture 4 params → 204
POST
/orgs/{orgId}/users/list
List all users
listUsersPost 2 params → 200
POST
/orgs/{orgId}/users/{userId}/submitCobaltUserFeedback
Receives feedback from the user and store it
submitCobaltUserFeedback 3 params → 204
POST
/orgs/{orgId}/users/{userId}/verifyEmail
Send email to user to verify email
verifyEmail 2 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyRevertLockdownPlan
Use a cloudKey credential to request reverting a lockdown plan
cloudKeyRevertLockdownPlan 4 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyLockdownPlanActionToken
Generate new cloudKey token for a specific action on a specific lockdown plan
generateCloudKeyLockdownPlanActionToken 4 params → 201
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyUnlockToken
Generate new cloudKey unlock token for a specific entry.
generateCloudKeyUnlockToken 4 params → 201
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateSetupMobileToken
Generate new setup mobile token for credential
generateSetupMobileToken 3 params → 201
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/setupMobile
Send email to user to set up their mobile credential
setupMobileCredential 3 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyEntryUnlock
Use a cloudKey credential to request a cloud-unlock of an entry
cloudKeyEntryUnlock 4 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyTriggerLockdownPlan
Use a cloudKey credential to request triggering a lockdown plan
cloudKeyTriggerLockdownPlan 4 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/setupWallet
Send email to user to set up their wallet credential
setupWalletCredential 3 params → 204
POST
/orgs/{orgId}/users/{userId}/credentials/cloudKey/{cloudKeyId}/generateUnlockToken
Generate new cloudKey unlock token for a specific entry
generateCloudKeyUnlockTokenByModelId 4 params → 201
POST
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/wallets/{walletId}/walletApples/{walletAppleId}/walletAppleDevices/{walletAppleDeviceId}/sync
Sync Apple Wallet Device
syncWalletAppleDevice 6 params → 204
PATCH
/orgs/{orgId}/users/{userId}/groupIds
Bulk-update a user's groups
updateUserGroupIds 3 params → 204
PUT
/orgs/{orgId}/users/{userId}/groupIds
Set a user's groups by replacing the entire set with this one
setUserGroupIds 3 params → 204
PATCH
/orgs/{orgId}/users/{userId}/siteIds
Bulk-update a user's sites
updateUserSiteIds 3 params → 204
PUT
/orgs/{orgId}/users/{userId}/siteIds
Set a user's sites by replacing the entire set with this one
setUserSiteIds 3 params → 204
PATCH
/orgs/{orgId}/users/{userId}/credentials/{credentialId}/wallets/{walletId}/walletApples/{walletAppleId}/walletAppleDevices/{walletAppleDeviceId}
Update Apple Wallet Device
updateWalletAppleDevice 7 params → 204
PUT
/orgs/{orgId}/users/{userId}/status
Set a user's status
setUserStatus 3 params → 204
PUT
/orgs/{orgId}/users/{userId}/zoneIds
Set a user's zones by replacing the entire set with this one
setUserZoneIds 3 params → 204
PUT
/orgs/{orgId}/users/{userId}/roleIds
Set a user's roles by replacing the entire set with this one
setUserRoleIds 3 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openpath-orgs-users-api-openapi.yml Raw ↑

Other APIs Openpath publishes across the network.

Openpath auth API
Openpath billableFeatures API
Openpath identities API
Openpath orgs/acuModels API
Openpath orgs/acuPorts API
Openpath orgs/acuPortTypes API
Openpath orgs/acus API
Openpath orgs/alarmActions API
Openpath orgs/alarmConfigurations API
Openpath orgs/alarmSeverities API
Openpath orgs/alarmsExt API
Openpath orgs/alarmStatuses API
Where this information came from

This is an independent, third-party profile of Openpath orgs/users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.