Openpath orgs/sharedUsers API
The orgs/sharedUsers API from Openpath — 3 operation(s) for orgs/sharedusers.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-sharedusers-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Openpath API Documentation auth Orgs/shared Users API
version: 1.0.0
description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/sharedUsers
paths:
/orgs/{orgId}/sharedUsers:
get:
summary: List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)
operationId: listSharedUsers
description: '__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'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: limit
in: query
schema:
type: integer
maximum: 1000
minimum: 1
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
- name: sort
in: query
schema:
type: string
default: identity.lastName
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
- name: order
in: query
schema:
type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
- name: q
in: query
schema:
type: string
- name: filter
in: query
schema:
type: string
- name: preFilter
in: query
schema:
type: string
tags:
- orgs/sharedUsers
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
opal:
type: string
status:
type: string
startDate:
type:
- string
- 'null'
format: date
endDate:
type:
- string
- 'null'
format: date
hasRemoteUnlock:
type: boolean
isOverrideAllowed:
type: boolean
identity:
type: object
properties:
id:
type: number
opal:
type: string
roles:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
description:
type: string
isMfaRequired:
type: boolean
required:
- id
mfaCredentials:
type: array
items:
type: object
properties:
id:
type: number
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
name:
type: string
status:
type: string
mfaCredentialType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
required:
- id
totpSoftDevice:
type: object
properties:
id:
type: number
required:
- id
required:
- id
firstName:
type:
- string
- 'null'
middleName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
initials:
type:
- string
- 'null'
isEmailVerified:
type: boolean
namespace:
type: object
properties:
id:
type: integer
nickname:
type:
- string
- 'null'
namespaceType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type:
- string
- 'null'
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
identityProvider:
type: object
properties:
id:
type: number
isSsoEnabled:
type: boolean
isSyncMobilePhoneEnabled:
type: boolean
isRemoveGroupsEnabled:
type: boolean
identityProviderSyncTypeId:
type:
- integer
- 'null'
credentials:
type:
- string
- 'null'
identityProviderType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
propertyManagementSystem:
type: object
properties:
id:
type: number
orgId:
type: number
propertyManagementSystemTypeId:
type: number
propertyManagementSystemType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
- orgId
- propertyManagementSystemTypeId
required:
- id
idpUniqueIdentifier:
type: string
pmsUniqueIdentifier:
type:
- string
- 'null'
needsPasswordChange:
type: boolean
default: false
nicknames:
type:
- array
- 'null'
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
mobilePhone:
type:
- string
- 'null'
language:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
users:
type: array
items:
type: object
properties:
id:
type: number
opal:
type: string
status:
type: string
startDate:
type:
- string
- 'null'
format: date
endDate:
type:
- string
- 'null'
format: date
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
org:
type: object
properties:
id:
type: number
name:
type:
- string
- 'null'
required:
- id
required:
- id
required:
- id
createdAt:
type: string
format: date
pictureUrl:
type:
- string
- 'null'
pictureExpiresAt:
type:
- number
- 'null'
org:
type: object
properties:
id:
type: number
opal:
type: string
name:
type: string
required:
- id
sites:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-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
/orgs/{orgId}/sharedUsers/{userId}:
get:
summary: Describe a user that has access to at least one zone from this org (including users from other orgs via zone sharing)
operationId: describeSharedUser
description: '__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'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: userId
in: path
required: true
schema:
type: integer
- name: options
in: query
schema:
type: string
default: ''
tags:
- orgs/sharedUsers
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
opal:
type: string
status:
type: string
startDate:
type:
- string
- 'null'
format: date
endDate:
type:
- string
- 'null'
format: date
hasRemoteUnlock:
type: boolean
isOverrideAllowed:
type: boolean
identity:
type: object
properties:
id:
type: number
opal:
type: string
roles:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
description:
type: string
isMfaRequired:
type: boolean
required:
- id
mfaCredentials:
type: array
items:
type: object
properties:
id:
type: number
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
name:
type: string
status:
type: string
mfaCredentialType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
required:
- id
totpSoftDevice:
type: object
properties:
id:
type: number
required:
- id
required:
- id
firstName:
type:
- string
- 'null'
middleName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
initials:
type:
- string
- 'null'
isEmailVerified:
type: boolean
namespace:
type: object
properties:
id:
type: integer
nickname:
type:
- string
- 'null'
namespaceType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type:
- string
- 'null'
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
identityProvider:
type: object
properties:
id:
type: number
isSsoEnabled:
type: boolean
isSyncMobilePhoneEnabled:
type: boolean
isRemoveGroupsEnabled:
type: boolean
identityProviderSyncTypeId:
type:
- integer
- 'null'
credentials:
type:
- string
- 'null'
identityProviderType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
propertyManagementSystem:
type: object
properties:
id:
type: number
orgId:
type: number
propertyManagementSystemTypeId:
type: number
propertyManagementSystemType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
- orgId
- propertyManagementSystemTypeId
required:
- id
idpUniqueIdentifier:
type: string
pmsUniqueIdentifier:
type:
- string
- 'null'
needsPasswordChange:
type: boolean
default: false
nicknames:
type:
- array
- 'null'
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
mobilePhone:
type:
- string
- 'null'
language:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
users:
type: array
items:
type: object
properties:
id:
type: number
opal:
type: string
status:
type: string
startDate:
type:
- string
- 'null'
format: date
endDate:
type:
- string
- 'null'
format: date
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
org:
type: object
properties:
id:
type: number
name:
type:
- string
- 'null'
required:
- id
required:
- id
required:
- id
createdAt:
type: string
format: date
pictureUrl:
type:
- string
- 'null'
pictureExpiresAt:
type:
- number
- 'null'
org:
type: object
properties:
id:
type: number
opal:
type: string
name:
type: string
required:
- id
sites:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-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
/orgs/{orgId}/sharedUsers/list:
post:
summary: List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)
operationId: listSharedUsersPost
description: '__JWT is required for this endpoint with at least
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-sharedusers-api-openapi.yml