*SyncAuthorization API

このトピックでは、setSyncAuthorization API と getSyncAuthorization API について説明します。これらの API は、Synchronizer の動作に必要な GCP サービス アカウントの設定と取得に使用されます。これらの API は、Synchronizer が管理プレーンから環境データを取得できるように、Apigee ハイブリッドのインストール手順で使用されます。

setSyncAuthorization

Synchronizer がコントロール プレーンから環境データをダウンロードできるように、必要な権限を設定します。ハイブリッドの適切な機能を有効にするには、この API を呼び出す必要があります。この API は、ハイブリッドのインストール手順で使用されます。

リソース URL

https://apigee.googleapis.com/v1/organizations/your_org_name:setSyncAuthorization

動詞

POST

ヘッダーのパラメータ

名前 値 説明
Authorization:Bearer 有効な OAuth トークン （必須）トークンの取得方法については、ステップ 5: Synchronizer を有効にするをご覧ください。
Content-Type application/json （必須）HTTP コンテンツ タイプ

リクエストの本文

{"identities":["serviceAccount:service-account-name"], ...}
名前 説明 デフォルト 要否
identities serviceAccount:service-account-name 要素の配列。たとえば、複数の環境があり、それぞれに固有の SA を割り当てる場合は、複数のサービス アカウントを指定できます。SA には Apigee Synchronizer 管理者の役割が必要です。名前の形式はメールアドレスと同様です。例: my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com なし はい

API 呼び出しのサンプル

1 つの SA を設定します。

    curl -X POST -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type:application/json" \
      "https://apigee.googleapis.com/v1/organizations/my_org:setSyncAuthorization" \
       -d '{"identities":["serviceAccount:my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com"]}'

2 つの SA を設定します。たとえば、複数の環境があり、それぞれに固有の SA を割り当てる場合は、複数のサービス アカウントを指定できます。

    curl -X POST -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type:application/json" \
      "https://apigee.googleapis.com/v1/organizations/my_org:setSyncAuthorization" \
       -d '{"identities":["serviceAccount:my-synchronizer-sa_1@my_project_id.iam.gserviceaccount.com",
       "serviceAccount:my-synchronizer-sa_2@my_project_id.iam.gserviceaccount.com"]}'

getSyncAuthorization

setSyncAuthorization で 1 つ以上のサービス アカウントが設定されていることを確認するには、getSyncAuthorization を使用します。

https://apigee.googleapis.com/v1/organizations/your_org_name:getSyncAuthorization

動詞

POST

ヘッダーのパラメータ

名前 値 説明
Authorization:Bearer 有効な OAuth トークン （必須）トークンの取得方法については、ステップ 5: Synchronizer を有効にするをご覧ください。
Content-Type application/json （必須）HTTP コンテンツ タイプ

リクエストの本文

空のリクエストの本文を指定してください。

{}

サンプル API の呼び出し

    curl -X POST -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type:application/json" \
      "https://apigee.googleapis.com/v1/organizations/myorg:getSyncAuthorization" \
       -d ''

出力は次のようになります。

    {
      "identities": [
        "serviceAccount:my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com"],
        "etag": "BwWJgyS8I4w="
    }