***

title: User Attribute Reference
excerpt: ''
deprecated: false
hidden: false
metadata:
title: ''
description: ''
robots: index
next:
description: ''
---------------

User Attributes are what make up a user's identity within Moveworks. Moveworks exposes these attributes to be used in API requests & launch options for ease of development.

## List of available User Attributes

| name                         | description                                         | type   |
| :--------------------------- | :-------------------------------------------------- | :----- |
| custom\_attributes           | This can be used to dot walk into custom attributes | obj    |
| first\_name                  | The user's first name                               | string |
| last\_name                   | The user's last name                                | string |
| email\_addr                  | The user's email                                    | string |
| role                         | The user's role                                     | string |
| department                   | The user's department                               | string |
| manager\_email               | The user's manager email                            | string |
| full\_name                   | The user's full name                                | string |
| employee\_id                 | The user's employee ID                              | string |
| cost\_center\_id             | The user's cost center ID                           | string |
| cost\_center\_name           | The user's cost center name                         | string |
| work\_status                 | The user's work status                              | enum   |
| country\_code                | The user's country code                             | string |
| timezone                     | The user's timezone                                 | string |
| region                       | The user's region                                   | string |
| city                         | The user's city                                     | string |
| state                        | The user's state                                    | string |
| user\_tags                   | The user's assigned user tags                       | enum   |
| external\_system\_identities | The user's system related info                      | map    |

<Callout intent="info" title="Any key value pair that does not match up with one of the default user attributes can be mapped to the custom_attributes field">
  For example, if you a have a field called office that would like to map to the Moveworks User, you would map that under `custom_attributes`, and can then access the field using `user.custom_attributes.office`
</Callout>

### work\_status enum

The work status field is composed of the following predefined options

| options               |
| :-------------------- |
| UNKNOWN\_WORK\_STATUS |
| CONTINGENT            |
| INTERN                |
| FULL\_TIME            |

### user\_tags enum

The user tags field is composed of the following predefined options:

| options                   |
| :------------------------ |
| UNKNOWN\_USER\_TAG        |
| BASIC\_USER               |
| VIP                       |
| FIELD\_AGENT              |
| KNOWLEDGE\_WORKER         |
| IT\_AGENT                 |
| TESTER                    |
| SUPPORTED\_LANGUAGE\_USER |
| SERVICE\_ACCOUNT          |
| CALL\_CENTER              |
| HAS\_ACCESS\_TO\_BOT      |
| DIRECTOR                  |
| EXECUTIVE                 |
| SOCIAL\_AUTH\_USER        |

### external\_system\_identities map

The external system identities map has the shape of \<string, ExternalSystemIdentity> which can be interpreted as a dictionary with a string key such as `jira_service_desk` and an object as its value. The objects composes of the following fields:

*An example mapping would be:* `user.external_system_identities.jira_service_desk.external_id`

| fields       | description                                 |
| :----------- | :------------------------------------------ |
| user\_id     | The user ID to log into the external system |
| external\_id | The user UUID in the external system        |

Refer to this [article](/ai-assistant/ai-assistant/analytics-performance/configure-analytics-and-data) to learn about registering a custom user attribute.

# Example & Schema

```json
{
  "user": {
    "custom_attributes": {
      "office_location": "Building 4, Floor 12",
      "primary_skill": "Network troubleshooting"
    },
    "first_name": "Jane",
    "last_name": "Doe",
    "email_addr": "jane.doe@example.com",
    "role": "Senior IT Agent",
    "department": "Global IT",
    "manager_email": "manager.smith@example.com",
    "full_name": "Jane Doe",
    "employee_id": "987654",
    "cost_center_id": "IT-456-US",
    "cost_center_name": "US IT Operations",
    "work_status": "FULL_TIME",
    "country_code": "US",
    "timezone": "America/New_York",
    "region": "NA-East",
    "city": "New York",
    "state": "NY",
    "user_tags": ["VIP", "IT_AGENT", "HAS_ACCESS_TO_BOT"],
    "external_system_identities": {
      "jira_service_desk": {
        "user_id": "janedoe_jira",
        "external_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
      },
      "workday": {
        "user_id": "987654",
        "external_id": "o9p8q7r6-s5t4-3210-u1v2-w3x4y5z6a7b8"
      }
    }
  }
}

```

```json Schema
{
  "user": {
    "custom_attributes": {
      "type": "obj",
      "description": "This can be used to dot walk into custom attributes"
    },
    "first_name": {
      "type": "string",
      "description": "The user's first name"
    },
    "last_name": {
      "type": "string",
      "description": "The user's last name"
    },
    "email_addr": {
      "type": "string",
      "description": "The user's email"
    },
    "role": {
      "type": "string",
      "description": "The user's role"
    },
    "department": {
      "type": "string",
      "description": "The user's department"
    },
    "manager_email": {
      "type": "string",
      "description": "The user's manager email"
    },
    "full_name": {
      "type": "string",
      "description": "The user's full name"
    },
    "employee_id": {
      "type": "string",
      "description": "The user's employee ID"
    },
    "cost_center_id": {
      "type": "string",
      "description": "The user's cost center ID"
    },
    "cost_center_name": {
      "type": "string",
      "description": "The user's cost center name"
    },
    "work_status": {
      "type": "enum",
      "description": "The user's work status",
      "options": [
        "UNKNOWN_WORK_STATUS",
        "CONTINGENT",
        "INTERN",
        "FULL_TIME"
      ]
    },
    "country_code": {
      "type": "string",
      "description": "The user's country code"
    },
    "timezone": {
      "type": "string",
      "description": "The user's timezone"
    },
    "region": {
      "type": "string",
      "description": "The user's region"
    },
    "city": {
      "type": "string",
      "description": "The user's city"
    },
    "state": {
      "type": "string",
      "description": "The user's state"
    },
    "user_tags": {
      "type": "enum",
      "description": "The user's assigned user tags",
      "options": [
        "UNKNOWN_USER_TAG",
        "BASIC_USER",
        "VIP",
        "FIELD_AGENT",
        "KNOWLEDGE_WORKER",
        "IT_AGENT",
        "TESTER",
        "SUPPORTED_LANGUAGE_USER",
        "SERVICE_ACCOUNT",
        "CALL_CENTER",
        "HAS_ACCESS_TO_BOT",
        "DIRECTOR",
        "EXECUTIVE",
        "SOCIAL_AUTH_USER"
      ]
    },
    "external_system_identities": {
      "type": "map",
      "description": "The user's system related info",
      "structure": {
        "shape": "<string, ExternalSystemIdentity>",
        "value_object_fields": {
          "user_id": {
            "description": "The user ID to log into the external system"
          },
          "external_id": {
            "description": "The user UUID in the external system"
          }
        },
        "example_mapping": "user.external_system_identities.jira_service_desk.external_id"
      }
    }
  }
}
```

<br />