firebase_admin.instance_id module

Firebase Instance ID module.

This module enables deleting instance IDs associated with Firebase projects.

Exceptions

exception firebase_admin.instance_id.ApiCallError(message, error)

Bases: exceptions.Exception

Represents an Exception encountered while invoking the Firebase instance ID service.

Functions

firebase_admin.instance_id.delete_instance_id(instance_id, app=None)

Deletes the specified instance ID from Firebase.

This can be used to delete an instance ID and associated user data from a Firebase project, pursuant to the General Data Protection Regulation (GDPR).

Parameters:
  • instance_id – A non-empty instance ID string.
  • app – An App instance (optional).
Raises:
  • InstanceIdError – If an error occurs while invoking the backend instance ID service.
  • ValueError – If the specified instance ID or app is invalid.

Send feedback about...

Need help? Visit our support page.