You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -19,7 +19,7 @@ Token Vault is currently available in Early Access for public cloud tenants. To
19
19
20
20
Token Vault enables your applications to securely access third-party APIs on the user's behalf. There is no need to manage <Tooltiptip="Refresh Token: Token used to obtain a renewed Access Token without forcing users to log in again."cta="View Glossary"href="/docs/glossary?term=refresh+tokens">refresh tokens</Tooltip> or build custom integrations per provider—Auth0 handles it all for you. You gain access to a wide range of external providers’ APIs and services, all through a single Auth0 integration.
21
21
22
-
When a user authenticates with a supported external provider and uses <Tooltiptip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows."cta="View Glossary"href="/docs/glossary?term=OAuth">OAuth</Tooltip> scopes to authorize access, Auth0 stores the access and refresh tokens for that connection in the Token Vault. Token Vault organizes the tokens issued by external providers into tokensets, with one tokenset per authorized connection.
22
+
When a user authenticates with a supported external provider and uses <Tooltiptip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows."cta="View Glossary"href="/docs/glossary?term=OAuth">OAuth</Tooltip> scopes to authorize access, Auth0 stores the access and refresh tokens for that connection in the Token Vault. Token Vault organizes the federated tokens issued by external providers into tokensets, with one tokenset per authorized connection.
23
23
24
24
You can then call the external provider's APIs using these stored credentials via Auth0 to get a user’s Google Calendar events, access GitHub repos, create a Microsoft Word document, and more.
25
25
@@ -35,12 +35,12 @@ For Early Access, Auth0 supports Token Vault for the following social and enterp
35
35
36
36
## How it works
37
37
38
-
When a user authenticates with a supported external provider and authorizes the third-party connection:
38
+
When a user authenticates with a supported external provider and authorizes the federated connection:
39
39
40
40
1. Auth0 obtains access tokens using OAuth 2.0 scopes to control access. Users explicitly approve requested permissions.
41
-
2. Auth0 securely stores the access and refresh tokens of external providers in the Token Vault.
41
+
2. Auth0 securely stores federated access and refresh tokens in the Token Vault.
42
42
3. The application [links user accounts](/docs/manage-users/user-accounts/user-account-linking) with the user's consent. As a result, the user won’t have to create separate accounts for each external provider.
43
-
4. Your application calls Auth0 to exchange a valid Auth0 refresh token for an external provider's access token. Your application can perform this exchange multiple times while Auth0 manages refreshing the access tokens stored in the Token Vault. Using an external provider's access token, your application can call external APIs on the user’s behalf.
43
+
4. Your application calls Auth0 to exchange a valid Auth0 refresh token with an access token for a federated connection. Your application can perform this exchange multiple times while Auth0 manages refreshing the federated access tokens stored in the Token Vault. Using a federated access token, your application can call third-party APIs on the user’s behalf.
44
44
45
45
Token Vault allows for seamless federated identity and simplifies integration across multiple external providers via a single Auth0 interface.
Copy file name to clipboardExpand all lines: main/docs/secure/tokens/token-vault/call-apis-with-token-vault.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Token Vault is currently available in Early Access for public cloud tenants. To
16
16
17
17
</Callout>
18
18
19
-
Token Vault organizes the access and <Tooltiptip="Refresh Token: Token used to obtain a renewed Access Token without forcing users to log in again."cta="View Glossary"href="/docs/glossary?term=refresh+tokens">refresh tokens</Tooltip> issued by external providers into tokensets, with one tokenset per authorized connection. Applications can access the Token Vault when they exchange a valid Auth0 refresh token for an external provider's <Tooltiptip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API."cta="View Glossary"href="/docs/glossary?term=access+token">access token</Tooltip> stored in the tokenset. This enables applications to request access tokens without the user having to re-authorize the connection. Using the external provider's access token, the application can call external APIs on the user’s behalf.
19
+
Token Vault organizes federated access and <Tooltiptip="Refresh Token: Token used to obtain a renewed Access Token without forcing users to log in again."cta="View Glossary"href="/docs/glossary?term=refresh+tokens">refresh tokens</Tooltip> issued by external providers into tokensets, with one tokenset per authorized connection. Applications can access the Token Vault when they exchange a valid Auth0 refresh token for a federated <Tooltiptip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API."cta="View Glossary"href="/docs/glossary?term=access+token">access token</Tooltip> stored in the tokenset. This enables applications to request federated access tokens without the user having to re-authorize the connection. Using the federated access token, the application can call third-party APIs on the user’s behalf.
20
20
21
21
Let’s walk through a real-world example: A user wants to schedule a meeting in their Google Calendar using a productivity app.
22
22
@@ -66,7 +66,7 @@ When the user logs into a new Google social connection:
66
66
67
67
## Call third-party API
68
68
69
-
To schedule the meeting, the application needs to call the Google Calendar API. The application can use a valid Auth0 refresh token to request a Google access token with the scopes granted in the login flow without the user having to re-authorize the connection. To learn more, read [Manage Token Vault refresh tokens](#manage-token-vault-refresh-tokens).
69
+
To schedule the meeting, the application needs to call the Google Calendar API. The application can use a valid Auth0 refresh token to request a Google access token with the scopes granted in the login flow without the user having to re-authorize the connection. To learn more, read [Manage federated refresh tokens](#manage-federated-refresh-tokens).
70
70
71
71
To call the Google Calendar API:
72
72
@@ -128,7 +128,7 @@ Request:
128
128
</tr>
129
129
<tr>
130
130
<td><code>client_secret</code></td>
131
-
<td>Client secret. <strong>Note:</strong> You can use any client authentication method to get an external provider's access token.</td>
131
+
<td>Client secret. <strong>Note:</strong> You can use any client authentication method to get a federated access token.</td>
132
132
</tr>
133
133
<tr>
134
134
<td><code>subject_token_type</code></td>
@@ -159,7 +159,7 @@ The Auth0 Authorization Server validates and loads the user profile associated w
159
159
2. If the authorization request contains `login_hint`, Auth0 looks for an identity matching both the connection name and the `login_hint`.
160
160
3. If Auth0 can’t find the user, it returns a `401` status code with an error message.
161
161
162
-
Once the Auth0 Authorization Server validates the user, it locates the external provider's access token within the Token Vault. If it is still valid, Auth0 returns the external provider's access token with its scopes and expiry time:
162
+
Once the Auth0 Authorization Server validates the user, it locates the federated access token within the Token Vault. If it is still valid, Auth0 returns the federated access token with its scopes and expiry time:
163
163
164
164
```json lines
165
165
{
@@ -176,16 +176,16 @@ Once the Auth0 Authorization Server validates the user, it locates the external
176
176
177
177
178
178
179
-
If the external provider's access token has expired, Auth0 uses the refresh token stored in the Token Vault to get a new access token with the same scopes. Auth0 then stores it in the corresponding tokenset and returns it to the application. To learn more about how Auth0 manages refresh tokens, read [Manage Token Vault refresh tokens](#manage-token-vault-refresh-tokens).
179
+
If the federated access token has expired, Auth0 uses the federated refresh token stored in the Token Vault to get a new federated access token with the same scopes. Auth0 then stores it in the corresponding tokenset and returns it to the application. To learn more about how Auth0 manages federated refresh tokens, read [Manage federated refresh tokens](#manage-federated-refresh-tokens).
180
180
181
-
Using the Token Vault access token, the application calls the Google Calendar API on the user’s behalf.
181
+
Using the federated access token, the application calls the Google Calendar API on the user’s behalf.
182
182
183
-
## Manage Token Vault refresh tokens
183
+
## Manage federated refresh tokens
184
184
185
-
Auth0 securely stores refresh and access tokens for external providers in a tokenset within the Token Vault, with one tokenset per authorized connection. Auth0 manages refresh tokens on the server, so your application only has to handle storing and exchanging Auth0 refresh tokens for an external provider's access tokens.
185
+
Auth0 securely stores the federated refresh and access tokens of external providers in a tokenset within the Token Vault, with one tokenset per authorized connection. Auth0 manages federated refresh tokens on the server, so your application only has to handle storing and exchanging Auth0 refresh tokens for federated access tokens.
186
186
187
187
To learn more about how Auth0 manages Auth0 refresh tokens for different types of applications, read [Refresh tokens](/docs/secure/tokens/refresh-tokens).
188
188
189
-
### Token Vault refresh token expiration policy
189
+
### Federated refresh token expiration policy
190
190
191
-
Auth0 deletes refresh tokens from tokensets when they expire based on the expiration date set by the external provider or if they have not been exchanged for an access token for 1+ years.
191
+
Auth0 deletes federated refresh tokens from tokensets when they expire based on the expiration date set by the external provider or if they have not been exchanged for a federated access token for 1+ years.
Copy file name to clipboardExpand all lines: main/docs/secure/tokens/token-vault/configure-token-vault.mdx
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,13 @@ Auth0 supports Token Vault for the following social and enterprise <Tooltip tip=
24
24
* <Tooltiptip="OpenID: Open standard for authentication that allows applications to verify users' identities without collecting and storing login information."cta="View Glossary"href="/docs/glossary?term=OpenID">OpenID</Tooltip> Connect
25
25
* Custom social connection
26
26
27
-
Once a user authenticates with a supported external provider and authorizes the connection, you can get an <Tooltiptip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API."cta="View Glossary"href="/docs/glossary?term=access+token">access token</Tooltip> to call external APIs on the user’s behalf. To learn more, read [Call APIs with Token Vault](/docs/secure/tokens/token-vault/call-apis-with-token-vault).
27
+
Once a user authenticates with a supported external provider and authorizes the federated connection, you can get an <Tooltiptip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API."cta="View Glossary"href="/docs/glossary?term=access+token">access token</Tooltip> to call third-party APIs on the user’s behalf. To learn more, read [Call APIs with Token Vault](/docs/secure/tokens/token-vault/call-apis-with-token-vault).
28
28
29
29
To configure Token Vault, you need to:
30
30
31
-
1. Configure your application with the Token Vault grant type.
32
-
2. Enable Token Vault for a supported social or enterprise connection.
33
-
3. Manage tokensets within the Token Vault for your social or enterprise connection.
31
+
1. Configure your application with the Token Exchange (Federated Connection) grant type.
32
+
2. Enable Token Vault for a federated connection.
33
+
3. Manage tokensets within the Token Vault for your federated connection.
@@ -42,9 +42,9 @@ If you need to trigger MFA challenges for interactive flows, enable **Customize
42
42
43
43
## Configure application
44
44
45
-
Configure your application with the Token Vault grant type using the <Tooltiptip="Management API: A product to allow customers to perform administrative tasks."cta="View Glossary"href="/docs/glossary?term=Auth0+Dashboard">Auth0 Dashboard</Tooltip> or <Tooltiptip="Auth0 Dashboard: Auth0's main product to configure your services."cta="View Glossary"href="/docs/glossary?term=Management+API">Management API</Tooltip>.
45
+
Configure your application with the Token Exchange (Federated Connection) grant type using the <Tooltiptip="Management API: A product to allow customers to perform administrative tasks."cta="View Glossary"href="/docs/glossary?term=Auth0+Dashboard">Auth0 Dashboard</Tooltip> or <Tooltiptip="Auth0 Dashboard: Auth0's main product to configure your services."cta="View Glossary"href="/docs/glossary?term=Management+API">Management API</Tooltip>.
46
46
47
-
Only certain types of clients can use the Token Vault grant type:
47
+
Only certain types of clients can use the Token Exchange (Federated Connection) grant type:
48
48
49
49
1. The client must be a first-party client, i.e. the `is_first_party` property is `true`.
50
50
2. The client must be a confidential client with a valid authentication mechanism, i.e. the `token_endpoint_auth_method` property must not be set to `none`.
@@ -54,7 +54,7 @@ Only certain types of clients can use the Token Vault grant type:
54
54
55
55
1. Navigate to **Applications > Applications**.
56
56
2. Select the application you want to configure.
57
-
3. Under **Advanced Settings > Grant Types**, select the **Token Vault** grant type.
57
+
3. Under **Advanced Settings > Grant Types**, select the **Token Exchange (Federated Connection)** grant type.
Use the Auth0 Dashboard or Management API to configure a supported social or enterprise connection to retrieve and store access tokens for external APIs in the Token Vault.
88
+
Use the Auth0 Dashboard or Management API to configure a federated connection to retrieve and store access tokens for third-party APIs in the Token Vault.
89
89
90
90
Once you enable Token Vault for your connection, access and <Tooltiptip="Refresh Token: Token used to obtain a renewed Access Token without forcing users to log in again."cta="View Glossary"href="/docs/glossary?term=refresh+tokens">refresh tokens</Tooltip> will no longer be stored in the user’s `identities` array. Instead, they will be stored in a secure tokenset within the Token Vault. To learn more, read [Manage tokensets](#manage-tokensets).
0 commit comments