Skip to content

Commit

Permalink
Document that signout will not revoke the id token. (#7253)
Browse files Browse the repository at this point in the history
* Document that signout will not revoke the id token.

* Update packages/auth/src/model/public_types.ts

Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>

---------

Co-authored-by: Kevin Cheung <kevinthecheung@users.noreply.github.com>
  • Loading branch information
prameshj and kevinthecheung authored Apr 26, 2023
1 parent 450e000 commit 4535ccc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs-devsite/auth.auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>Auth</code> 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. |

Expand Down Expand Up @@ -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.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion packages/auth/src/model/public_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<void>;
}
Expand Down

0 comments on commit 4535ccc

Please sign in to comment.