UserMapping

This is an object representing a default mapping between a provider and an external user on a connected account (e.g., the Zoom user whose account is used to host meetings for a provider).

external_user objectrequired

This is an object representing a user synced from a connected external account (e.g., a Zoom user).

emailstringnullablerequired

The email address of the user at the provider.

first_namestringnullablerequired

The first name of the user at the provider.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^exusr_\w{12}$

last_namestringnullablerequired

The last name of the user at the provider.

objectstringrequired

String representing the object's type.

Possible values: [external_user]

statusstringnullablerequired

The status of the user at the provider. 'active' means the user is active, 'inactive' means the user is deactivated or suspended, 'pending' means the user has not yet activated their account. Additional values may be added over time.

Possible values: [active, inactive, pending]

objectstringrequired

String representing the object's type.

Possible values: [user_mapping]

provider objectrequired

A provider represents a staff member who can provide services to clients.

created_atdate-timerequired

Time at which the object was created.

display_namestringrequired

The provider's display name.

emailstringrequired

The provider's email address.

first_namestringrequired

The provider's first name.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^prov_\w{12}$

last_namestringrequired

The provider's last name.

metadata object

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

property name*any

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

objectstringrequired

String representing the object's type.

Possible values: [provider]

time_zonestringrequired

The provider's preferred IANA time zone, used as the default when authoring schedules.

updated_atdate-timerequired

Time at which the object was last updated.

sourcestringrequired

How the mapping was established. 'auto' means it was matched automatically by email, 'manual' means it was set explicitly. Additional values may be added over time.

Possible values: [auto, manual]

UserMapping

{
  "external_user": {
    "email": "dr.smith@example.com",
    "first_name": "Jane",
    "id": "exusr_d025a96ac0c6",
    "last_name": "Smith",
    "object": "external_user",
    "status": "active"
  },
  "object": "user_mapping",
  "provider": {
    "created_at": "2017-09-12T12:34:55Z",
    "display_name": "John Smith",
    "email": "john@example.com",
    "first_name": "John",
    "id": "prov_d025a96ac0c6",
    "last_name": "Smith",
    "metadata": {
      "external_id": "123"
    },
    "object": "provider",
    "time_zone": "America/New_York",
    "updated_at": "2017-09-13T10:11:12Z"
  },
  "source": "manual"
}