This page last changed on Feb 23, 2009 by bmccoy.
Bamboo requires authentication to access the remote API. Most methods accept an authentication token parameter.
An authentication token can be acquired (and released) using the login() and logout() methods. The authentication will expire after 30 minutes of inactive use.
Login
Login and create an authentication token. Returns the token if login was successful, or returns an error otherwise.
Arguments:
Parameter Name |
Description |
username |
username to authenticate with |
password |
password corresponding to the username |
URL:
Example:
/api/rest/login.action?username=bob&password=bobsPassword
Successful Response:
<response>
<auth>AuthenticationIdentifier</auth>
</response>
Example:
<response>
<auth>aU5ybWbzfw</auth>
</response>
Logout
Disables the given authentication token.
Arguments:
Parameter Name |
Description |
auth |
authentication token for the session to log out from |
URL:
Example:
/api/rest/logout.action?auth=aU5ybWbzfw
Successful Response:
<response>
<auth/>
</response>
|