Openpath orgs/sharedUsers API
The orgs/sharedUsers API from Openpath — 3 operation(s) for orgs/sharedusers.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/sharedUsers API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
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:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: identity.lastName
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/sharedUsers
security:
- jwt: []
responses:
'200':
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
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
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
x-nullable: true
middleName:
type: string
x-nullable: true
lastName:
type: string
x-nullable: true
fullName:
type: string
x-nullable: true
initials:
type: string
x-nullable: true
isEmailVerified:
type: boolean
namespace:
type: object
properties:
id:
type: integer
nickname:
type: string
x-nullable: true
namespaceType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
x-nullable: true
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
x-nullable: true
credentials:
type: string
x-nullable: true
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
x-nullable: true
needsPasswordChange:
type: boolean
default: false
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
mobilePhone:
type: string
x-nullable: true
language:
type: string
x-nullable: true
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
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
org:
type: object
properties:
id:
type: number
name:
type: string
x-nullable: true
required:
- id
required:
- id
required:
- id
createdAt:
type: string
format: date
pictureUrl:
type: string
x-nullable: true
pictureExpiresAt:
type: number
x-nullable: true
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:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
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:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: userId
in: path
required: true
- type: string
default: ''
name: options
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/sharedUsers
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
opal:
type: string
status:
type: string
startDate:
type: string
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
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
x-nullable: true
middleName:
type: string
x-nullable: true
lastName:
type: string
x-nullable: true
fullName:
type: string
x-nullable: true
initials:
type: string
x-nullable: true
isEmailVerified:
type: boolean
namespace:
type: object
properties:
id:
type: integer
nickname:
type: string
x-nullable: true
namespaceType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
x-nullable: true
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
x-nullable: true
credentials:
type: string
x-nullable: true
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
x-nullable: true
needsPasswordChange:
type: boolean
default: false
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
mobilePhone:
type: string
x-nullable: true
language:
type: string
x-nullable: true
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
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
org:
type: object
properties:
id:
type: number
name:
type: string
x-nullable: true
required:
- id
required:
- id
required:
- id
createdAt:
type: string
format: date
pictureUrl:
type: string
x-nullable: true
pictureExpiresAt:
type: number
x-nullable: true
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:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
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 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'
parameters:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
limit:
type: integer
minimum: 1
maximum: 1000
offset:
type: integer
default: 0
minimum: 0
sort:
type: string
default: identity.lastName
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
order:
type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
q:
type: string
filter:
type: string
preFilter:
type: string
consumes:
- application/json
produces:
- application/json
tags:
- orgs/sharedUsers
security:
- jwt: []
responses:
'200':
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
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
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
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-sharedusers-api-openapi.yml