mirror of
https://github.com/openziti/ziti.git
synced 2026-10-12 15:28:05 +00:00
Andrew Martinez
b562fb5c07
- 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)
92 lines
3.3 KiB
YAML
92 lines
3.3 KiB
YAML
---
|
|
|
|
paths:
|
|
current-identity-authenticators:
|
|
get:
|
|
summary: List authenticators for the current identity
|
|
description: Retrieves a list of authenticators assigned to the current API session's identity; supports filtering, sorting, and pagination.
|
|
security:
|
|
- ztSession: [ ]
|
|
tags:
|
|
- Current API Session
|
|
operationId: listCurrentIdentityAuthenticators
|
|
parameters:
|
|
- $ref: 'parameters.yml#/limit'
|
|
- $ref: 'parameters.yml#/offset'
|
|
- $ref: 'parameters.yml#/filter'
|
|
responses:
|
|
'200':
|
|
$ref: 'authenticators.yml#/responses/listAuthenticators'
|
|
'401':
|
|
$ref: 'standard-responses.yml#/responses/unauthorizedResponse'
|
|
current-identity-authenticators-id:
|
|
parameters:
|
|
- $ref: 'parameters.yml#/id'
|
|
get:
|
|
summary: Retrieve an authenticator for the current identity
|
|
description: Retrieves a single authenticator by id. Will only show authenticators assigned to the API session's identity.
|
|
security:
|
|
- ztSession: [ ]
|
|
tags:
|
|
- Current API Session
|
|
operationId: detailCurrentIdentityAuthenticator
|
|
responses:
|
|
'200':
|
|
$ref: 'authenticators.yml#/responses/detailAuthenticator'
|
|
'404':
|
|
$ref: 'standard-responses.yml#/responses/notFoundResponse'
|
|
'401':
|
|
$ref: 'standard-responses.yml#/responses/unauthorizedResponse'
|
|
put:
|
|
summary: Update all fields on an authenticator of this identity
|
|
description: |
|
|
Update all fields on an authenticator by id. Will only update authenticators assigned to the API session's
|
|
identity.
|
|
security:
|
|
- ztSession: [ ]
|
|
tags:
|
|
- Current API Session
|
|
operationId: updateCurrentIdentityAuthenticator
|
|
parameters:
|
|
- name: authenticator
|
|
in: body
|
|
required: true
|
|
description: 'An authenticator put object'
|
|
schema:
|
|
$ref: 'authenticators.yml#/definitions/authenticatorUpdateWithCurrent'
|
|
responses:
|
|
'200':
|
|
$ref: 'standard-responses.yml#/responses/updateResponse'
|
|
'400':
|
|
$ref: 'standard-responses.yml#/responses/badRequestResponse'
|
|
'404':
|
|
$ref: 'standard-responses.yml#/responses/notFoundResponse'
|
|
'401':
|
|
$ref: 'standard-responses.yml#/responses/unauthorizedResponse'
|
|
patch:
|
|
summary: Update the supplied fields on an authenticator of this identity
|
|
description: |
|
|
Update the supplied fields on an authenticator by id. Will only update authenticators assigned to the API
|
|
session's identity.
|
|
security:
|
|
- ztSession: [ ]
|
|
tags:
|
|
- Current API Session
|
|
operationId: patchCurrentIdentityAuthenticator
|
|
parameters:
|
|
- name: authenticator
|
|
in: body
|
|
required: true
|
|
description: An authenticator patch object
|
|
schema:
|
|
$ref: 'authenticators.yml#/definitions/authenticatorPatchWithCurrent'
|
|
responses:
|
|
'200':
|
|
$ref: 'standard-responses.yml#/responses/patchResponse'
|
|
'400':
|
|
$ref: 'standard-responses.yml#/responses/badRequestResponse'
|
|
'404':
|
|
$ref: 'standard-responses.yml#/responses/notFoundResponse'
|
|
'401':
|
|
$ref: 'standard-responses.yml#/responses/unauthorizedResponse'
|