update_profile {firebase.auth.rest}R Documentation

Update user profile

Description

Update a user's profile (display name / photo URL).

Usage

update_profile(
  id_token,
  display_name = NULL,
  photo_url = NULL,
  delete_attribute = NULL
)

Arguments

id_token

String. A Firebase Auth ID token for the user.

display_name

String. User's new display name. Defaults to NULL.

photo_url

String. User's new photo url. Defaults to NULL.

delete_attribute

Character vector of attributes to delete. Either "DISPLAY_NAME" or "PHOTO_URL". This will nullify these values. Defaults to NULL.

Details

Visit Firebase Auth REST API docs for more details

Value

A named list with the following items:

Examples

## Not run: 
  update_profile(
    id_token = "id-token-goes-here",
    display_name = "new-user-display-name",
    photo_url = "url-to-user-photo"
  )

  # to delete the display name attribute:
  update_profile(
    delete_attribute = "DISPLAY_NAME"
  )

## End(Not run)

[Package firebase.auth.rest version 1.0.1 Index]