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
87 lines
2.6 KiB
YAML
87 lines
2.6 KiB
YAML
---
|
|
paths:
|
|
external-jwt-signers:
|
|
get:
|
|
summary: List Client Authentication External JWT
|
|
description: Retrieves a list of external JWT signers for authentication
|
|
tags:
|
|
- External JWT Signer
|
|
operationId: listExternalJwtSigners
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listClientExternalJwtSigners'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
responses:
|
|
listClientExternalJwtSigners:
|
|
description: A list of External JWT Signers
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listClientExternalJwtSignersEnvelope'
|
|
|
|
definitions:
|
|
listClientExternalJwtSignersEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/clientExternalJwtSignerList'
|
|
clientExternalJwtSignerList:
|
|
description: An array of External JWT Signers resources
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/clientExternalJwtSignerDetail'
|
|
clientExternalJwtSignerDetail:
|
|
description: A External JWT Signer resource
|
|
type: object
|
|
allOf:
|
|
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
|
|
- type: object
|
|
required:
|
|
- name
|
|
- externalAuthUrl
|
|
properties:
|
|
name:
|
|
type: string
|
|
example: 'MyApps Signer'
|
|
externalAuthUrl:
|
|
type: string
|
|
format: url
|
|
clientId:
|
|
type: string
|
|
x-nullable: true
|
|
scopes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
openIdConfigurationUrl:
|
|
type: string
|
|
audience:
|
|
type: string
|
|
x-nullable: true
|
|
targetToken:
|
|
$ref: "../shared/ext-jwt-signers.yml#/definitions/targetToken"
|
|
enrollToCertEnabled:
|
|
type: boolean
|
|
enrollToTokenEnabled:
|
|
type: boolean |