# The User object

## Attributes

- `active` (boolean)
  If this user is active
- `displayName` (string)
  String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.
- `emails` (array of object)
  All the emails associated with the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.
  - `display` (string)
  - `primary` (boolean)
  - `$ref` (string)
  - `type` (string)
  - `value` (string)
- `entitlements` (array of object)
  Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.
  - `display` (string)
  - `primary` (boolean)
  - `$ref` (string)
  - `type` (string)
  - `value` (string)
- `externalId` (string)
  External ID is not currently supported. It is reserved for future use.
  Constraints: `<= 64 characters`
- `groups` (array of object)
  - `display` (string)
  - `primary` (boolean)
  - `$ref` (string)
  - `type` (string)
  - `value` (string)
- `id` (string)
  <Databricks> user ID.
- `name` (object)
  - `familyName` (string)
    Family name of the <Databricks> user.
  - `givenName` (string)
    Given name of the <Databricks> user.
- `roles` (array of object)
  Corresponds to AWS instance profile/arn role.
  - `display` (string)
  - `primary` (boolean)
  - `$ref` (string)
  - `type` (string)
  - `value` (string)
- `schemas` (array of string)
  The schema of the user.
  Possible values: `USER_SCHEMA_UNSPECIFIED`, `URN_IETF_PARAMS_SCIM_SCHEMAS_CORE_2_0_USER`, `URN_IETF_PARAMS_SCIM_SCHEMAS_EXTENSION_WORKSPACE_2_0_USER`
- `userName` (string)
  Email address of the <Databricks> user. This attribute cannot be updated through the SCIM PATCH or PUT APIs; any supplied change is ignored.

## Example

```json
{
  "active": true,
  "displayName": "string",
  "emails": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "entitlements": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "externalId": "string",
  "groups": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "roles": [
    {
      "display": "string",
      "primary": true,
      "$ref": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "schemas": [
    "string"
  ],
  "userName": "string"
}
```