Openpath

Openpath Orgs/users API

Users and Credentials

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 60

GET /orgs/{orgId}/users List all users #
POST /orgs/{orgId}/users Create a user #
GET /orgs/{orgId}/users/{userId} Describe a user #
DELETE /orgs/{orgId}/users/{userId} Delete a user #
PATCH /orgs/{orgId}/users/{userId} Update a user #
GET /orgs/{orgId}/users/{userId}/userPictures List all user pictures #
POST /orgs/{orgId}/users/{userId}/userPictures Create a user picture (DEPRECATED) #
GET /orgs/{orgId}/users/{userId}/mfaCredentials List all MFA credentials (for users in the local org namespace only) #
GET /orgs/{orgId}/users/{userId}/badge Describe user badge #
GET /orgs/{orgId}/users/{userId}/zones List all zones a user has access to #
GET /orgs/{orgId}/users/{userId}/acus List all ACUs a user has access to #
GET /orgs/{orgId}/users/{userId}/sites List all sites of a user #
GET /orgs/{orgId}/users/{userId}/roles List all roles of a user #
GET /orgs/{orgId}/users/{userId}/groups List all groups of a user #
GET /orgs/{orgId}/users/{userId}/entries List all entries a user has access to #
GET /orgs/{orgId}/users/{userId}/zoneUsers List all zones (and their associated configurations) a user has access to #
PATCH /orgs/{orgId}/users/{userId}/zoneUsers Bulk-update a user's zones and their associated configurations #
PUT /orgs/{orgId}/users/{userId}/zoneUsers Set a user's zones (and their associated configurations) by replacing the… #
GET /orgs/{orgId}/users/{userId}/credentials List all user credentials #
POST /orgs/{orgId}/users/{userId}/credentials Create a user credential #
GET /orgs/{orgId}/users/{userId}/customFields List all user custom fields #
PATCH /orgs/{orgId}/users/{userId}/customFields Update all user custom fields #
GET /orgs/{orgId}/users/{userId}/intercomNotificationPreferenceSet Get a user's intercom notification preferences #
PATCH /orgs/{orgId}/users/{userId}/intercomNotificationPreferenceSet Update a user's intercom notification preferences #
GET /orgs/{orgId}/users/{userId}/preferenceSet Get a user's preference set #
PATCH /orgs/{orgId}/users/{userId}/preferenceSet Update a user's preference set #
GET /orgs/{orgId}/users/{userId}/userPictures/avatar Get the user avatar picture #
DELETE /orgs/{orgId}/users/{userId}/userPictures/avatar Delete the user avatar picture #
PUT /orgs/{orgId}/users/{userId}/userPictures/avatar Set the user avatar picture #
GET /orgs/{orgId}/users/{userId}/customFields/{customFieldId} Describe a user custom field #
PATCH /orgs/{orgId}/users/{userId}/customFields/{customFieldId} Update a user custom field #
GET /orgs/{orgId}/users/{userId}/credentials/{credentialId} Describe a user credential #
DELETE /orgs/{orgId}/users/{userId}/credentials/{credentialId} Delete a user credential #
PATCH /orgs/{orgId}/users/{userId}/credentials/{credentialId} Update a user credential #
GET /orgs/{orgId}/users/{userId}/reports/activity Get a user's entry activity #
GET /orgs/{orgId}/users/{userId}/noTourCredentialSectors/validationData List all no tour credential sector validation data for this user #
GET /orgs/{orgId}/users/{userId}/userPictures/{userPictureId} Describe a user picture (DEPRECATED) #
DELETE /orgs/{orgId}/users/{userId}/userPictures/{userPictureId} Delete a user picture (DEPRECATED) #
PATCH /orgs/{orgId}/users/{userId}/userPictures/{userPictureId} Update a user picture (DEPRECATED) #
POST /orgs/{orgId}/users/list List all users #
POST /orgs/{orgId}/users/{userId}/submitCobaltUserFeedback Receives feedback from the user and store it #
POST /orgs/{orgId}/users/{userId}/verifyEmail Send email to user to verify email #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyRevertLockdownPlan Use a cloudKey credential to request reverting a lockdown plan #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyLockdownPlanActionToken Generate new cloudKey token for a specific action on a specific lockdown plan #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyUnlockToken Generate new cloudKey unlock token for a specific entry #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateSetupMobileToken Generate new setup mobile token for credential #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/setupMobile Send email to user to set up their mobile credential #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyEntryUnlock Use a cloudKey credential to request a cloud-unlock of an entry #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/cloudKeyTriggerLockdownPlan Use a cloudKey credential to request triggering a lockdown plan #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/setupWallet Send email to user to set up their wallet credential #
POST /orgs/{orgId}/users/{userId}/credentials/cloudKey/{cloudKeyId}/generateUnlockToken Generate new cloudKey unlock token for a specific entry #
POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/wallets/{walletId}/walletApples/{walletAppleId}/walletAppleDevices/{walletAppleDeviceId}/sync Sync Apple Wallet Device #
PATCH /orgs/{orgId}/users/{userId}/groupIds Bulk-update a user's groups #
PUT /orgs/{orgId}/users/{userId}/groupIds Set a user's groups by replacing the entire set with this one #
PATCH /orgs/{orgId}/users/{userId}/siteIds Bulk-update a user's sites #
PUT /orgs/{orgId}/users/{userId}/siteIds Set a user's sites by replacing the entire set with this one #
PATCH /orgs/{orgId}/users/{userId}/credentials/{credentialId}/wallets/{walletId}/walletApples/{walletAppleId}/walletAppleDevices/{walletAppleDeviceId} Update Apple Wallet Device #
PUT /orgs/{orgId}/users/{userId}/status Set a user's status #
PUT /orgs/{orgId}/users/{userId}/zoneIds Set a user's zones by replacing the entire set with this one #
PUT /orgs/{orgId}/users/{userId}/roleIds Set a user's roles by replacing the entire set with this one #

Documentation

📖
Documentation
https://openpath.readme.io
📖
APIReference
https://openpath.readme.io/reference
📖
GettingStarted
https://openpath.readme.io/docs/basics-to-start

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openpath-orgs-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpath-orgs-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Openpath API Documentation Orgs/users API
  version: 1.0.0
  description: Users and Credentials
servers:
- url: https://api.openpath.com
tags:


# --- truncated at 32 KB (3451 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-users-api-openapi.yml