メインコンテンツまでスキップ

Workspace APIトークン

Workspace API トークンを使用すると、Workspace のメンバーは、各自で Personal Access Token を設定しなくても Bitrise API にアクセスできます。API 認証では、Workspace トークンは Personal Access Token とまったく同じように機能します。Bitrise CLI でのログインにも使用できます。

Workspace のオーナーは、複数の Workspace API トークンを設定できます。各トークンには、Workspace が所有するアプリに対して異なるアクセス権を付与できます。アクセス権は、Workspace のメンバーやWorkspace のグループと同様に、ユーザーロールによって決まります。

アクセストークンが必要なインテグレーションを API アクセス用に設定する場合は、個々のユーザーの Personal Access Token ではなく、Workspace API トークンを使用することをお勧めします。

Workspace API トークンの作成Click to copy link​

  1. BitriseにLog inし、左側のナビゲーションバーにカーソルを合わせます。

  2. Workspaceメニューで、正しいworkspaceが選択されていることを確認します。

  3. Settingsを選択します。

  4. 左側で Security を選択します。

  5. Create token をクリックします。

    workspace-api-token.svg

  6. Settings ステップで、トークンの Name を入力し、Expiration を選択します。

  7. トークンの Workspace role を選択します。これにより、トークンが workspace レベルで実行できる操作が決まります。

  8. トークンの有効期限が切れる前に Bitrise から Workspace のオーナーにメールを送信するには、Notify workspace owners before this token expires のチェックを入れたままにします。送信が不要な場合は、チェックを外してください。有効期限通知メールを参照してください。

  9. Next をクリックします。

  10. Product access ステップで、トークンがアクセスできる対象を設定します。

    • Admin access をオンにすると、トークンが selected projects のあらゆる側面を管理でき、すべてのプロダクトにアクセスできるようになります。
    • Bitrise CI をオンにすると、トークンが CI ビルドにアクセスできるようになります。Apply to: All projects または Selected projects を選択し、Role を選択するか、No access のままにします。
    • Release Management をオンにすると、トークンが Release Management にアクセスできるようになります。権限は、アプリレベルのロールによって制御されます。
    • Remote Dev Environments をオンにすると、トークンが workspace の Remote Dev Environments を操作できるようになります。たとえば、CI からデバイスプレビューリンクを発行できます。トークンが作成したセッションは、workspace が所有します。
  11. Create token をクリックします。

  12. Copy and close をクリックしてトークンをコピーし、ダイアログボックスを閉じます。

    トークンを保存する

    ダイアログボックスを閉じると、トークンを再び表示することはできません。

有効期限通知メールClick to copy link​

Workspace API トークンを作成すると、デフォルトで Notify workspace owners before this token expires にチェックが入っています。この場合、トークンの有効期限が切れる前に、Bitrise が Workspace のすべてのオーナーにメールを送信します。これにより、インテグレーションやスクリプトが動作しなくなる前に、トークンを再生成するか、新しいトークンを作成できます。メールが届くタイミングは、選択した有効期限によって異なります。

  • 6 months または 3 months: トークンの有効期限の 30 日前と 7 日前。
  • 1 month または 2 weeks: トークンの有効期限の 7 日前。

有効期限のないトークンや、1 day、1 hour など有効期限が 7 日未満のトークンでは、通知をオンにできません。この設定は、トークンを再生成しても、異なる有効期限を選択しても、そのトークンに引き継がれます。既存のトークンの設定は変更できません。通知をオンまたはオフにするには、new tokenを作成してください。

たとえば、有効期限のないトークンを作成したとします。通知は利用できないため、設定はオフになります。その後、有効期限を 6 months にしてトークンを再生成しても、通常であれば通知が送信される設定ですが、このトークンは通知を送信しません。再生成では設定が変わらないためです。このトークンで通知を受け取るには、新しいトークンを作成してください。

Workspace API トークンの再生成Click to copy link​

Workspace API トークンを何らかの理由で紛失した場合、そのトークンを再び表示する方法はありません。既存のトークンを再生成することもできます。この方法なら、まったく新しい new token を作成して、アプリへのアクセスを再度設定する必要はありません。再生成されたトークンには、次の特徴があります。

  • 新しい有効期限が設定されます。
  • 以前とまったく同じアプリに対して、まったく同じロールでアクセスできます。
  • 有効期限通知の設定が維持されます。
  1. BitriseにLog inし、左側のナビゲーションバーにカーソルを合わせます。

  2. Workspaceメニューで、正しいworkspaceが選択されていることを確認します。

  3. Settingsを選択します。

  4. 左側で Security を選択します。

  5. 対象のトークンを見つけて、名前の横にあるオプションメニュー(⋮)をクリックします。

  6. Regenerate を選択します。

    regenerate-token.png

  7. 新しい有効期限を選択します。

  8. Regenerate をクリックして、new tokenを取得します。

  9. Copy and close をクリックします。

    トークンは安全な方法で保存してください。トークンを再び表示することはできません。