Interfaces
Auth
Sandbox Auth interface intentionally limited to implemented behavior.
Indexable
[key: string]: unknown
Properties
Methods
createCustomToken()
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parameters
Returns
Promise<string>
createUser()
createUser(properties: CreateRequest): Promise<UserRecord>;
Parameters
Returns
Promise<UserRecord>
deleteUser()
deleteUser(uid: string): Promise<void>;
Parameters
Returns
Promise<void>
getUser()
getUser(uid: string): Promise<UserRecord>;
Parameters
Returns
Promise<UserRecord>
getUserByEmail()
getUserByEmail(email: string): Promise<UserRecord>;
Parameters
Returns
Promise<UserRecord>
listUsers()
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parameters
Returns
Promise<ListUsersResult>
revokeRefreshTokens()
revokeRefreshTokens(uid: string): Promise<void>;
Parameters
Returns
Promise<void>
setCustomUserClaims()
setCustomUserClaims(uid: string, customUserClaims: object): Promise<void>;
Parameters
Returns
Promise<void>
updateUser()
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parameters
Returns
Promise<UserRecord>
verifyIdToken()
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameters
Returns
Promise<DecodedIdToken>
CreateRequest
Properties
DecodedIdToken
Extends
Indexable
[key: string]: unknown
Properties
ListUsersResult
Properties
UpdateRequest
Extends
Properties
UserInfo
Properties
Methods
toJSON()
toJSON(): Record<string, unknown>;
Returns
Record<string, unknown>
Properties
Methods
toJSON()
toJSON(): Record<string, unknown>;
Returns
Record<string, unknown>
UserRecord
Properties
Methods
toJSON()
toJSON(): Record<string, unknown>;
Returns
Record<string, unknown>
Functions
getAuth()
function getAuth(app?: SandboxAdminApp): Auth;
Return an Auth handle for app (or for the default app when omitted).
Local sandboxes use the shared in-process store; remote sandboxes relay to
the worker channel.
Parameters
Returns
Auth