Skip to content

Commit 4aa2651

Browse files
committed
Fix docs issues
1 parent 2a863dd commit 4aa2651

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

examples/ConnectedAccounts.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ The Connect Accounts feature uses the Auth0 My Account API to allow users to lin
44

55
When using Connected Accounts, Auth0 acquires tokens from upstream Identity Providers (like Google) and stores them in a secure [Token Vault](https://auth0.com/docs/secure/tokens/token-vault). These tokens can then be used to access third-party APIs (like Google Calendar) on behalf of the user.
66

7-
The tokens in the Token Vault are then accessible to [Resource Servers](https://auth0.com/docs/get-started/apis) (APIs) configured in Auth0. The SPA application can then issue requests to the API, which can retrieve the tokens from the Token Vault and use them to access the third-party APIs.
7+
The tokens in the Token Vault are then accessible to [Resource Servers](https://auth0.com/docs/get-started/apis) (APIs) configured in Auth0. The application can then issue requests to the API, which can retrieve the tokens from the Token Vault and use them to access the third-party APIs.
88

99
This is particularly useful for applications that require access to different resources on behalf of a user, like AI Agents.
1010

1111
## Configure the SDK
1212

1313
The SDK must be configured with an audience (an API Identifier) - this will be the resource server that uses the tokens from the Token Vault.
1414

15-
The Auth0 client Application must be configured to use refresh tokens and MRRT (Multiple Resource Refresh Tokens) since we will use the refresh token grant to get Access Tokens for the My Account API in addition to the API we are calling.
15+
The Auth0 client Application must be configured to use refresh tokens and [MRRT (Multiple Resource Refresh Tokens)](https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token) since we will use the refresh token grant to get Access Tokens for the My Account API in addition to the API we are calling.
1616

1717
```python
1818
server_client = ServerClient(
@@ -22,6 +22,7 @@ server_client = ServerClient(
2222
secret="YOUR_SECRET",
2323
authorization_params={
2424
"redirect_uri":"YOUR_CALLBACK_URL",
25+
"audience": "YOUR_API_IDENTIFIER"
2526
}
2627
)
2728
```
@@ -37,8 +38,7 @@ authorization_url = await server_client.start_interactive_login(
3738
{
3839
"authorization_params": {
3940
# must include offline_access to obtain a refresh token
40-
"scope": "openid profile email offline_access",
41-
"audience": "YOUR_API_IDENTIFIER",
41+
"scope": "openid profile email offline_access"
4242
}
4343
},
4444
store_options={"request": request, "response": response}
@@ -53,11 +53,11 @@ result = await server_client.complete_interactive_login(
5353
)
5454
```
5555

56-
## Connect to a third party account
56+
## Connect to a third-party account
5757

58-
Start the flow using the `start_connect_account` method to redirect the user to the third party Identity Provider to connect their account.
58+
Start the flow using the `start_connect_account` method to redirect the user to the third-party Identity Provider to connect their account.
5959

60-
The `authorization_params` is used to pass additional parameters required by the third party IdP
60+
The `authorization_params` is used to pass additional parameters required by the third-party IdP
6161
The `app_state` parameter allows you to pass custom state (for example, a return URL) that is later available when the connect process completes.
6262

6363
```python
@@ -79,11 +79,11 @@ connect_url = await self.client.start_connect_account(
7979
)
8080
```
8181

82-
Using the url returned, redirect the user to the third party Identity Provider to complete any required authorization. Once authorized, the user will be redirected back to the provided `redirect_uri` with a `connect_code` and `state` parameter.
82+
Using the url returned, redirect the user to the third-party Identity Provider to complete any required authorization. Once authorized, the user will be redirected back to the provided `redirect_uri` with a `connect_code` and `state` parameter.
8383

8484
## Complete the account connection
8585

86-
Call the `complete_connect_account` method using the full callback url returned from the third party IdP to complete the connected account flow. This method extracts the connect_code from the URL, completes the connection, and returns the response data (including any `app_state` you passed originally).
86+
Call the `complete_connect_account` method using the full callback url returned from the third-party IdP to complete the connected account flow. This method extracts the connect_code from the URL, completes the connection, and returns the response data (including any `app_state` you passed originally).
8787

8888
```python
8989
complete_response = await self.client.complete_connect_account(
@@ -95,4 +95,4 @@ complete_response = await self.client.complete_connect_account(
9595
>[!NOTE]
9696
>The `callback_url` must include the necessary parameters (`state` and `connect_code`) that Auth0 sends upon successful authentication.
9797
98-
You can now call the API with your access token and the API can use [Access Token Exchange with Token Vault](https://auth0.com/docs/secure/tokens/token-vault/access-token-exchange-with-token-vault) to get tokens from the Token Vault to access third party APIs on behalf of the user.
98+
You can now call the API with your access token and the API can use [Access Token Exchange with Token Vault](https://auth0.com/docs/secure/tokens/token-vault/access-token-exchange-with-token-vault) to get tokens from the Token Vault to access third-party APIs on behalf of the user.

0 commit comments

Comments
 (0)