Firebase Admin Node.js SDK Reference
The Admin SDK is a set of server libraries that lets you interact with Firebase from privileged environments. You can install it via our npm package.
To get started using the Firebase Admin Node.js SDK, see Add the Firebase Admin SDK to your server.
For source code, see the Firebase Admin Node.js SDK GitHub repo.
API Reference
admin
admin.app
admin.appCheck
admin.auth
- Auth
- ActionCodeSettings
- AuthProviderConfig
- AuthProviderConfigFilter
- CreateMultiFactorInfoRequest
- CreatePhoneMultiFactorInfoRequest
- CreateRequest
- EmailSignInProviderConfig
- ListProviderConfigResults
- ListTenantsResult
- MultiFactorConfig
- MultiFactorCreateSettings
- MultiFactorInfo
- MultiFactorSettings
- MultiFactorUpdateSettings
- OAuthResponseType
- OIDCAuthProviderConfig
- OIDCUpdateAuthProviderRequest
- PhoneMultiFactorInfo
- SAMLAuthProviderConfig
- SAMLUpdateAuthProviderRequest
- Tenant
- TenantAwareAuth
- TenantManager
- UpdateMultiFactorInfoRequest
- UpdatePhoneMultiFactorInfoRequest
- UpdateRequest
- UpdateTenantRequest
- UserImportOptions
- UserImportRecord
- UserImportResult
- DecodedIdToken
- UserInfo
- UserMetadata
- UserMetadataRequest
- UserProviderRequest
- UserRecord
- UserProvider
- SessionCookieOptions
- BaseAuth
- ListUsersResult
- GetUsersResult
- DeleteUsersResult
- UidIdentifier
- EmailIdentifier
- PhoneIdentifier
- ProviderIdentifier
admin.credential
admin.database
admin.firestore
admin.instanceId
admin.machineLearning
- ListModelsOptions
- ListModelsResult
- MachineLearning
- Model
- ModelOptionsBase
- GcsTfliteModelOptions
- AutoMLTfliteModelOptions
- TFLiteModel
admin.messaging
- BaseMessage
- TopicMessage
- TokenMessage
- ConditionMessage
- AndroidConfig
- AndroidFcmOptions
- AndroidNotification
- FcmOptions
- LightSettings
- Messaging
- MessagingConditionResponse
- MessagingDeviceGroupResponse
- MessagingDeviceResult
- MessagingDevicesResponse
- MessagingOptions
- MessagingPayload
- MessagingTopicResponse
- MessagingTopicManagementResponse
- NotificationMessagePayload
- MulticastMessage
- WebpushNotification
- WebpushFcmOptions
- DataMessagePayload
- BatchResponse
- SendResponse
- ApnsConfig
- ApnsFcmOptions
- ApnsPayload
- Aps
- ApsAlert
- CriticalSound
- Notification
- WebpushConfig
admin.projectManagement
- AndroidApp
- AndroidAppMetadata
- AppMetadata
- AppPlatform
- IosApp
- IosAppMetadata
- ProjectManagement
- ShaCertificate