x-ntx-oauth-settings
Use the x-ntx-oauth-settings Specification Extension to enable Proof Key for Code Exchange (PKCE) during OAuth authentication An authorization protocol that allows a user to grant access to a third-party account without revealing their credentials to the requesting software..
How to use x-ntx-oauth-settings
- Add the key x-ntx-oauth-settings as an empty object to the OAuth2.0 security definition.
- Inside the x-ntx-oauth-settings object, add the key of enablePkce with a value of true.
Where to use x-ntx-oauth-settings
Use x-ntx-oauth-settings inside OAuth2.0 security definitions in the securityDefinitions object of your OpenAPI Specification.
"securityDefinitions": {
"oauth2": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth",
"tokenUrl": "https://www.googleapis.com/oauth2/v4/token",
"scopes": {
"https://www.googleapis.com/auth/tasks": "access to tasks"
},
"x-ntx-oauth-settings":{
"enablePkce" : true
}
}
}
Limitations
PKCE support is not enabled automatically.
If you enable PKCE in an existing Xtension, refresh any workflow actions that are using the Xtension. See Refresh an action in a workflow.