Openpath orgs/credentials API
The orgs/credentials API from Openpath — 3 operation(s) for orgs/credentials.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/credentials API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/credentials
paths:
/orgs/{orgId}/credentials:
get:
summary: List all credentials from all users within the org
operationId: listOrgCredentials
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}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgCredentials'
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: id
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
- type: string
default: ''
name: options
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/credentials
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
startDate:
type: string
format: date
x-nullable: true
endDate:
type: string
format: date
x-nullable: true
credentialType:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
required:
- id
mobile:
type: object
properties:
id:
type: number
name:
type: string
x-nullable: true
provisionedAt:
type: string
format: date
x-nullable: true
httpUserAgent:
type: string
x-nullable: true
version:
type: string
x-nullable: true
build:
type: number
x-nullable: true
os:
type: string
x-nullable: true
hasSetupMobileToken:
type: boolean
userIotCert:
x-nullable: true
type: object
properties:
id:
type: number
awsIotCertArn:
type: string
certOpal:
type: string
required:
- id
required:
- id
eventAction:
x-nullable: true
type: object
properties:
credentialId:
type: number
command:
type: string
enum:
- triggerLockdown
- revertLockdown
- unlockWithOverride
targetId:
type: number
x-nullable: true
required:
- command
pincode:
type: object
properties:
id:
type: number
number:
type: string
required:
- id
card:
type: object
properties:
id:
type: number
number:
type: string
numBits:
type: integer
isOutputEnabled:
type: boolean
cardFormat:
type: object
properties:
id:
type: integer
code:
type: string
numBits:
type: integer
required:
- id
facilityCode:
type: string
pattern: ^[0-9]+$
x-nullable: true
cardId:
type: string
pattern: ^[0-9]+$
x-nullable: true
fields:
x-nullable: true
type: object
properties:
rcm:
type: string
pattern: ^[0-9]+$
facilityCode:
type: string
pattern: ^[0-9]+$
issueLevel:
type: string
pattern: ^[0-9]+$
cardId:
type: string
pattern: ^[0-9]+$
companyId:
type: string
pattern: ^[0-9]+$
companyCode:
type: string
pattern: ^[0-9]+$
siteCode:
type: string
pattern: ^[0-9]+$
oem:
type: string
pattern: ^[0-9]+$
required:
- id
cardMifareCsn:
type: object
properties:
id:
type: number
number:
type: string
required:
- id
cardOpenpathDesfireEv1:
type: object
properties:
id:
type: number
number:
type: string
noTourCredentialCommands:
type: array
items:
type: object
properties:
id:
type: number
command:
type: string
enum:
- ADD
- DEL
fobAllegionId:
type: integer
x-nullable: true
cardOpenpathDesfireEv1Id:
type: integer
x-nullable: true
allegionMobileId:
type: integer
x-nullable: true
wirelessLock:
type: object
properties:
id:
type: number
name:
type: string
manufacturer:
type: string
model:
type: string
serialNumber:
type: string
x-nullable: true
idExt:
type: string
x-nullable: true
lastConnectedAt:
type: string
format: date
x-nullable: true
doorFileLastSyncedAt:
type: string
format: date
x-nullable: true
auditsLastSyncedAt:
type: string
format: date
x-nullable: true
linkId:
type: string
x-nullable: true
config:
x-nullable: true
type: object
properties:
battV:
type: object
properties:
main:
type: string
li:
type: string
fwVer:
type: object
properties:
lock:
type: string
main:
type: string
mainBl:
type: string
credRdr:
type: string
credRdrBl:
type: string
ble:
type: string
wifi:
type: string
macAdr:
type: string
recoveryFwVer:
type: string
lockPrmtrs:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 52
type:
type: string
enum:
- strm
- office
- apt
- prvcy
relock:
type: integer
minimum: 0
maximum: 30
lockId:
type: integer
doorProp:
type: integer
minimum: 1
maximum: 255
ada:
type: integer
minimum: 1
maximum: 255
firstManIn:
type: integer
enum:
- 0
- 1
battFail:
type: string
enum:
- asIs
- safe
- sec
blinkIntLed:
type: string
enum:
- T
- F
rapidBlink:
type: string
enum:
- T
- F
dstEnable:
type: integer
enum:
- 0
- 1
dstStart:
type: string
x-constraint:
length: 4
x-convert:
case: lower
dstEnd:
type: string
x-constraint:
length: 4
x-convert:
case: lower
rtcTime:
type: string
x-constraint:
length: 14
wifiAlertEn:
type: string
enum:
- T
- F
wifiAlertSel:
type: array
items:
type: string
x-constraint:
length: 6
fwUrl:
type: string
maxLength: 64
fwDwnldTm:
type: string
x-constraint:
length: 14
fwImplTm:
type: string
x-constraint:
length: 14
dpsEn:
type: string
enum:
- T
- F
bleCredEn:
type: string
enum:
- T
- F
bleCredRng:
type: string
enum:
- short
- long
blePerf:
type: string
enum:
- norm
- max
invCrdAudEn:
type: string
enum:
- T
- F
wifiDwnldRtyTmIntv:
type: integer
minimum: 5
maximum: 1440
wifiDwnldRtyCnt:
type: integer
minimum: 1
maximum: 250
auditIDEn:
type: string
enum:
- T
- F
blkCnstr:
type: string
enum:
- T
- F
mdl:
type: string
lckMode:
type: string
lckSn:
type: string
mainSn:
type: string
hwVer:
type: string
daysInUse:
type: integer
mfgDt:
type: string
dbDwnldTm:
type: string
fwImpTm:
type: string
nxtDbVerTS:
type: string
hwCfg:
type: string
dbUpdateStatus:
type: integer
wtyAct:
type: string
x-constraint:
length: 14
x-alternatives:
- type: string
x-constraint:
length: 14
- type: string
enum:
- unknown
numCycles:
type: integer
rdrPrmtrs:
type: object
properties:
bprEn:
type: string
enum:
- T
- F
rdrSense:
type: string
enum:
- norm
- high
- max
proxConfHID:
type: string
enum:
- T
- F
proxConfGECASI:
type: string
enum:
- T
- F
proxConfGE4001:
type: string
enum:
- T
- F
proxConfGE4002:
type: string
enum:
- T
- F
proxConfAWID:
type: string
enum:
- T
- F
uid14443:
type: string
enum:
- T
- F
mi14443:
type: string
enum:
- T
- F
mip14443:
type: string
enum:
- T
- F
noc14443:
type: string
enum:
- T
- F
uid15693:
type: string
enum:
- T
- F
iClsUID40b:
type: string
enum:
- T
- F
iClsFrmt:
type: string
enum:
- disbld
- 64bCSN
daysInUse:
type: integer
sn:
type: string
hwVer:
type: string
mfgDt:
type: string
configCrdPrsntd:
type: string
enum:
- T
- F
customKeyPrsntd:
type: string
enum:
- T
- F
dvcProfile:
type: object
properties:
baseType:
type: string
ext:
type: array
items:
type: object
properties:
key:
type: string
value:
type: integer
enum:
- 1
- 0
status:
x-nullable: true
type: object
properties:
lockStatus:
type: object
properties:
currentLockState:
type: string
sensorStatus:
type: object
properties:
locked:
type: string
enum:
- T
- F
auxPosition:
type: string
enum:
- T
- F
alarmPosition:
type: string
enum:
- T
- F
lockClutched:
type: string
enum:
- T
- F
primaryBatteryStatus:
type: string
rtcBatteryStatus:
type: string
rtccStatus:
type: string
doorOpen:
type: string
enum:
- T
- F
ipbActive:
type: string
enum:
- T
- F
rexActive:
type: string
enum:
- T
- F
renActive:
type: string
enum:
- T
- F
relActive:
type: string
enum:
- T
- F
deadBoltExtended:
type: string
enum:
- T
- F
keyOverrideActive:
type: string
enum:
- T
- F
fdrActive:
type: string
enum:
- T
- F
tamperOpen:
type: string
enum:
- T
- F
magTamperDetected:
type: string
enum:
- T
- F
rdrTamperDetected:
type: string
enum:
- T
- F
ttl1Active:
type: string
enum:
- T
- F
ttl2Active:
type: string
enum:
- T
- F
bprActive:
type: string
# --- truncated at 32 KB (2730 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-credentials-api-openapi.yml