Navigate

API reference

pyric-admin/auth

9 published symbols from pyric-admin

Generated from the TypeScript declarations shipped at this import path.

Interfaces

Auth

Sandbox Auth interface intentionally limited to implemented behavior.

Indexable

[key: string]: unknown

Properties

PropertyModifierType
appreadonlySandboxAdminApp

Methods

createCustomToken()
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parameters
ParameterType
uidstring
developerClaims?object
Returns

Promise<string>

createUser()
createUser(properties: CreateRequest): Promise<UserRecord>;
Parameters
ParameterType
propertiesCreateRequest
Returns

Promise<UserRecord>

deleteUser()
deleteUser(uid: string): Promise<void>;
Parameters
ParameterType
uidstring
Returns

Promise<void>

getUser()
getUser(uid: string): Promise<UserRecord>;
Parameters
ParameterType
uidstring
Returns

Promise<UserRecord>

getUserByEmail()
getUserByEmail(email: string): Promise<UserRecord>;
Parameters
ParameterType
emailstring
Returns

Promise<UserRecord>

listUsers()
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parameters
ParameterType
maxResults?number
pageToken?string
Returns

Promise<ListUsersResult>

revokeRefreshTokens()
revokeRefreshTokens(uid: string): Promise<void>;
Parameters
ParameterType
uidstring
Returns

Promise<void>

setCustomUserClaims()
setCustomUserClaims(uid: string, customUserClaims: object): Promise<void>;
Parameters
ParameterType
uidstring
customUserClaimsobject
Returns

Promise<void>

updateUser()
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parameters
ParameterType
uidstring
propertiesUpdateRequest
Returns

Promise<UserRecord>

verifyIdToken()
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameters
ParameterType
idTokenstring
checkRevoked?boolean
Returns

Promise<DecodedIdToken>


CreateRequest

Properties

PropertyType
disabled?boolean
displayName?string
email?string
emailVerified?boolean
password?string
phoneNumber?string
photoURL?string
uid?string

DecodedIdToken

Extends

  • Record<string, unknown>

Indexable

[key: string]: unknown

Properties

PropertyType
audstring
auth_timenumber
expnumber
firebase{ identities: Record<string, unknown>; sign_in_provider: string; }
firebase.identitiesRecord<string, unknown>
firebase.sign_in_providerstring
iatnumber
issstring
substring
uidstring

ListUsersResult

Properties

PropertyType
pageToken?string
usersUserRecord[]

UpdateRequest

Extends

Properties

PropertyType
disabled?boolean
displayName?string
email?string
emailVerified?boolean
multiFactor?unknown
password?string
phoneNumber?string
photoURL?string
providersToUnlink?unknown
providerToLink?unknown

UserInfo

Properties

PropertyType
displayName?string
email?string
phoneNumber?string
photoURL?string
providerIdstring
uidstring

Methods

toJSON()
toJSON(): Record<string, unknown>;
Returns

Record<string, unknown>


UserMetadata

Properties

PropertyType
creationTimestring
lastSignInTimestring

Methods

toJSON()
toJSON(): Record<string, unknown>;
Returns

Record<string, unknown>


UserRecord

Properties

PropertyModifierType
customClaims?readonlyRecord<string, unknown>
disabledreadonlyboolean
displayName?readonlystring
email?readonlystring
emailVerifiedreadonlyboolean
metadatareadonlyUserMetadata
phoneNumber?readonlystring
photoURL?readonlystring
providerDatareadonlyUserInfo[]
tenantIdreadonlystring
uidreadonlystring

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

ParameterType
app?SandboxAdminApp

Returns

Auth