Authenticate


Click here for a complete list of operations.

AuthenticateByToken

Authenticate the passed credentials, if it is successful it will return the session id for the cookie parameter 'ASP.NET_SessionId', otherwise an empty string. Passwords should always be MD5 hashed in UTF-16 Little Endian (Unicode).

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /authenticate/v001/authenticate.asmx HTTP/1.1
Host: api.24sevenoffice.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://24sevenOffice.com/webservices/AuthenticateByToken"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateByToken xmlns="http://24sevenOffice.com/webservices">
      <token>
        <ApplicationId>guid</ApplicationId>
        <Id>guid</Id>
      </token>
    </AuthenticateByToken>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateByTokenResponse xmlns="http://24sevenOffice.com/webservices">
      <AuthenticateByTokenResult>
        <Id>guid</Id>
        <Email>string</Email>
        <Identities>
          <Identity>
            <Id>guid</Id>
            <User xsi:nil="true" />
            <Client xsi:nil="true" />
            <IsCurrent>boolean</IsCurrent>
            <IsDefault>boolean</IsDefault>
            <IsProtected>boolean</IsProtected>
            <Servers xsi:nil="true" />
            <IsDisabled>boolean</IsDisabled>
          </Identity>
          <Identity>
            <Id>guid</Id>
            <User xsi:nil="true" />
            <Client xsi:nil="true" />
            <IsCurrent>boolean</IsCurrent>
            <IsDefault>boolean</IsDefault>
            <IsProtected>boolean</IsProtected>
            <Servers xsi:nil="true" />
            <IsDisabled>boolean</IsDisabled>
          </Identity>
        </Identities>
        <SessionId>string</SessionId>
      </AuthenticateByTokenResult>
    </AuthenticateByTokenResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /authenticate/v001/authenticate.asmx HTTP/1.1
Host: api.24sevenoffice.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AuthenticateByToken xmlns="http://24sevenOffice.com/webservices">
      <token>
        <ApplicationId>guid</ApplicationId>
        <Id>guid</Id>
      </token>
    </AuthenticateByToken>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AuthenticateByTokenResponse xmlns="http://24sevenOffice.com/webservices">
      <AuthenticateByTokenResult>
        <Id>guid</Id>
        <Email>string</Email>
        <Identities>
          <Identity>
            <Id>guid</Id>
            <User xsi:nil="true" />
            <Client xsi:nil="true" />
            <IsCurrent>boolean</IsCurrent>
            <IsDefault>boolean</IsDefault>
            <IsProtected>boolean</IsProtected>
            <Servers xsi:nil="true" />
            <IsDisabled>boolean</IsDisabled>
          </Identity>
          <Identity>
            <Id>guid</Id>
            <User xsi:nil="true" />
            <Client xsi:nil="true" />
            <IsCurrent>boolean</IsCurrent>
            <IsDefault>boolean</IsDefault>
            <IsProtected>boolean</IsProtected>
            <Servers xsi:nil="true" />
            <IsDisabled>boolean</IsDisabled>
          </Identity>
        </Identities>
        <SessionId>string</SessionId>
      </AuthenticateByTokenResult>
    </AuthenticateByTokenResponse>
  </soap12:Body>
</soap12:Envelope>