Skip to content

docs: align docs with actual auth/authType behaviour #1913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
IzaakGough wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: align docs with actual auth/authType behaviour #1913

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions src/v1/cloud-functions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,13 @@ export interface EventContext<Params = Record<string, string>> {
* For more detail including token keys, see the
* {@link https://firebase.google.com/docs/reference/rules/rules#properties | security rules reference}.
*
* This field is only populated for Realtime Database triggers and Callable
* functions. For an unauthenticated user, this field is null. For Firebase
* This field is only populated for Realtime Database triggers. For an
* unauthenticated Realtime Database user, this field is `null`. For Firebase
* admin users and event types that do not provide user information, this field
* does not exist.
* is not set.
*
* Callable functions use {@link https.CallableContext.auth} instead of
* `EventContext.auth`.
*/
auth?: {
uid: string;
Expand All @@ -122,8 +125,8 @@ export interface EventContext<Params = Record<string, string>> {
*
* - `UNAUTHENTICATED`: Unauthenticated action
*
* - `null`: For event types that do not provide user information (all except
* Realtime Database).
* This field is only populated for Realtime Database triggers. For event
* types that do not provide user information, this field is not set.
*/
authType?: "ADMIN" | "USER" | "UNAUTHENTICATED";

Expand Down
Loading