mirror of
https://github.com/hanzozt/edge-api.git
synced 2026-10-30 14:44:05 +00:00
Andrew MartinezandGitHub
2a12985526
* for openziti/ziti#3356 add www-authenticate headers - adds www-authenticate headers to all responses - moves to swagger 0.33.1 - updates readme - updates version checking in powershell and bash
60 lines
1.9 KiB
YAML
60 lines
1.9 KiB
YAML
---
|
|
paths:
|
|
current-identity-edge-routers:
|
|
get:
|
|
summary: Return this list of Edge Routers the identity has access to
|
|
description: |
|
|
Lists the Edge Routers that the current identity has access to via policies. The data returned
|
|
includes their address and online status
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Current Identity
|
|
- Edge Router
|
|
operationId: getCurrentIdentityEdgeRouters
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listCurrentIdentityEdgeRouters'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
responses:
|
|
listCurrentIdentityEdgeRouters:
|
|
description: A list of edge routers
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listCurrentIdentityEdgeRoutersEnvelope'
|
|
|
|
definitions:
|
|
listCurrentIdentityEdgeRoutersEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/currentIdentityEdgeRouterList'
|
|
|
|
currentIdentityEdgeRouterList:
|
|
description: A list of edge router resources
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/currentIdentityEdgeRouterDetail'
|
|
currentIdentityEdgeRouterDetail:
|
|
description: A detail edge router resource
|
|
type: object
|
|
allOf:
|
|
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
|
|
- $ref: '../shared/edge-routers.yml#/definitions/commonEdgeRouterProperties' |