EN 日本語
GitHub

Authentication

Japanese translation unavailable

This page has not been translated into Japanese yet - we apologise for the inconvenience! If you’re interested in helping us out, feel free to translate any article in the jp folder of the DevCenter repository and open a PR!

このページは日本語への翻訳がまだ完了しておりません。ご不便をおかけして申し訳ございません！ もしお手伝いできる方がいらっしゃれば、ご自由にjpフォルダの記事を日本語に訳していただき、PRを開いてください！

Authentication ⚓

The current API supports only one type of authentication: user generated Personal Access Tokens. Organizations do not have their own access tokens.

Every API endpoint requires authentication, except the “root” URL (https://api.bitrise.io).

Acquiring a Personal Access Token ⚓

  1. Sign in on bitrise.io.
  2. Go to your Account Settings page.
  3. Select the Security tab on the left side.
  4. Click the Generate new token button to create a new Personal Access Token.
  5. Save the generated token.

Availability of the generated token

The generated token is shown only once: when it’s generated. There’s no way to see the token value again! You can of course generate as many Access Tokens as you like, and delete the ones you don’t need anymore.

Authenticating with the API ⚓

To provide the required access token, you have to add a HEADER to your requests, with the key Authorization and the value of your token.

An example API call with auth, using curl:

curl -H 'Authorization: THE-ACCESS-TOKEN' https://api.bitrise.io/v0.1/me