AuthenticateUser

AuthenticateUser is not required for XML API authentication. This request can be used to convert a Webex API access token to a Webex Meetings XML API sessionTicket. This is useful for developers that already integrate with Webex and want to add Webex Meetings functionality. Webex access token must have spark:all scope for this purpose.

On sites that are managed in Control Hub and have not enabled SSO, frequent password authentication via XML API may cause intermittent errors. authenticateUser can be used to convert user password to a sessionTicket to improve authentication stability. In that case, you would include the password in your securityContext and leave bodyContent empty.

Request

*Element*	*Description*
`accessToken`	Webex access token with spark:all scope

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>username</webExID>
            <siteName>webex_subdomain</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.user.AuthenticateUser">
            <accessToken>ZjJiMjZlMj...~...ae0e10f</accessToken>
        </bodyContent>
    </body>
</serv:message>

Response

*Element*	*Description*
`sessionTicket`	session ticket that will be used in the `securityContext` for XML API requests
`createTime`	creation time for the `sessionTicket`
`timeToLive`	Duration that the `sessionTicket` will be valid

<?xml version="1.0" encoding="UTF-8"?>
<serv:message 
    xmlns:serv="http://www.webex.com/schemas/2002/06/service" 
    xmlns:com="http://www.webex.com/schemas/2002/06/common" 
    xmlns:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:authenticateUserResponse" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:sessionTicket>AAABbKs70Bc...~...MR09SSVRITV8=</use:sessionTicket>
            <use:createTime>1564617600000</use:createTime>
            <use:timeToLive>5400</use:timeToLive>
        </serv:bodyContent>
    </serv:body>
</serv:message>