McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 45

↗ View in doc context
page
45
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::29

User APIs User—Sign In to Finesse The User—Sign in to Finesse API allows a user to sign in to the CTI server. If the response is successful, the user is signed in to Finesse and is automatically placed in NOT_READY state. If five consecutive sign-ins fail due to an incorrect password, Finesse blocks access to the user account for a period of 5 minutes. This API forces a sign-in. That is, if the user is already signed in, that user is authenticated via the sign-in process. If the user's credentials are correct, the user is signed in again but the user keeps the current state. For example, if a user signs in, changes state to Ready, and then signs in again, the user remains in Ready state. To sign in as a mobile agent, see User—Sign In as a Mobile Agent, on page 30. Note https://<FQDN>/finesse/api/User/<id> URI: https://finesse1.xyz.com/finesse/api/User/1234 Example URI: Users can only act on their own User objects. Security Constraints: PUT HTTP Method: Application/XML Content Type: XML Input/Output Format: <User> <state>LOGIN</state> <extension>1001001</extension> </User> HTTP Request: id (required): The ID of the user state (required): The new state that the user wants to be in (LOGIN) extension (required): The extension with which the user wants to sign in Request Parameters: 202: Success 400: Bad Request (for example, malformed or incomplete request, invalid extension) 400: Parameter Missing 401: Unauthorized (for example, the user is not authenticated in the Web Session) 404: Not Found (for example, the user ID is not known) 503: Service Unavailable (for example, the Notification Service is not running) HTTP Response: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 29 Cisco Finesse Desktop APIs User APIs

Image 1 from page 45