Confluence で REST API 認証をセットアップするためのステップバイステップ ガイド

Confluence 用の miniOrange REST API 認証アドオンを使用して OAuth 2.0/OpenID Connect 認証を設定する手順:

注： ここでは例として miniOrange OAuth プロバイダーを使用しました。 このアドオンは、Azure AD、Keycloak、Okta、Gsuite (Google アプリ)、AWS Cognito、Github、Gitlab などのカスタム OAuth 2.0/OpenID 接続プロバイダーをサポートします。

ステップ 1: クライアント アプリケーションと OAuth 2.0/OpenID Connect プロバイダー間の OAuth フローをセットアップします。

• 1. クライアントアプリケーション: Confluence REST API にアクセスしたいサービスまたはユーザーです。
  2. miniOrange とクライアント アプリケーションの間に OAuth フローを設定する必要があります。 クライアント アプリケーションは、Confluence REST API を呼び出す任意のサービスまたはユーザーです。
  3. ユーザーを認証し、アクセス トークンを取得するために使用されます。  Note: このフローは、クライアント アプリケーションと miniOrange OAuth プロバイダーの間で設定されます。 REST API 認証アドオンは、このプロセスには関与しません。 アプリケーションが OAuth 2.0 をサポートしていない場合は、次のアドレスにメールを送信してください。 info@xecurify.com.
  4. このリンクのステップバイステップガイドを使用して、miniOrange を OpenID プロバイダーとして設定します。 miniOrange を OpenID Connect プロバイダーとしてセットアップします。
  5. miniOrange を OAuth プロバイダーとして設定した後、次のページに移動します。 アプリ Appsの管理。 miniOrange で作成したアプリの横にある [編集] リンクをクリックします。
  6. コピー ユーザー情報エンドポイント.

ステップ 2: REST API 認証アドオンでイントロスペクション エンドポイントを構成します。

• 1. イントロスペクションエンドポイント: イントロスペクション エンドポイントは、OAuth/OpenID プロバイダーのエンドポイントです。 アクセストークンを使用して呼び出すことができます および ユーザー名を返します に応じて。
  2. 選択 カスタムOAuthプロバイダー セクションに OAuthプロバイダー 設定タブ
  3. 入力する ユーザー情報エンドポイント ステップ 1 で「イントロスペクション エンドポイント」フィールドにコピーしたもの。 こんな感じです。
     https://login.xecurify.com/moas/rest/oauth/getuserinfo
  4. miniOrange のユーザー情報エンドポイントは、次のような応答を返します。

     { "sub": "demouser"、"firstname": "Demo"、"email": "demo@example.com"、"username": "demouser"、"lastname": "User" }

  5. ユーザー名の属性: イントロスペクション エンドポイント応答内のこのキーは、どのユーザーが API 呼び出しを行っているかをプラグインに伝えます。
  6. 上記の応答では、 ユーザ名 属性には、API 呼び出しを行う人の Confluence ユーザー名が含まれます。 したがって、ユーザー名は username 属性として入力されます。 したがって、プラグインは、Confluence ユーザー「demouser」が API 呼び出しを行っていることを認識します。

ステップ 3: miniOrange OAuth プロバイダーからアクセス トークンを取得します。

• 1. miniOrange を使用して OAuth フローを開始します。 今回のOAuthフローはこんな感じです。

ステップ 4: アクセス トークンを使用して Confluence REST API を使用します。

• 1. Confluence の任意の REST API を呼び出します。 Authorization ヘッダーにアクセス トークンを含めます。 ここではページ API の作成例を示します。

要求：

     curl \ -X POST \ -H "認可: Bearer " \ -H "コンテンツ タイプ: application/json" \ --data {下記を参照} \ http://localhost:8090/confluence/rest/api/content/|phython-mjson.tool \

入力データ：

     { "type":"page", "title":"新しいページ", "space":{ "key":"TST" }, "body":{ "storage":{ "value":" これは新しいページ", "表現":"ストレージ" } } }

これは、miniOrange プラグインを使用した REST API 認証のフロー図です。