サービスアカウント用の OAuth 2.0 認証情報を作成する

サービスアカウントに OAuth 2.0 認証情報を使用するには、一元化されたユーザー管理エクスペリエンスを利用している必要があります。

OAuth 2.0 は承認の業界標準プロトコルです。OAuth 2.0 認証情報は、アプリに権限を与えて、サービスアカウントに代わって Jira などのリソースにパスワードなしに安全にアクセスできるようにするものです。

OAuth 2.0 認証情報を使用すると、人間の介入なしに、サービスアカウントを使用して安全かつ自動的に API にアクセスできます。Clockify と Jira を統合して課題の解決にかかった時間を測定するなど、タスクを安全に自動化し、統合を実行できます。

サービスアカウントは、クライアント ID とクライアントシークレットを含む OAuth 2.0 認証情報を使用して身元情報を証明します。サービスアカウントが OAuth 2.0 認証情報で認証すると、アトラシアン API を安全に呼び出すことができます。

OAuth 2.0 認証情報の使用方法

主なユースケースは、アプリやサービスに対してアトラシアン API へのアクセスを許可することです。サードパーティの OAuth アプリを統合して、アトラシアン API にアクセスできます。スクリプトの実行にも使用できますが、トークンのローテーションを管理する必要があります。トークンがローテーションされた場合は、スクリプトで API を再度呼び出す必要があります。

OAuth 2.0 認証情報を作成すると、client_id と client_secret が生成されます。その後、Atlassian Cloud アプリにアクセスする際にクライアント ID とクライアントシークレットを使用するようにアプリやスクリプトを設定できます。以降、OAuth 2.0 アクセストークンを使用してアプリやスクリプトにアクセスできるようになります。

OAuth 2.0 認証情報を使用して Atlassian アプリ API にアクセスする方法

client_id と client_secret を使用して https://auth.atlassian.com/oauth/token に POST リクエストを送信し、60 分間有効な OAuth 2.0 アクセストークンを取得します。
1. たとえば、grant_type=client_credentials を使用して OAuth 2.0 アクセストークンを取得できます。これは 2-legged OAuth 2.0 フロー (2LO) です。
  curl --location 'https://auth.atlassian.com/oauth/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'client_id=${client_id}' \ --data-urlencode 'client_secret=${client_secret}' \ --data-urlencode 'grant_type=client_credentials'
  次のようなレスポンスで ACCESS_TOKEN を受け取ります。
  { "access_token": "${ACCESS_TOKEN}", "expires_in": 3600, "token_type": "Bearer", "scope": "${OAuth scopes list}" }
API 呼び出しを行う際には、Authorization ヘッダーに ACCESS_TOKEN をベアラートークンとして含めてください。

たとえば、API を呼び出して Jira ボード上に特定の Jira 課題を取得する場合などです。ACCESS_TOKEN を Authorization ヘッダーに含めて次の API を呼び出します:

curl --request GET \
  --url https://api.atlassian.com/ex/jira/{cloudId}/rest/api/2/issue/{ISSUE_KEY} \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'Accept: application/json'

固定長ではなく可変長の OAuth 2.0 認証情報を使用することで、OAuth 2.0 認証情報がより安全で信頼性の高いものになるようにしています。該当するスクリプトに固定長の OAuth 2.0 認証情報が使用されている場合は、可変長を処理できることを確認してください。

OAuth 2.0 認証情報を作成する

OAuth 2.0 認証情報を作成する際には、認証情報に名前を付けてその目的を説明できます。

OAuth 2.0 認証情報のスコープとは

サービスアカウント用の OAuth 2.0 認証情報では既定でスコープが使用されます。OAuth 2.0 認証情報のスコープは、Atlassian アプリのデータへのアクセスレベルを定義するものです。OAuth 2.0 認証情報を作成する際に、そのアクセスレベルを選択します。

認証情報のスコープを選択すると、OAuth 2.0 認証情報に特定のアクションを実行する権限が付与されます。Jira と Confluence のスコープのみを選択できます。

API 呼び出しでサポートされている URL は api.atlassian.com です。

API 呼び出しの構築形式

Jira 公開 API	Confluence 公開 API
`https://api.atlassian.com/ex/jira/<cloudId>/{api}` であり、`https://your-domain.atlassian.net/{api}` ではない	`https://api.atlassian.com/ex/confluence/{cloudid}/{api}` であり、`https://your-domain.atlassian.net/{api}` ではない