Skip to content

Commit 838b083

Browse files
lyleschemmerlinglyleschemmerling
authored
Merge pull request #83 from FusionAuth/lyle/ENG-3375/introspect-and-libs
Lyle/eng 3375/introspect and libs
2 parents 627daa1 + 0846909 commit 838b083

1 file changed

Lines changed: 235 additions & 8 deletions

File tree

‎openapi.yaml‎

Lines changed: 235 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ components:
9999
userId:
100100
type: string
101101
format: uuid
102+
AccessTokenIntrospectRequest:
103+
description: The request object for introspecting an access token.
104+
type: object
105+
properties:
106+
client_id:
107+
type: string
108+
tenantId:
109+
type: string
110+
token:
111+
type: string
102112
ActionData:
103113
type: object
104114
properties:
@@ -1161,6 +1171,30 @@ components:
11611171
- Required
11621172
- NotRequired
11631173
- NotRequiredWhenUsingPKCE
1174+
ClientCredentialsAccessTokenIntrospectRequest:
1175+
description: Contains the parameters used to introspect an access token that
1176+
was obtained via the client credentials grant.
1177+
type: object
1178+
properties:
1179+
tenantId:
1180+
type: string
1181+
token:
1182+
type: string
1183+
ClientCredentialsGrantRequest:
1184+
description: The request object to make a Client Credentials grant request to
1185+
obtain an access token.
1186+
type: object
1187+
properties:
1188+
client_id:
1189+
type: string
1190+
client_secret:
1191+
type: string
1192+
grant_type:
1193+
type: string
1194+
scope:
1195+
type: string
1196+
tenantId:
1197+
type: string
11641198
ConnectorLambdaConfiguration:
11651199
type: object
11661200
properties:
@@ -1389,6 +1423,21 @@ components:
13891423
type: integer
13901424
enabled:
13911425
type: boolean
1426+
DeviceApprovalRequest:
1427+
description: The request object to approve a device grant.
1428+
type: object
1429+
properties:
1430+
client_id:
1431+
type: string
1432+
client_secret:
1433+
type: string
1434+
tenantId:
1435+
type: string
1436+
format: uuid
1437+
token:
1438+
type: string
1439+
user_code:
1440+
type: string
13921441
DeviceApprovalResponse:
13931442
description: ''
13941443
type: object
@@ -1405,6 +1454,19 @@ components:
14051454
userId:
14061455
type: string
14071456
format: uuid
1457+
DeviceAuthorizationRequest:
1458+
description: ''
1459+
type: object
1460+
properties:
1461+
client_id:
1462+
type: string
1463+
client_secret:
1464+
type: string
1465+
scope:
1466+
type: string
1467+
tenantId:
1468+
type: string
1469+
format: uuid
14081470
DeviceInfo:
14091471
description: ''
14101472
type: object
@@ -5103,6 +5165,44 @@ components:
51035165
enum:
51045166
- FirstParty
51055167
- ThirdParty
5168+
OAuthCodeAccessTokenRequest:
5169+
description: The request object for exchanging an OAuth authorization code for
5170+
an access token.
5171+
type: object
5172+
properties:
5173+
client_id:
5174+
type: string
5175+
client_secret:
5176+
type: string
5177+
code:
5178+
type: string
5179+
grant_type:
5180+
type: string
5181+
redirect_uri:
5182+
type: string
5183+
tenantId:
5184+
type: string
5185+
OAuthCodePKCEAccessTokenRequest:
5186+
description: The request object to make a request to the Token endpoint to exchange
5187+
the authorization code returned from the Authorize endpoint and a code_verifier
5188+
for an access token.
5189+
type: object
5190+
properties:
5191+
client_id:
5192+
type: string
5193+
client_secret:
5194+
type: string
5195+
code:
5196+
type: string
5197+
code_verifier:
5198+
type: string
5199+
grant_type:
5200+
type: string
5201+
redirect_uri:
5202+
type: string
5203+
tenantId:
5204+
type: string
5205+
format: uuid
51065206
OAuthConfigurationResponse:
51075207
description: ''
51085208
type: object
@@ -5912,6 +6012,25 @@ components:
59126012
userId:
59136013
type: string
59146014
format: uuid
6015+
RefreshTokenAccessTokenRequest:
6016+
description: The request object to exchange a Refresh Token for an Access Token.
6017+
type: object
6018+
properties:
6019+
client_id:
6020+
type: string
6021+
client_secret:
6022+
type: string
6023+
grant_type:
6024+
type: string
6025+
refresh_token:
6026+
type: string
6027+
scope:
6028+
type: string
6029+
tenantId:
6030+
type: string
6031+
format: uuid
6032+
user_code:
6033+
type: string
59156034
RefreshTokenExpirationPolicy:
59166035
description: ''
59176036
type: string
@@ -6145,6 +6264,30 @@ components:
61456264
- discouraged
61466265
- preferred
61476266
- required
6267+
RetrieveUserCodeRequest:
6268+
description: The request object for retrieving a user code that is part of an
6269+
in-progress Device Authorization Grant.
6270+
type: object
6271+
properties:
6272+
client_id:
6273+
type: string
6274+
client_secret:
6275+
type: string
6276+
tenantId:
6277+
type: string
6278+
format: uuid
6279+
user_code:
6280+
type: string
6281+
RetrieveUserCodeUsingAPIKeyRequest:
6282+
description: The request object for retrieving a user code that is part of an
6283+
in-progress Device Authorization Grant using an API key
6284+
type: object
6285+
properties:
6286+
tenantId:
6287+
type: string
6288+
format: uuid
6289+
user_code:
6290+
type: string
61486291
SAMLLogoutBehavior:
61496292
type: string
61506293
enum:
@@ -8463,6 +8606,27 @@ components:
84638606
properties:
84648607
user:
84658608
"$ref": "#/components/schemas/User"
8609+
UserCredentialsAccessTokenRequest:
8610+
description: The request object for exchanging user credentials (username and
8611+
password) for an access token.
8612+
type: object
8613+
properties:
8614+
client_id:
8615+
type: string
8616+
client_secret:
8617+
type: string
8618+
grant_type:
8619+
type: string
8620+
password:
8621+
type: string
8622+
scope:
8623+
type: string
8624+
tenantId:
8625+
type: string
8626+
user_code:
8627+
type: string
8628+
username:
8629+
type: string
84668630
UserDeactivateEvent:
84678631
description: Models the User Deactivate Event.
84688632
type: object
@@ -9053,6 +9217,18 @@ components:
90539217
format: uuid
90549218
enabled:
90559219
type: boolean
9220+
ValidateDeviceRequest:
9221+
description: The request object for validating an end-user provided user_code
9222+
from the user-interaction of the Device Authorization Grant
9223+
type: object
9224+
properties:
9225+
client_id:
9226+
type: string
9227+
tenantId:
9228+
type: string
9229+
format: uuid
9230+
user_code:
9231+
type: string
90569232
ValidateResponse:
90579233
description: ''
90589234
type: object
@@ -18417,8 +18593,8 @@ paths:
1841718593
"$ref": "#/components/schemas/Errors"
1841818594
"/oauth2/device/approve":
1841918595
post:
18420-
description: Approve a device grant.
18421-
operationId: approveDeviceWithId
18596+
description: Approve a device grant. OR Approve a device grant.
18597+
operationId: createDeviceApprove
1842218598
parameters: []
1842318599
responses:
1842418600
'200':
@@ -18448,13 +18624,30 @@ paths:
1844818624
description: Success
1844918625
default:
1845018626
description: Error
18627+
post:
18628+
description: Retrieve a user_code that is part of an in-progress Device Authorization
18629+
Grant. This API is useful if you want to build your own login workflow to
18630+
complete a device grant. OR Retrieve a user_code that is part of an in-progress
18631+
Device Authorization Grant. This API is useful if you want to build your
18632+
own login workflow to complete a device grant. This request will require
18633+
an API key.
18634+
operationId: createDeviceUserCode
18635+
parameters: []
18636+
responses:
18637+
'200':
18638+
description: Success
18639+
default:
18640+
description: Error
1845118641
"/oauth2/device/validate":
1845218642
get:
1845318643
description: Validates the end-user provided user_code from the user-interaction
18644+
of the Device Authorization Grant. If you build your own activation form you
18645+
should validate the user provided code prior to beginning the Authorization
18646+
grant. OR Validates the end-user provided user_code from the user-interaction
1845418647
of the Device Authorization Grant. If you build your own activation form you
1845518648
should validate the user provided code prior to beginning the Authorization
1845618649
grant.
18457-
operationId: validateDeviceWithId
18650+
operationId: retrieveDeviceValidate
1845818651
parameters:
1845918652
- name: user_code
1846018653
in: query
@@ -18471,12 +18664,34 @@ paths:
1847118664
description: Success
1847218665
default:
1847318666
description: Error
18667+
"/oauth2/device_authorize":
18668+
post:
18669+
description: Start the Device Authorization flow using a request body OR Start
18670+
the Device Authorization flow using form-encoded parameters
18671+
operationId: createDevice_authorize
18672+
parameters: []
18673+
responses:
18674+
'200':
18675+
description: Success
18676+
content:
18677+
application/json:
18678+
schema:
18679+
"$ref": "#/components/schemas/DeviceResponse"
18680+
default:
18681+
description: Error
18682+
content:
18683+
application/json:
18684+
schema:
18685+
"$ref": "#/components/schemas/OAuthError"
1847418686
"/oauth2/introspect":
1847518687
post:
1847618688
description: Inspect an access token issued as the result of the Client Credentials
18689+
Grant. OR Inspect an access token issued as the result of the Client Credentials
1847718690
Grant. OR Inspect an access token issued as the result of the User based grant
1847818691
such as the Authorization Code Grant, Implicit Grant, the User Credentials
18479-
Grant or the Refresh Grant.
18692+
Grant or the Refresh Grant. OR Inspect an access token issued as the result
18693+
of the User based grant such as the Authorization Code Grant, Implicit Grant,
18694+
the User Credentials Grant or the Refresh Grant.
1848018695
operationId: createIntrospect
1848118696
parameters: []
1848218697
responses:
@@ -18497,15 +18712,27 @@ paths:
1849718712
description: Exchange User Credentials for a Token. If you will be using the
1849818713
Resource Owner Password Credential Grant, you will make a request to the Token
1849918714
endpoint to exchange the user’s email and password for an access token. OR
18500-
Exchange a Refresh Token for an Access Token. If you will be using the Refresh
18501-
Token Grant, you will make a request to the Token endpoint to exchange the
18502-
user’s refresh token for an access token. OR Exchanges an OAuth authorization
18715+
Exchange User Credentials for a Token. If you will be using the Resource Owner
18716+
Password Credential Grant, you will make a request to the Token endpoint to
18717+
exchange the user’s email and password for an access token. OR Exchange a
18718+
Refresh Token for an Access Token. If you will be using the Refresh Token
18719+
Grant, you will make a request to the Token endpoint to exchange the user’s
18720+
refresh token for an access token. OR Exchange a Refresh Token for an Access
18721+
Token. If you will be using the Refresh Token Grant, you will make a request
18722+
to the Token endpoint to exchange the user’s refresh token for an access token.
18723+
OR Exchanges an OAuth authorization code for an access token. Makes a request
18724+
to the Token endpoint to exchange the authorization code returned from the
18725+
Authorize endpoint for an access token. OR Exchanges an OAuth authorization
1850318726
code and code_verifier for an access token. Makes a request to the Token endpoint
1850418727
to exchange the authorization code returned from the Authorize endpoint and
1850518728
a code_verifier for an access token. OR Exchanges an OAuth authorization code
18729+
and code_verifier for an access token. Makes a request to the Token endpoint
18730+
to exchange the authorization code returned from the Authorize endpoint and
18731+
a code_verifier for an access token. OR Exchanges an OAuth authorization code
1850618732
for an access token. Makes a request to the Token endpoint to exchange the
1850718733
authorization code returned from the Authorize endpoint for an access token.
18508-
OR Make a Client Credentials grant request to obtain an access token.
18734+
OR Make a Client Credentials grant request to obtain an access token. OR Make
18735+
a Client Credentials grant request to obtain an access token.
1850918736
operationId: createToken
1851018737
parameters: []
1851118738
responses:

0 commit comments

Comments
 (0)