This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

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 and create an authentication token. Returns the token if login was successful, or returns an error otherwise.

Arguments:

Parameter Name

説明

username

username to authenticate with

パスワード

password corresponding to the username

URL:

/api/rest/login.action

例:

/api/rest/login.action?username=bob&password=bobsPassword

Successful Response:

<response>
    <auth>AuthenticationIdentifier</auth>
</response>

例:

<response>
    <auth>aU5ybWbzfw</auth>
</response>

ログアウト

Disables the given authentication token.

Arguments:

Parameter Name

説明

auth

authentication token for the session to log out from

URL:

/api/rest/logout.action

例:

/api/rest/logout.action?auth=aU5ybWbzfw

Successful Response:

<response>
<auth/>
</response>
  • ラベルなし