Files
ziti/specs/source/shared/identities.yml
T
Andrew Martinez b562fb5c07 splits API specs into composible modules
- splits Open API 2.0 (swagger) into client/management APIs
- uses go-swaggers flatten capabilities
- uses newer version of go-swagger (v0.27.0)
- introduces /edge/client/v1, /edge/management/v1
- non-prefixed URLs default to /edge/client/v1
- splits some shared management/client API handlers
- renames some REST models to "client" instead of "limited"
- passes all apitests, fails dataflow upd test (main fails this as well)
- updates generate rest script for powershell
- todo: test generate rest script for bash
- todo: use xweb (different branch)
2021-05-04 11:30:32 -04:00

124 lines
3.2 KiB
YAML

---
definitions:
identityList:
description: A list of identities
type: array
items:
$ref: '#/definitions/identityDetail'
identityDetail:
description: Detail of a specific identity
type: object
allOf:
- $ref: 'base-entity.yml#/definitions/baseEntity'
- type: object
required:
- name
- type
- typeId
- isDefaultAdmin
- isAdmin
- authenticators
- enrollment
- envInfo
- sdkInfo
- roleAttributes
- hasEdgeRouterConnection
- hasApiSession
- isMfaEnabled
- serviceHostingPrecedences
- serviceHostingCosts
- defaultHostingCost
properties:
name:
type: string
type:
$ref: 'base-entity.yml#/definitions/entityRef'
typeId:
type: string
isDefaultAdmin:
type: boolean
isAdmin:
type: boolean
authenticators:
$ref: '#/definitions/identityAuthenticators'
enrollment:
$ref: '#/definitions/identityEnrollments'
envInfo:
$ref: 'authenticate.yml#/definitions/envInfo'
sdkInfo:
$ref: 'authenticate.yml#/definitions/sdkInfo'
roleAttributes:
$ref: 'base-entity.yml#/definitions/attributes'
hasEdgeRouterConnection:
type: boolean
hasApiSession:
type: boolean
isMfaEnabled:
type: boolean
defaultHostingPrecedence:
$ref: 'terminators.yml#/definitions/terminatorPrecedence'
defaultHostingCost:
$ref: 'terminators.yml#/definitions/terminatorCost'
serviceHostingPrecedences:
$ref: 'terminators.yml#/definitions/terminatorPrecedenceMap'
serviceHostingCosts:
$ref: 'terminators.yml#/definitions/terminatorCostMap'
appData:
$ref: 'base-entity.yml#/definitions/tags'
identityAuthenticators:
type: object
properties:
updb:
properties:
username:
type: string
type: object
cert:
type: object
properties:
fingerprint:
type: string
identityEnrollments:
type: object
properties:
updb:
type: object
properties:
id:
type: string
token:
type: string
jwt:
type: string
expiresAt:
type: string
format: date-time
ott:
type: object
properties:
id:
type: string
token:
type: string
jwt:
type: string
expiresAt:
type: string
format: date-time
ottca:
type: object
properties:
id:
type: string
token:
type: string
jwt:
type: string
caId:
type: string
ca:
$ref: 'base-entity.yml#/definitions/entityRef'
expiresAt:
type: string
format: date-time