forked from serverlessworkflow/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathauth.json
218 lines (218 loc) · 6.5 KB
/
auth.json
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
{
"$id": "https://serverlessworkflow.io/schemas/0.7/auth.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Serverless Workflow specification - auth schema",
"type": "object",
"auth": {
"oneOf": [
{
"type": "string",
"format": "uri",
"description": "URI to a resource containing auth definitions (json or yaml)"
},
{
"type": "array",
"description": "Workflow auth definitions",
"items": {
"type": "object",
"$ref": "#/definitions/authdef"
},
"additionalItems": false,
"minItems": 1
}
]
},
"required": [
"auth"
],
"definitions": {
"authdef": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique auth definition name",
"minLength": 1
},
"scheme": {
"type": "string",
"description": "Defines the auth type",
"enum": [
"basic",
"bearer",
"oauth2"
],
"default": "basic"
},
"properties": {
"oneOf": [
{
"type": "string",
"description": "Expression referencing a workflow secret that contains all needed auth info"
},
{
"title": "Basic Auth Info",
"$ref": "#/definitions/basicpropsdef"
},
{
"title": "Bearer Auth Info State",
"$ref": "#/definitions/beareripropsdef"
},
{
"title": "OAuth2 Info",
"$ref": "#/definitions/oauth2propsdef"
}
]
}
},
"required": [
"name",
"properties"
]
},
"basicpropsdef": {
"oneOf": [
{
"type": "string",
"description": "Expression referencing a workflow secret that contains all needed basic auth info"
},
{
"type": "object",
"description": "Basic auth information",
"properties": {
"username": {
"type": "string",
"description": "String or a workflow expression. Contains the user name",
"minLength": 1
},
"password": {
"type": "string",
"description": "String or a workflow expression. Contains the user password",
"minLength": 1
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"required": [
"username",
"password"
],
"additionalProperties": false
}
]
},
"beareripropsdef": {
"oneOf": [
{
"type": "string",
"description": "Expression referencing a workflow secret that contains all needed bearer auth info"
},
{
"type": "object",
"description": "Bearer auth information",
"properties": {
"token": {
"type": "string",
"description": "String or a workflow expression. Contains the token",
"minLength": 1
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"required": [
"token"
],
"additionalProperties": false
}
]
},
"oauth2propsdef": {
"oneOf": [
{
"type": "string",
"description": "Expression referencing a workflow secret that contains all needed OAuth2 auth info"
},
{
"type": "object",
"description": "OAuth2 information",
"properties": {
"authority": {
"type": "string",
"description": "String or a workflow expression. Contains the authority information",
"minLength": 1
},
"grantType": {
"type": "string",
"description": "Defines the grant type",
"enum": [
"password",
"clientCredentials",
"tokenExchange"
],
"additionalItems": false
},
"clientId": {
"type": "string",
"description": "String or a workflow expression. Contains the client identifier",
"minLength": 1
},
"clientSecret": {
"type": "string",
"description": "Workflow secret or a workflow expression. Contains the client secret",
"minLength": 1
},
"scopes": {
"type": "array",
"description": "Array containing strings or workflow expressions. Contains the OAuth2 scopes",
"items": {
"type": "string"
},
"minItems": 1,
"additionalItems": false
},
"username": {
"type": "string",
"description": "String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'",
"minLength": 1
},
"password": {
"type": "string",
"description": "String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'",
"minLength": 1
},
"audiences": {
"type": "array",
"description": "Array containing strings or workflow expressions. Contains the OAuth2 audiences",
"items": {
"type": "string"
},
"minItems": 1,
"additionalItems": false
},
"subjectToken": {
"type": "string",
"description": "String or a workflow expression. Contains the subject token",
"minLength": 1
},
"requestedSubject": {
"type": "string",
"description": "String or a workflow expression. Contains the requested subject",
"minLength": 1
},
"requestedIssuer": {
"type": "string",
"description": "String or a workflow expression. Contains the requested issuer",
"minLength": 1
},
"metadata": {
"$ref": "common.json#/definitions/metadata"
}
},
"required": ["grantType", "clientId"]
}
]
}
}
}