Skip to content

Commit 4535ccc

Browse files
Document that signout will not revoke the id token. (#7253)
* Document that signout will not revoke the id token. * Update packages/auth/src/model/public_types.ts Co-authored-by: Kevin Cheung <[email protected]> --------- Co-authored-by: Kevin Cheung <[email protected]>
1 parent 450e000 commit 4535ccc

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs-devsite/auth.auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface Auth
4141
| [onAuthStateChanged(nextOrObserver, error, completed)](./auth.auth.md#authonauthstatechanged) | Adds an observer for changes to the user's sign-in state. |
4242
| [onIdTokenChanged(nextOrObserver, error, completed)](./auth.auth.md#authonidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. |
4343
| [setPersistence(persistence)](./auth.auth.md#authsetpersistence) | Changes the type of persistence on the <code>Auth</code> instance. |
44-
| [signOut()](./auth.auth.md#authsignout) | Signs out the current user. |
44+
| [signOut()](./auth.auth.md#authsignout) | Signs out the current user. This does not automatically revoke the user's ID token. |
4545
| [updateCurrentUser(user)](./auth.auth.md#authupdatecurrentuser) | Asynchronously sets the provided user as [Auth.currentUser](./auth.auth.md#authcurrentuser) on the [Auth](./auth.auth.md#auth_interface) instance. |
4646
| [useDeviceLanguage()](./auth.auth.md#authusedevicelanguage) | Sets the current language to the default device/browser preference. |
4747

@@ -247,7 +247,7 @@ auth.setPersistence(browserSessionPersistence);
247247

248248
## Auth.signOut()
249249

250-
Signs out the current user.
250+
Signs out the current user. This does not automatically revoke the user's ID token.
251251

252252
<b>Signature:</b>
253253

packages/auth/src/model/public_types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ export interface Auth {
313313
*/
314314
useDeviceLanguage(): void;
315315
/**
316-
* Signs out the current user.
316+
* Signs out the current user. This does not automatically revoke the user's ID token.
317317
*/
318318
signOut(): Promise<void>;
319319
}

0 commit comments

Comments
 (0)