forked from OAI/OpenAPI-Specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsecurity-scheme-object-examples.yaml
More file actions
69 lines (69 loc) · 2.01 KB
/
security-scheme-object-examples.yaml
File metadata and controls
69 lines (69 loc) · 2.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
openapi: 3.3.0
info:
title: API
version: 1.0.0
security:
- basic: []
- apiKey: []
- JWT-bearer: []
- mutualTLS: []
- OAuth2:
- write:pets
- read:pets
components:
securitySchemes:
basic:
type: http
scheme: basic
apiKey:
type: apiKey
name: api-key
in: header
JWT-bearer:
type: http
scheme: bearer
bearerFormat: JWT
mutualTLS:
type: mutualTLS
description: Cert must be signed by example.com CA
OAuth2:
type: oauth2
oauth2MetadataUrl: https://example.com/api/oauth/metadata
flows:
authorizationCode:
authorizationUrl: https://example.com/api/oauth/dialog
refreshUrl: https://example.com/api/oauth/refresh
tokenUrl: https://example.com/api/oauth/token
scopes:
write:pets: modify pets in your account
read:pets: read your pets
password:
tokenUrl: https://example.com/api/oauth/token
scopes:
read:pets: read your pets
refreshUrl: https://example.com/api/oauth/refresh
clientCredentials:
tokenUrl: https://example.com/api/oauth/token
scopes:
read:pets: read your pets
refreshUrl: https://example.com/api/oauth/refresh
deviceAuthorization:
deviceAuthorizationUrl: https://example.com/api/oauth/device
tokenUrl: https://example.com/api/oauth/token
scopes:
read:pets: read your pets
refreshUrl: https://example.com/api/oauth/refresh
OAuth2Old:
deprecated: true
type: oauth2
flows:
implicit:
authorizationUrl: https://example.com/api/oauth/dialog
scopes:
read:pets: read your pets
refreshUrl: https://example.com/api/oauth/refresh
OpenIdConnect:
type: openIdConnect
openIdConnectUrl: https://example.com/api/oauth/openid
external:
$ref: 'https://example.com/api/openapi.json#/components/externalDocs/ThingExternalDocs'