Difference between revisions of "XML-RPC Protocol Method: sessionexpire"

Revision as of 17:12, 19 September 2010

Using this request mode, you can expire previously generated sessions, whether you generated them using the sessiongenerate call or the user logged in on the web site.

Inputs

username Scalar. Required. Username of user logging in.

auth_method Scalar. Optional. Authentication method used for this request. The default value is "clear", for plain-text authentication. "cookie" and any of the challenge-response methods are also acceptable.

password Deprecated. Scalar. Optional. Password of user logging in in plaintext. If using the "clear" authentication method, either this or "hpassword" must be present.

hpassword Deprecated. Scalar. Optional. MD5 digest of user's password. Not much more secure than password, but at least it's not in plain text.

auth_challenge Scalar. Optional. If using challenge-response authentication, this should be the challenge that was issued to you by the server.

auth_response Scalar. Optional. If using challenge-response authentication, this should be the response hash that you generate, based on the formula required for your challenge.

ver Scalar. Optional. Protocol version supported by the client; assumed to be 0 if not specified. See Protocol Versions for details on the protocol version.

expireall Scalar. Optional. If present and true, then all of the user's sessions will be expired.

expire Array of scalars. Optional. Given a list of session ids, will expire each one individually. Session ids can be obtained from previous calls to sessiongenerate--notably, the id is the third field in the session.

Example Request

POST /interface/xmlrpc HTTP/1.0
User-Agent: XMLRPC Client 1.0
Host: www.dreamwidth.org
Content-Type: text/xml
Content-Length: 542
 
<?xml version="1.0"?>
<methodCall>
  <methodName>LJ.XMLRPC.sessionexpire</methodName>
  <params>
    <param>
      <value><struct>
        <member>
          <name>username</name>
          <value><string>test</string></value>
        </member>
        <member>
          <name>password</name>
          <value><string>test</string></value>
        </member>
        <member>
          <name>ver</name>
          <value><int>1</int></value>
        </member>
        <member>
          <name>expireall</name>
          <value><int>1</int></value>
        </member>
      </struct></value>
    </param>
  </params>
</methodCall>

Outputs

None.

Example Response

HTTP/1.1 200 OK
Connection: close
Content-length: 1189
Content-Type: text/xml
Date: Fri, 26 Mar 2004 18:39:38 GMT
Server: Apache/1.3.4 (Unix)
 
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value><struct><struct/></value>
    </param>
  </params>
</methodResponse>