Dashboard > Pulse v2.0 > ... > Remote API Functions > RemoteApi.login
  Pulse v2.0 Log In | Sign Up   View a printable version of the current page.  
  RemoteApi.login
Added by Jason Sankey, last edited by Jason Sankey on Dec 01, 2008  (view change)
Labels: 
(None)

Pulse Manual Index

Synopsis

string login(string username, string password)

Parameters

Parameter Type Description
username string Login of the user to authenticate as.
password string Password of the user.

Returns

string: An authentication token that can be used as credentials for other method calls.

Faults

Fault Type Fault Reason
AuthenticationException If the user does not exist or the password does not match.

Description

Authenticates as the given user and returns a token that can be used as credentials for other method calls. The returned token is valid for 30 minutes or until explicitly invalidated by a call to RemoteApi.logout.

See Also

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