GetloginurlUser

The GetloginurlUser request returns a WebEx-generated Web address that can be used to prompt the user for a WebEx sign-in name and password. The password is passed using a one-time login ticket string using the parameter &TK=[loginTicket].

Request

The sample XML document shows an example of a request for authentication of a user trying to access the account with webExID of test1.pass.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostid@acme.com</webExID>
          <password>hostPassword</password>            
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.GetloginurlUser">
            <webExID>hostid</webExID>
        </bodyContent>
    </body>
</serv:message>

The following schema diagram shows the structure of the elements in the getloginurlUser request message.

Collapse Figure 3-12 • Schema diagram of `getloginurlUser`
Drilldown into backURLDrilldown into webExIDDrilldown into bodyContentTypeXSD Diagram of getloginurlUser

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non-global elements, see Elements in WebEx XML Schema Definitions for the User Service.

Response

The sample XML document shows an example of a possible response to the preceding request document.

<?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:GetloginurlUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:userLoginURL>https://sitename.webex.com/sitename/p.php?AT=LI&FN=Fname&LN=Lname&EM=email@domain.com&WID=hostid&TK=ticket&MU=GoBack&BU=</use:userLoginURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The following schema diagram shows the structure of the elements in the GetloginurlUserResponse message.

Collapse XSD Schema Diagram of `GetloginurlUserResponse`
Drilldown into userLoginURL Drilldown into bodyContentTypeXSD Diagram of getloginurlUserResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. These elements are described in “Global Response Elements Showing Results and Errors”.