Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adding public definitions
  • Loading branch information
pragatimodi committed Nov 14, 2023
commit 43f6df5017d6e701b9c109342232d076a8ef0827
4 changes: 3 additions & 1 deletion etc/firebase-admin.auth.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,10 @@ export abstract class BaseAuth {
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
// Warning: (ae-forgotten-export) The symbol "AuthBlockingEventType" needs to be exported by the entry point index.d.ts
//
// @alpha (undocumented)
_verifyAuthBlockingToken(token: string, audience?: string): Promise<DecodedAuthBlockingToken>;
_verifyAuthBlockingToken(token: string, audience?: string, eventType?: AuthBlockingEventType): Promise<DecodedAuthBlockingToken>;
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
}
Expand Down
6 changes: 4 additions & 2 deletions src/auth/base-auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
createAuthBlockingTokenVerifier,
DecodedIdToken,
DecodedAuthBlockingToken,
AuthBlockingEventType,
} from './token-verifier';
import {
AuthProviderConfig, SAMLAuthProviderConfig, AuthProviderConfigFilter, ListProviderConfigResults,
Expand Down Expand Up @@ -1095,10 +1096,11 @@ export abstract class BaseAuth {
// eslint-disable-next-line @typescript-eslint/naming-convention
public _verifyAuthBlockingToken(
token: string,
audience?: string
audience?: string,
eventType?: AuthBlockingEventType,
): Promise<DecodedAuthBlockingToken> {
const isEmulator = useEmulator();
return this.authBlockingTokenVerifier._verifyAuthBlockingToken(token, isEmulator, audience)
return this.authBlockingTokenVerifier._verifyAuthBlockingToken(token, isEmulator, audience, eventType)
.then((decodedAuthBlockingToken: DecodedAuthBlockingToken) => {
return decodedAuthBlockingToken;
});
Expand Down
3 changes: 1 addition & 2 deletions src/auth/token-verifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -323,8 +323,7 @@ export interface FirebaseTokenInfo {

/**
* Shorthand auth blocking events from GCIP.
* @hidden
* @alpha
*
*/
export type AuthBlockingEventType = 'beforeCreate' | 'beforeSignIn' | 'beforeSendEmail' | 'beforeSendSms';

Expand Down