{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserDTO",
  "title": "UserDTO",
  "type": "object",
  "description": "The request object for creating or updating a user in the contact center.",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "firstName": {
      "type": "string",
      "description": "The first name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
      "example": "John",
      "minLength": 1
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
      "example": "Wick",
      "minLength": 1
    },
    "email": {
      "type": "string",
      "description": "The email address of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
      "example": "johnwick@company.com",
      "minLength": 1
    },
    "workPhone": {
      "type": "string",
      "description": "The work phone number of the user.",
      "example": "1234567890",
      "maxLength": 20,
      "minLength": 0
    },
    "mobile": {
      "type": "string",
      "description": "The mobile phone number of the user.",
      "example": "1234567890",
      "maxLength": 20,
      "minLength": 0
    },
    "ciUserId": {
      "type": "string",
      "description": "Cisco Common Identity user Id. Existence of a CI user is a prerequisite to create a new WxCC user. It cannot be modified.",
      "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
      "minLength": 1
    },
    "broadCloudUserId": {
      "type": "string",
      "description": "Broadcloud user Id. This field cannot be modified.",
      "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
    },
    "userProfileId": {
      "type": "string",
      "description": "Identifier for an user profile which a Contact Center administrator has configured. Changing the profile type requires a token with `FLS:Read_Scope` scope.  As of today, changing the profile type for a user is supported only from Cisco Webex Control Hub.",
      "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
      "minLength": 1
    },
    "contactCenterEnabled": {
      "type": "boolean",
      "description": "The setting is for accessing the Agent Desktop to handle customer requests.",
      "example": true
    },
    "timezone": {
      "type": "string",
      "description": "(Optional) The time zone that you provision for your enterprise.",
      "example": "America/New_York"
    },
    "xspVersion": {
      "type": "string",
      "description": "(Optional) Used to subscribe for recording events. This field cannot be modified.",
      "example": "xsp-24.0",
      "maxLength": 80,
      "minLength": 0
    },
    "subscriptionId": {
      "type": "string",
      "description": "(Optional) Used to subscribe for recording events. This field cannot be modified.",
      "example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
      "maxLength": 80,
      "minLength": 0
    },
    "siteId": {
      "type": "string",
      "description": "(Optional) Identifier for a site which is a physical contact center location under the control of your enterprise. This field is applicable only when contactCenterEnabled is true.",
      "example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
    },
    "teamIds": {
      "type": "array",
      "description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team. This field is applicable only when contactCenterEnabled is true.",
      "example": [
        "f53c8b54-46ca-43f6-ba05-08426a46e23d",
        "a53c8b54-46ca-43f6-ba05-08426a46e23f"
      ],
      "items": {
        "type": "string",
        "description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team. This field is applicable only when contactCenterEnabled is true.",
        "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
      },
      "uniqueItems": true
    },
    "skillProfileId": {
      "type": "string",
      "description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent.This field is applicable only when contactCenterEnabled is true.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "agentProfileId": {
      "type": "string",
      "description": "Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. This field is applicable only when contactCenterEnabled is true.",
      "example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
    },
    "multimediaProfileId": {
      "type": "string",
      "description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. This field is applicable only when contactCenterEnabled is true.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "deafultDialledNumber": {
      "type": "string",
      "description": "(Optional) The dial number of the agent. This field is applicable only when contactCenterEnabled is true.",
      "example": "1234567890"
    },
    "externalIdentifier": {
      "type": "string",
      "description": "(Optional) Agent identification details, such as the employee number.",
      "example": "121212"
    },
    "active": {
      "type": "boolean",
      "description": "Indicates whether the user is active or not active. Can be changed using Users Management in Cisco Webex Control Hub.",
      "example": true
    },
    "imiUserCreated": {
      "type": "boolean",
      "description": "(Optional) Indicates whether this user has a corresponding user created in IMI digital channel. This field cannot be modified.",
      "example": false
    },
    "preferredSupervisorTeamId": {
      "type": "string",
      "description": "(Optional) Indicates the id of a preferred supervisor.",
      "example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
    },
    "userLevelBurnoutInclusion": {
      "type": "string",
      "description": "User level burnout inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Agent Wellbeing>Burnout config.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.",
      "enum": [
        "INCLUDED",
        "EXCLUDED"
      ],
      "example": "INCLUDED"
    },
    "userLevelAutoCSATInclusion": {
      "type": "string",
      "description": "User level AutoCSAT inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Cisco AI Assistant>Auto CSAT config.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.",
      "enum": [
        "INCLUDED",
        "EXCLUDED"
      ],
      "example": "INCLUDED"
    },
    "userLevelWellnessBreakReminders": {
      "type": "string",
      "description": "User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders.\n",
      "enum": [
        "DISABLED",
        "ENABLED"
      ],
      "example": "DISABLED"
    },
    "userLevelSummariesInclusion": {
      "type": "string",
      "description": "User level Generated Summaries inclusion type. Used only when Generated Summaries is set to 'Specific Agents' at the org level Cisco AI Assistant>Generated Summaries.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.",
      "enum": [
        "INCLUDED",
        "EXCLUDED"
      ],
      "example": "INCLUDED"
    },
    "dynamicSkills": {
      "type": "array",
      "description": "The list of dynamic skills assigned to the user",
      "example": [
        {
          "organizationId": "21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7",
          "skillId": "2683334c-abec-4c0b-a6b1-211bd81d1b4b",
          "textValue": "abc"
        },
        {
          "organizationId": "21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7",
          "skillId": "2683334c-abec-4c0b-a6b1-211bd81d1b4b",
          "proficiencyValue": 7
        }
      ],
      "items": {
        "$ref": "#/components/schemas/AssignedDynamicSkillsDTO"
      }
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity."
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity."
    }
  },
  "required": [
    "active",
    "ciUserId",
    "contactCenterEnabled",
    "email",
    "firstName",
    "lastName",
    "userProfileId"
  ]
}