Amplitude · Schema

UserMapping

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name	Type	Description
global_user_id	string	The primary user ID that other identities will be mapped to.
user_id	string	The user ID to map to the global_user_id.
unmap	boolean	When true, removes the mapping instead of creating it.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserMapping",
  "title": "UserMapping",
  "type": "object",
  "required": [
    "global_user_id",
    "user_id"
  ],
  "properties": {
    "global_user_id": {
      "type": "string",
      "description": "The primary user ID that other identities will be mapped to."
    },
    "user_id": {
      "type": "string",
      "description": "The user ID to map to the global_user_id."
    },
    "unmap": {
      "type": "boolean",
      "description": "When true, removes the mapping instead of creating it."
    }
  }
}