Updating or Creating Users Fails with Dotted Fields Error

Overview

This article explains how to resolve the following error in the Authentication API Debugger using the PATCH /api/v2/users/{id} endpoint of management API when updating the user metadata in actions.

Fields with \".\" are not allowed, please remove all dotted fields.

Example: https://<domain>.com/tenant". 

Applies To
  • Users Endpoint
  • API Debugger
Cause
The field names must not contain the . (dot) or $ (dollar sign) characters.
Metadata field names - Accepted characters
Solution
Remove the . (dot) or $ (dollar sign) characters from the field names in the user_metadata or app_metadata.
  • Perform this action using the Management API to update the metadata.
    • Updating metadata in the Tenant Dashboard will not work.
  1. You can use the Management API Explorer or any API client (e.g., Postman) you prefer to make the management API call.
  2. Use the PATCH /api/v2/users/{id} endpoint to remove the user's app_metadata (you can get the user_id from the tenant dashboard).
{
  "app_metadata": {}
}
  • Setting the `app_metadata` to an empty object will delete the `app_metadata` completely.​​​​

  • Delete user metadata

  1. Use the PATCH /api/v2/users/{id} endpoint again to add the user's app_metadata with desired value:
  • (If you don't need the app_metadata anymore, skip this step)
{
    "app_metadata": {
        "https://no_dot_field_name/fav_color": "pink"
    }
}
  1. The `app_metadata` is updated with no dot in the field name.

Recommended content

No recommended content found...