Documentation
Documentation
https://openpath.readme.io
APIReference
https://openpath.readme.io/reference
GettingStarted
https://openpath.readme.io/docs/basics-to-start
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: auth
description: Authentication and Login
paths:
/auth/accessTokens/{token}:
get:
summary: Describe an access token's associated identity and scopes
operationId: describeAccessToken
description: '__Endpoint name__: describeAccessToken'
parameters:
- type: string
name: token
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- auth
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
identityId:
type: number
identity:
type: object
properties:
id:
type: number
namespace:
type: object
properties:
id:
type: number
nickname:
type: string
required:
- id
required:
- id
token:
type: string
tokenScopeList:
type: array
items:
type: object
properties:
org:
type: object
properties:
id:
type: number
x-nullable: true
name:
type: string
x-nullable: true
opal:
type: string
x-nullable: true
packagePlans:
type: array
items:
type: object
properties:
id:
type: number
package:
type: object
properties:
id:
type: number
name:
type: string
packageFeatures:
type: array
items:
type: object
properties:
id:
type: number
config:
x-nullable: true
type: object
feature:
type: object
properties:
id:
type: number
name:
type: string
code:
type: string
required:
- id
required:
- id
required:
- id
isSelected:
type: boolean
required:
- id
parentOrg:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
orgNativeApps:
type: array
items:
type: object
properties:
id:
type: integer
failureReason:
type: string
x-nullable: true
url:
type: string
x-nullable: true
status:
type: string
enum:
- A
- E
- I
- P
- S
config:
x-nullable: true
type: object
nativeApp:
type: object
properties:
id:
type: integer
url:
type: string
x-nullable: true
required:
- id
required:
- id
- nativeApp
isUnified:
type: boolean
required:
- id
user:
type: object
properties:
id:
type: number
x-nullable: true
opal:
type: string
x-nullable: true
needsMFACredential:
type: boolean
required:
- id
scope:
x-nullable: true
type: array
items:
type: string
policySection:
type: array
items:
type: object
properties:
id:
type: number
nativeAppId:
type: number
x-nullable: true
site:
type: array
items:
type: object
properties:
id:
type: number
required:
- id
role:
type: object
properties:
id:
type: number
required:
- id
required:
- id
scopeWithContext:
type: array
items:
type: object
properties:
context:
type: array
items:
type: object
properties:
mfa:
type: boolean
needsMFACredential:
type: boolean
fsa:
type: boolean
scope:
type: array
items:
type: string
createdAt:
type: string
format: date
expiresAt:
type: string
format: date
x-nullable: true
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
/auth/login:
post:
summary: Login
operationId: login
description: '__Endpoint name__: login'
parameters:
- in: body
name: body
schema:
type: object
properties:
namespaceId:
type: integer
namespaceNickname:
type: string
minLength: 1
maxLength: 255
email:
type: string
x-format:
email: true
x-convert:
trim: true
password:
type: string
mfa:
type: object
properties:
totpCode:
type: string
forMobileLogin:
type: boolean
required:
- email
- password
consumes:
- application/json
produces:
- application/json
tags:
- auth
responses:
'201':
schema:
type: object
properties:
data:
type: object
properties:
identityId:
type: number
identity:
type: object
properties:
id:
type: number
namespace:
type: object
properties:
id:
type: number
nickname:
type: string
required:
- id
required:
- id
token:
type: string
tokenScopeList:
type: array
items:
type: object
properties:
org:
type: object
properties:
id:
type: number
x-nullable: true
name:
type: string
x-nullable: true
opal:
type: string
x-nullable: true
packagePlans:
type: array
items:
type: object
properties:
id:
type: number
package:
type: object
properties:
id:
type: number
name:
type: string
packageFeatures:
type: array
items:
type: object
properties:
id:
type: number
config:
x-nullable: true
type: object
feature:
type: object
properties:
id:
type: number
name:
type: string
code:
type: string
required:
- id
required:
- id
required:
- id
isSelected:
type: boolean
required:
- id
parentOrg:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
orgNativeApps:
type: array
items:
type: object
properties:
id:
type: integer
failureReason:
type: string
x-nullable: true
url:
type: string
x-nullable: true
status:
type: string
enum:
- A
- E
- I
- P
- S
config:
x-nullable: true
type: object
nativeApp:
type: object
properties:
id:
type: integer
url:
type: string
x-nullable: true
required:
- id
required:
- id
- nativeApp
isUnified:
type: boolean
required:
- id
user:
type: object
properties:
id:
type: number
x-nullable: true
opal:
type: string
x-nullable: true
needsMFACredential:
type: boolean
required:
- id
scope:
x-nullable: true
type: array
items:
type: string
policySection:
type: array
items:
type: object
properties:
id:
type: number
nativeAppId:
type: number
x-nullable: true
site:
type: array
items:
type: object
properties:
id:
type: number
required:
- id
role:
type: object
properties:
id:
type: number
required:
- id
required:
- id
scopeWithContext:
type: array
items:
type: object
properties:
context:
type: array
items:
type: object
properties:
mfa:
type: boolean
needsMFACredential:
type: boolean
fsa:
type: boolean
scope:
type: array
items:
type: string
createdAt:
type: string
format: date
expiresAt:
type: string
format: date
x-nullable: true
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: Created
/auth/loginAll:
post:
summary: Login all successful matches for email/password
operationId: loginAll
description: '__Endpoint name__: loginAll'
parameters:
- in: body
name: body
schema:
type: object
properties:
email:
type: string
x-format:
email: true
x-convert:
trim: true
password:
type: string
mfa:
type: object
properties:
totpCode:
type: string
forMobileLogin:
type: boolean
required:
- email
- password
consumes:
- application/json
produces:
- application/json
tags:
- auth
responses:
'201':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
identityId:
type: number
identity:
type: object
properties:
id:
type: number
namespace:
type: object
properties:
id:
type: number
nickname:
type: string
required:
- id
required:
- id
token:
type: string
tokenScopeList:
type: array
items:
type: object
properties:
org:
type: object
properties:
id:
type: number
x-nullable: true
name:
type: string
x-nullable: true
opal:
type: string
x-nullable: true
packagePlans:
type: array
items:
type: object
properties:
id:
type: number
package:
type: object
properties:
id:
type: number
name:
type: string
packageFeatures:
type: array
items:
type: object
properties:
id:
type: number
config:
x-nullable: true
type: object
feature:
type: object
properties:
id:
type: number
name:
type: string
code:
type: string
required:
- id
required:
- id
required:
- id
isSelected:
type: boolean
required:
- id
parentOrg:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
orgNativeApps:
type: array
items:
type: object
properties:
id:
type: integer
failureReason:
type: string
x-nullable: true
url:
type: string
x-nullable: true
status:
type: string
enum:
- A
- E
- I
- P
- S
config:
x-nullable: true
type: object
nativeApp:
type: object
properties:
id:
type: integer
url:
type: string
x-nullable: true
required:
- id
required:
- id
- nativeApp
isUnified:
type: boolean
required:
- id
user:
type: object
properties:
id:
type: number
x-nullable: true
opal:
type: string
x-nullable: true
needsMFACredential:
type: boolean
required:
- id
scope:
x-nullable: true
type: array
items:
type: string
policySection:
type: array
items:
type: object
properties:
id:
type: number
nativeAppId:
type: number
x-nullable: true
site:
type: array
items:
type: object
properties:
id:
type: number
required:
- id
role:
type: object
properties:
id:
type: number
required:
- id
required:
- id
scopeWithContext:
type: array
items:
type: object
properties:
context:
type: array
items:
type: object
properties:
mfa:
type: boolean
needsMFACredential:
type: boolean
fsa:
type: boolean
scope:
type: array
items:
type: string
createdAt:
type: string
format: date
expiresAt:
type: string
format: date
x-nullable: true
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: C
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-auth-api-openapi.yml