API login

From FreeDESK
Revision as of 18:49, 21 August 2012 by Dave (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
login
Call/Mode: login
Description: Open a user session
Parameters: username, password
Returned Data: XML login error or session data

This article details a FreeDESK API call.

Description

The login call allows the establishment of a ContextType::User session

Using the Call

Pass in the following parameters using GET or POST

  • username : Analyst username
  • password : Analyst password

For example

api.php?mode=login&username=someuser&password=theirpassword

Returned Data

XML containing either the SID on success or a FreeDESK error on failure.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox