Manage user metadata
Metadata consists of key-value items in which you can store additional information to users. You can add up to five key-value items for user metadata. Each key can have up to 128 characters and value can have up to 190 characters as String
. This section explains how to manage user metadata.
Create metadata
You can create additional information such as phone number, email address or other descriptions to a user, which can be fetched or rendered into the UI. As an object, user metadata in Map<String, String>
is stored into a User
object.
To store user metadata into a User
object, create Map<String, String>
of key-value items, and then pass it as an argument to a parameter when calling the createMetaData()
method. You can add multiple key-value items in the map.
Retrieve
You can retrieve metadata stored to a user by calling the metaData
property of a User
object.
Update
You can update metadata of a user by adding map of key-value items, and then pass it as an argument to a parameter when calling the updateMetaData()
method. Values of existing keys will be updated and values of new keys will be added. You can put multiple key-value items in the map.
Delete
You can delete metadata stored to a user as below.