サービス アカウントで Jira または Confluence API にアクセスすると 401 Unauthorized エラーが発生する

要約

サービス アカウントを使用して Jira または Confluence Cloud の REST API とやり取りしようとした際に、レスポンス コード 401 が返される、またはレスポンスに権限に関する問題が示されることがあります。

API トークンには次の 2 種類があります。

• 一般的な API トークン

• より詳細な権限範囲を指定できるスコープ付き API トークン

サービス アカウントで作成できるのは、スコープ付き API トークンのみです。

ソリューション

正しい API エンドポイント URL を使用していることを確認する

サービス アカウントに関するドキュメントに記載されているとおり、スコープ付き API トークンを使用する場合、REST API へのアクセスには異なる URL 構造を使用します。たとえば次のようになります。

• Jira のスコープ付き API トークン用 API URL: https://api.atlassian.com/ex/jira/<cloudId>/{api}

  • 使用しない URL: https://<your-domain>.atlassian.net/{api}

• Confluence のスコープ付き API トークン用 API URL: https://api.atlassian.com/ex/confluence/<cloudid>/{api}

  • 使用しない URL: https://<your-domain>.atlassian.net/{api}

サービス アカウントの API トークン使用時に API からエラーが返される場合は、API トークンの種類に応じた適切な URL 形式を使用してください。

サードパーティ統合で発生するエラー

 統合機能では、Jira への接続時にユーザー アカウントと API トークンの入力を求められることがあります。このような統合機能は、API トークンに 2 種類あり、それぞれに対応する URL 形式も 2 種類存在することを認識していない可能性が高く、また、トークン自体からその違いを判別する方法もありません。

統合機能で API トークンが必要とされていても、どの種類が必要か明示されていない場合は、スコープなしの API トークンが求められていると考えられます。サービス アカウント用に生成されるスコープ付き API トークンは、アプリ側で明示的に対応するよう開発されていない限り、その統合機能では利用できません。統合機能とサービス アカウントの組み合わせで問題が発生した場合は、スコープ付き API トークンをサポートしているかどうかを確認するため、サードパーティ製アプリのベンダーにお問い合わせください。

「CLOUD-12617: 権限エラーを回避するため、スコープ付き API トークンで Web リクエストを送信する際に atlassian.net へのサポートを追加する」を参照してください。この要望は、スコープ付き API トークンが mysite.atlassian.net の URL 形式をサポートすることを求めるものです。