Jump to >

This documentation covers the in-development release of RBTools. You can see the latest stable docs or all previous versions.

Authenticating to Review Board

Most RBTools commands require authenticating to a Review Board server. If you are not currently logged in, RBTools will prompt you to do so.

Login Sessions

When running a command which requires authenticating with the server, RBTools will prompt you for your username and password. You can also do this explicitly by running rbt login.

After logging in, your session will be stored in the .rbtools-cookies file. Depending on how the server is set up, these sessions will periodically expire.

Using Single Sign-On?

When Review Board is configured to use Single Sign-On, you may not have a password to use to log in with RBTools. In this case, you’ll need to authenticate using API Tokens.

Using API Tokens

Instead of a username and password, RBTools can authenticate to the server using an API token. This has the additional benefit that tokens can be limited in their scope, and can be individually created and revoked as necessary.

API Tokens can be created inside Review Board by selecting My Account, and then choosing Authentication. See Creating API Tokens for details.

After you have an API token, you can either pass it to rbt login, or you can store it in your personal .reviewboardrc file.

$ rbt login --api-token <token>

In .reviewboardrc:

API_TOKEN = "<token>"