Dashboard > Pulse v1.2 > ... > Remote API Functions > RemoteApi.login
  Pulse v1.2 Log In | Sign Up   View a printable version of the current page.  
  RemoteApi.login
Added by Jason Sankey, last edited by Jason Sankey on Apr 30, 2006
Labels: 
(None)

Pulse Manual Index

Synopsis

string login(string username, string password)

Parameters

Parameter Type Description
login string The name of the user to log in as.
password string The password of the user to log in as.

Returns

A token that may be used as credentials for further calls to the API.

Description

Attempts to log in with the given credentials and, if successful, returns a token representing a new remote API session. The token will be valid for 30 minutes after this function returns. To explicitly invalidate the token, call RemoteApi.logout.

Zutubi wiki is Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.2.10 Build:#528 Nov 29, 2006) - Bug/feature request - Contact Administrators