Skip to content

Commit 889a071

Browse files
matiasperrone-exomatiasperrone-exo
committed
deploy: c866717 
1 parent 1f0bbe3 commit 889a071

1 file changed

Lines changed: 88 additions & 121 deletions

File tree

‎openapi/pr-113/api-docs.json‎

Lines changed: 88 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,10 @@
9292
{
9393
"name": "response_type",
9494
"in": "query",
95-
"description": "OAuth2 response type",
95+
"description": "The OAuth 2.0 specification allows for registration of space-separated response_type parameter values. If a Response Type contains one of more space characters (%20), it is compared as a space-delimited list of values in which the order of values does not matter. Possible values are: code, token, id_token, otp, none. The \"none\" value cannot be used with any other response type value.",
9696
"required": true,
9797
"schema": {
98-
"type": "string",
99-
"enum": [
100-
"code",
101-
"token",
102-
"id_token",
103-
"code token",
104-
"code id_token",
105-
"token id_token",
106-
"code token id_token",
107-
"otp",
108-
"none"
109-
]
98+
"type": "string"
11099
}
111100
},
112101
{
@@ -121,7 +110,7 @@
121110
{
122111
"name": "redirect_uri",
123112
"in": "query",
124-
"description": "Redirect URI (must match a registered URI)",
113+
"description": "Redirect URI",
125114
"required": true,
126115
"schema": {
127116
"type": "string",
@@ -131,7 +120,7 @@
131120
{
132121
"name": "scope",
133122
"in": "query",
134-
"description": "Space-delimited scopes (include \"openid\" for OIDC)",
123+
"description": "Space-delimited scopes",
135124
"required": false,
136125
"schema": {
137126
"type": "string"
@@ -140,94 +129,53 @@
140129
{
141130
"name": "state",
142131
"in": "query",
143-
"description": "Opaque state parameter returned in the redirect",
144-
"required": false,
145-
"schema": {
146-
"type": "string"
147-
}
148-
},
149-
{
150-
"name": "nonce",
151-
"in": "query",
152-
"description": "Nonce for ID token replay protection (OIDC)",
132+
"description": "Opaque state parameter",
153133
"required": false,
154134
"schema": {
155135
"type": "string"
156136
}
157137
},
158138
{
159-
"name": "response_mode",
139+
"name": "approval_prompt",
160140
"in": "query",
161-
"description": "Response mode override",
141+
"description": "Indicates whether the user should be re-prompted for consent. The default is auto, so a given user should only see the consent page for a given set of scopes the first time through the sequence. If the value is force, then the user sees a consent page even if they previously gave consent to your application for a given set of scopes.",
162142
"required": false,
163143
"schema": {
164144
"type": "string",
165145
"enum": [
166-
"query",
167-
"fragment",
168-
"form_post",
169-
"direct"
146+
"auto",
147+
"force"
170148
]
171149
}
172150
},
173151
{
174-
"name": "prompt",
152+
"name": "access_type",
175153
"in": "query",
176-
"description": "Space-delimited user interaction prompts (OIDC)",
154+
"description": "Indicates whether your application needs to access an API when the user is not present at the browser. This parameter defaults to online. If your application needs to refresh access tokens when the user is not present at the browser, then use offline. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.",
177155
"required": false,
178156
"schema": {
179157
"type": "string",
180158
"enum": [
181-
"none",
182-
"login",
183-
"consent",
184-
"select_account"
159+
"online",
160+
"offline"
185161
]
186162
}
187163
},
188164
{
189-
"name": "login_hint",
190-
"in": "query",
191-
"description": "Hint about login identifier (OIDC)",
192-
"required": false,
193-
"schema": {
194-
"type": "string"
195-
}
196-
},
197-
{
198-
"name": "display",
165+
"name": "response_mode",
199166
"in": "query",
200-
"description": "UI display preference (OIDC)",
167+
"description": "OPTIONAL. Informs the Authorization Server of the mechanism to be used for returning Authorization Response parameters from the Authorization Endpoint. This use of this parameter is NOT RECOMMENDED with a value that specifies the same Response Mode as the default Response Mode for the Response Type used.\\nThe default Response Mode for the OAuth 2.0 code Response Type is the query encoding. For purposes of this specification, the default Response Mode for the OAuth 2.0 token Response Type is the fragment encoding.",
201168
"required": false,
202169
"schema": {
203170
"type": "string",
204171
"enum": [
205-
"page",
206-
"popup",
207-
"touch",
208-
"wap",
209-
"native"
172+
"query",
173+
"fragment",
174+
"form_post",
175+
"direct"
210176
]
211177
}
212178
},
213-
{
214-
"name": "max_age",
215-
"in": "query",
216-
"description": "Maximum authentication age in seconds (OIDC)",
217-
"required": false,
218-
"schema": {
219-
"type": "integer"
220-
}
221-
},
222-
{
223-
"name": "acr_values",
224-
"in": "query",
225-
"description": "Authentication context class reference values (OIDC)",
226-
"required": false,
227-
"schema": {
228-
"type": "string"
229-
}
230-
},
231179
{
232180
"name": "code_challenge",
233181
"in": "query",
@@ -240,7 +188,7 @@
240188
{
241189
"name": "code_challenge_method",
242190
"in": "query",
243-
"description": "PKCE challenge method",
191+
"description": "Optional. PKCE challenge method",
244192
"required": false,
245193
"schema": {
246194
"type": "string",
@@ -251,38 +199,28 @@
251199
}
252200
},
253201
{
254-
"name": "id_token_hint",
255-
"in": "query",
256-
"description": "Previously issued ID token hint (OIDC)",
257-
"required": false,
258-
"schema": {
259-
"type": "string"
260-
}
261-
},
262-
{
263-
"name": "approval_prompt",
202+
"name": "display",
264203
"in": "query",
265-
"description": "Consent handling",
204+
"description": "UI display preference (OIDC)",
266205
"required": false,
267206
"schema": {
268207
"type": "string",
269208
"enum": [
270-
"auto",
271-
"force"
209+
"page",
210+
"popup",
211+
"touch",
212+
"wap",
213+
"native"
272214
]
273215
}
274216
},
275217
{
276-
"name": "access_type",
218+
"name": "tenant",
277219
"in": "query",
278-
"description": "Token refresh behavior",
220+
"description": "Tenant identifier",
279221
"required": false,
280222
"schema": {
281-
"type": "string",
282-
"enum": [
283-
"online",
284-
"offline"
285-
]
223+
"type": "string"
286224
}
287225
}
288226
],
@@ -496,6 +434,9 @@
496434
}
497435
},
498436
"security": [
437+
{
438+
"OAuth2ProviderClientBasic": []
439+
},
499440
{
500441
"OAuth2ProviderSecurity": []
501442
}
@@ -625,7 +566,7 @@
625566
"OAuth2 / OpenID Connect"
626567
],
627568
"summary": "OpenID Connect Discovery Endpoint",
628-
"description": "Returns the OpenID Provider Configuration document per OpenID Connect Discovery 1.0. Also available at /oauth2/.well-known/openid-configuration.",
569+
"description": "Returns the OpenID Provider Configuration document per OpenID Connect Discovery 1.0.",
629570
"operationId": "oauth2Discovery",
630571
"responses": {
631572
"200": {
@@ -1051,6 +992,10 @@
1051992
"OAuth2TokenResponse": {
1052993
"title": "OAuth2 Token Response",
1053994
"description": "Successful token response per RFC 6749 §5.1",
995+
"required": [
996+
"access_token",
997+
"token_type"
998+
],
1054999
"properties": {
10551000
"access_token": {
10561001
"description": "The access token issued by the authorization server",
@@ -1105,6 +1050,9 @@
11051050
"OAuth2IntrospectionResponse": {
11061051
"title": "OAuth2 Token Introspection Response",
11071052
"description": "Token introspection response per RFC 7662",
1053+
"required": [
1054+
"active"
1055+
],
11081056
"properties": {
11091057
"active": {
11101058
"description": "Whether the token is active",
@@ -1223,6 +1171,9 @@
12231171
"JWKSResponse": {
12241172
"title": "JSON Web Key Set",
12251173
"description": "JWK Set document per RFC 7517",
1174+
"required": [
1175+
"keys"
1176+
],
12261177
"properties": {
12271178
"keys": {
12281179
"description": "Array of JSON Web Keys",
@@ -1267,6 +1218,15 @@
12671218
"OpenIDDiscoveryResponse": {
12681219
"title": "OpenID Connect Discovery Document",
12691220
"description": "OpenID Provider Configuration per OpenID Connect Discovery 1.0",
1221+
"required": [
1222+
"issuer",
1223+
"authorization_endpoint",
1224+
"token_endpoint",
1225+
"jwks_uri",
1226+
"response_types_supported",
1227+
"subject_types_supported",
1228+
"id_token_signing_alg_values_supported"
1229+
],
12701230
"properties": {
12711231
"issuer": {
12721232
"description": "Issuer identifier URL",
@@ -1365,19 +1325,8 @@
13651325
],
13661326
"properties": {
13671327
"response_type": {
1368-
"description": "OAuth2 response type",
1369-
"type": "string",
1370-
"enum": [
1371-
"code",
1372-
"token",
1373-
"id_token",
1374-
"code token",
1375-
"code id_token",
1376-
"token id_token",
1377-
"code token id_token",
1378-
"otp",
1379-
"none"
1380-
]
1328+
"description": "The OAuth 2.0 specification allows for registration of space-separated response_type parameter values. If a Response Type contains one of more space characters (%20), it is compared as a space-delimited list of values in which the order of values does not matter. Possible values are: code, token, id_token, otp, none. The \"none\" value cannot be used with any other response type value.",
1329+
"type": "string"
13811330
},
13821331
"client_id": {
13831332
"description": "OAuth2 client identifier",
@@ -1396,12 +1345,24 @@
13961345
"description": "Opaque state parameter",
13971346
"type": "string"
13981347
},
1399-
"nonce": {
1400-
"description": "Nonce for ID token replay protection",
1401-
"type": "string"
1348+
"approval_prompt": {
1349+
"description": "Indicates whether the user should be re-prompted for consent. The default is auto, so a given user should only see the consent page for a given set of scopes the first time through the sequence. If the value is force, then the user sees a consent page even if they previously gave consent to your application for a given set of scopes.",
1350+
"type": "string",
1351+
"enum": [
1352+
"auto",
1353+
"force"
1354+
]
1355+
},
1356+
"access_type": {
1357+
"description": "Indicates whether your application needs to access an API when the user is not present at the browser. This parameter defaults to online. If your application needs to refresh access tokens when the user is not present at the browser, then use offline. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.",
1358+
"type": "string",
1359+
"enum": [
1360+
"online",
1361+
"offline"
1362+
]
14021363
},
14031364
"response_mode": {
1404-
"description": "Response mode override",
1365+
"description": "OPTIONAL. Informs the Authorization Server of the mechanism to be used for returning Authorization Response parameters from the Authorization Endpoint. This use of this parameter is NOT RECOMMENDED with a value that specifies the same Response Mode as the default Response Mode for the Response Type used.\\nThe default Response Mode for the OAuth 2.0 code Response Type is the query encoding. For purposes of this specification, the default Response Mode for the OAuth 2.0 token Response Type is the fragment encoding.",
14051366
"type": "string",
14061367
"enum": [
14071368
"query",
@@ -1410,25 +1371,32 @@
14101371
"direct"
14111372
]
14121373
},
1413-
"prompt": {
1414-
"description": "User interaction prompts",
1415-
"type": "string"
1416-
},
1417-
"login_hint": {
1418-
"description": "Login identifier hint",
1419-
"type": "string"
1420-
},
14211374
"code_challenge": {
14221375
"description": "PKCE code challenge",
14231376
"type": "string"
14241377
},
14251378
"code_challenge_method": {
1426-
"description": "PKCE challenge method",
1379+
"description": "Optional. PKCE challenge method",
14271380
"type": "string",
14281381
"enum": [
14291382
"plain",
14301383
"S256"
14311384
]
1385+
},
1386+
"display": {
1387+
"description": "UI display preference (OIDC)",
1388+
"type": "string",
1389+
"enum": [
1390+
"page",
1391+
"popup",
1392+
"touch",
1393+
"wap",
1394+
"native"
1395+
]
1396+
},
1397+
"tenant": {
1398+
"description": "Tenant identifier",
1399+
"type": "string"
14321400
}
14331401
},
14341402
"type": "object"
@@ -1542,8 +1510,7 @@
15421510
"type": "string",
15431511
"enum": [
15441512
"sms",
1545-
"email",
1546-
"inline"
1513+
"email"
15471514
]
15481515
},
15491516
"send": {

0 commit comments

Comments
 (0)