Skip to content

Add doc changes for OAuth protected endpoints #9135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: 4.5.0
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified en/docs/assets/img/learn/client-credentials-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/learn/oauth-2-submit-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/learn/resource-owner-password-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions en/docs/design/endpoints/endpoint-security/oauth-2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,30 @@ Follow the instructions below to use OAuth 2.0 as the endpoint authorization typ

[![resource owner password config]({{base_path}}/assets/img/learn/resource-owner-password-config.png)]({{base_path}}/assets/img/learn/resource-owner-password-config.png)

c. Configure the following timeout parameters for the connection with the token endpoint:

* **Connection Timeout Duration** - The duration (in milliseconds) before the connection attempt times out.

* **Connection Request Timeout Duration** - The duration (in milliseconds) before a request for a connection times out.

* **Socket Timeout Duration** - The duration (in milliseconds) before a socket read operation times out.

[![oauth-2-timeout-config]({{base_path}}/assets/img/learn/oauth-2-timeout-config.png)]({{base_path}}/assets/img/learn/oauth-2-timeout-config.png)

d. Configure the following proxy settings for the connection with the token endpoint:

* **Proxy Hostname** - The hostname of the proxy server.

* **Proxy Port** - The port of the proxy server.

* **Proxy Username** - The username required for proxy authentication.

* **Proxy Password** - The password required for proxy authentication.

* **Proxy Protocol** - The protocol used for the proxy connection.

[![oauth-2-proxy-config]({{base_path}}/assets/img/learn/oauth-2-proxy-config.png)]({{base_path}}/assets/img/learn/oauth-2-proxy-config.png)

5. If the OAuth-2.0-protected backend server token endpoint requires any other properties to be passed in addition to the above, click **Add Parameter** and provide the required properties and their respective values.

Editing and removing parameter name-value pairs are also supported.
Expand Down