diff --git a/src/main/api/exchangeOAuthCodeForAccessToken.json b/src/main/api/exchangeOAuthCodeForAccessToken.json index ee0b298d..e5ab59c8 100644 --- a/src/main/api/exchangeOAuthCodeForAccessToken.json +++ b/src/main/api/exchangeOAuthCodeForAccessToken.json @@ -2,7 +2,7 @@ "uri": "/oauth2/token", "comments": [ "Exchanges an OAuth authorization code for an access token.", - "If you will be using the Authorization Code grant, you will make a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token." + "Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token." ], "method": "post", "methodName": "exchangeOAuthCodeForAccessToken", @@ -53,4 +53,4 @@ "javaType": "String" } ] -} \ No newline at end of file +} diff --git a/src/main/api/exchangeOAuthCodeForAccessTokenUsingPKCE.json b/src/main/api/exchangeOAuthCodeForAccessTokenUsingPKCE.json new file mode 100644 index 00000000..4efa624f --- /dev/null +++ b/src/main/api/exchangeOAuthCodeForAccessTokenUsingPKCE.json @@ -0,0 +1,64 @@ +{ + "uri": "/oauth2/token", + "comments": [ + "Exchanges an OAuth authorization code and code_verifier for an access token.", + "Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token." + ], + "method": "post", + "methodName": "exchangeOAuthCodeForAccessTokenUsingPKCE", + "successResponse": "AccessToken", + "errorResponse": "OAuthError", + "anonymous": true, + "params": [ + { + "name": "code", + "comments": [ + "The authorization code returned on the /oauth2/authorize response." + ], + "type": "form", + "javaType": "String" + }, + { + "name": "client_id", + "comments": [ + "(Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you you are attempting to authenticate. This parameter is optional when the Authorization header is provided." + ], + "type": "form", + "javaType": "String" + }, + { + "name": "client_secret", + "comments": [ + "(Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header." + ], + "type": "form", + "javaType": "String" + }, + { + "name": "grant_type", + "comments": [ + "The grant type to be used. This value must be set to authorization_code" + ], + "type": "form", + "javaType": "String", + "constant": true, + "value": "authorization_code" + }, + { + "name": "redirect_uri", + "comments": [ + "The URI to redirect to upon a successful request." + ], + "type": "form", + "javaType": "String" + }, + { + "name": "code_verifier", + "comments": [ + "The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app." + ], + "type": "form", + "javaType": "String" + } + ] +}