diff --git a/docs-devsite/auth.auth.md b/docs-devsite/auth.auth.md index 9bd59ba6c56..b8b21c6870c 100644 --- a/docs-devsite/auth.auth.md +++ b/docs-devsite/auth.auth.md @@ -41,7 +41,7 @@ export interface Auth | [onAuthStateChanged(nextOrObserver, error, completed)](./auth.auth.md#authonauthstatechanged) | Adds an observer for changes to the user's sign-in state. | | [onIdTokenChanged(nextOrObserver, error, completed)](./auth.auth.md#authonidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. | | [setPersistence(persistence)](./auth.auth.md#authsetpersistence) | Changes the type of persistence on the Auth instance. | -| [signOut()](./auth.auth.md#authsignout) | Signs out the current user. | +| [signOut()](./auth.auth.md#authsignout) | Signs out the current user. This does not automatically revoke the user's ID token. | | [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. | | [useDeviceLanguage()](./auth.auth.md#authusedevicelanguage) | Sets the current language to the default device/browser preference. | @@ -247,7 +247,7 @@ auth.setPersistence(browserSessionPersistence); ## Auth.signOut() -Signs out the current user. +Signs out the current user. This does not automatically revoke the user's ID token. Signature: diff --git a/packages/auth/src/model/public_types.ts b/packages/auth/src/model/public_types.ts index f0791164510..8009d2714b0 100644 --- a/packages/auth/src/model/public_types.ts +++ b/packages/auth/src/model/public_types.ts @@ -313,7 +313,7 @@ export interface Auth { */ useDeviceLanguage(): void; /** - * Signs out the current user. + * Signs out the current user. This does not automatically revoke the user's ID token. */ signOut(): Promise; }