{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/UserResponseDTO", "title": "UserResponseDTO", "type": "object", "description": "The response object representing 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.", "example": "John" }, "lastName": { "type": "string", "description": "The last name of the user.", "example": "Wick" }, "email": { "type": "string", "description": "The email address of the user.", "example": "johnwick@company.com" }, "workPhone": { "type": "string", "description": "The work phone number of the user.", "example": "1234567890" }, "mobile": { "type": "string", "description": "The mobile phone number of the user.", "example": "1234567890" }, "ciUserId": { "type": "string", "description": "Cisco Common Identity user Id", "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1" }, "broadCloudUserId": { "type": "string", "description": "Broadcloud user Id", "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1" }, "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.", "example": "xsp-24.0" }, "subscriptionId": { "type": "string", "description": "(Optional) Used to subscribe for recording events.", "example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478" }, "userProfileId": { "type": "string", "description": "Identifier for an user profile which a Contact Center administrator has configured.", "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1" }, "userProfileType": { "type": "string", "description": "Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType.", "example": "PREMIUM_AGENT" }, "contactCenterEnabled": { "type": "boolean", "description": "The setting is for accessing Desktop to handle customer requests.", "example": true }, "siteId": { "type": "string", "description": "Details of site which a Contact Center administrator has configured for the user.", "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1" }, "siteName": { "type": "string", "description": "site name that user is associated with", "example": "bengaluru" }, "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.", "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.", "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 ", "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.", "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.", "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d" }, "deafultDialledNumber": { "type": "string", "description": "(Optional) The dial number of the agent.", "example": "1234567890" }, "externalIdentifier": { "type": "string", "description": "(Optional) Agent identification details, such as the employee number.", "example": "121212" }, "active": { "type": "boolean", "description": "Specify whether the user is active or not active.", "example": true }, "dbId": { "type": "string", "description": "Legacy identifier for migrated users.", "example": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1" }, "userProfileData": { "$ref": "#/components/schemas/UserProfileDTO", "description": "Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked." }, "userProfileGranularAccessData": { "$ref": "#/components/schemas/UserProfileGranularAccessDTO", "description": "Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked." }, "imiUserCreated": { "type": "boolean", "description": "Specify whether or not the corresponding user is created in IMI.", "example": true }, "preferredSupervisorTeamId": { "type": "string", "description": "The teamId to look for to load the desktop layout when a supervisor logs in to desktop.", "example": "e27d2b54-46ca-43g6-ba65-08426e46e23d" }, "systemDefault": { "type": "boolean", "description": "Indicates whether the created resource is system created or not", "example": false }, "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.\n", "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.\n", "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.\n", "enum": [ "INCLUDED", "EXCLUDED" ], "example": "INCLUDED" }, "queuesCount": { "$ref": "#/components/schemas/QueuesCountDTO", "description": "The count of each type of Contact Service Queues that the user is assigned to.\n", "example": "{\n \"teamBased\": 0\n \"skillBased\": 0\n \"agentBased\": 0\n}" }, "skillProfileUpdatedBy": { "type": "string", "description": "The ID of the user who last modified the skill profile", "example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1" }, "dynamicSkills": { "type": "array", "description": "The list of dynamic skills associated with the user", "items": { "$ref": "#/components/schemas/AssignedDynamicSkillsDTO" } }, "dynamicSkillsLimitReached": { "type": "boolean", "description": "Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request.", "example": true }, "dynamicSkillsUpdatedBy": { "type": "string", "description": "The name of the user who last modified dynamic skills" }, "dynamicSkillsUpdatedTime": { "type": "integer", "format": "int64", "description": "The date when dynamic skills were last modified", "example": 1679393400000 }, "dynamicSkillAssigned": { "type": "boolean", "description": "Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request.", "example": true }, "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." }, "skillProfileUpdatedTime": { "type": "integer", "format": "int64", "description": "The date when the skill profile was last modified", "example": 1679393400000 } } }