Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Cloud OAuth API を使用してエンタープライズグループを取得する

このガイドでは、Cloud OAuth API（cloudoauth.googleapis.com）の /groups エンドポイントを使用して、認証された従業員ユーザーのエンタープライズグループメンバーシップを取得する方法について説明します。

/groups エンドポイントは、OpenID Connect（OIDC）統合の分散クレームエンドポイントとして機能し、SCIM 対応および SCIM 非対応の Workforce Identity プールのユーザーに対して、ページ分けされたエンタープライズグループメンバーシップを返します。

始める前に

Workforce Identity プールとプロバイダを構成します。詳細については、Workforce Identity 連携を構成するをご覧ください。
OAuth クライアントを登録し、認証コードをアクセストークンと交換します。詳細については、Cloud OAuth API でトークンを交換するをご覧ください。
Cloud OAuth API を有効にします（有効になっていない場合）。
API を有効にするために必要なロール
API を有効にするには、serviceusage.services.enable 権限が必要です。プロジェクトを作成した場合は、オーナーロール（roles/owner）を介してこの権限がすでに付与されている可能性があります。それ以外の場合は、Service Usage 管理者ロール（roles/serviceusage.serviceUsageAdmin）を介してこの権限を取得できます。ロールを付与する方法を確認する。
API の有効化

エンタープライズグループを取得する

認証済みユーザーのグループメンバーシップを取得するには、HTTP GET リクエストを /groups エンドポイントに送信します。

Cloud OAuth API の common.groups メソッドは、認証済みユーザーのエンタープライズグループメンバーシップを取得します。

リクエストのデータを使用する前に、次のように置き換えます。

TOKEN: トークン交換エンドポイントから取得した有効期間の短い OAuth 2.0 アクセストークン。
PAGE_SIZE: 省略可。ページごとに返されるグループの最大数（2,500 ～ 5,000）。
PAGE_TOKEN: 省略可。前回の /groups レスポンスの next_page_token フィールドから受け取ったページ設定トークン。

HTTP メソッドと URL:

GET https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer TOKEN" \
     "https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN"

PowerShell（Windows）

次のコマンドを実行します。

$headers = @{ "Authorization" = "Bearer TOKEN" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "groups": [
    "security-admin@example.com",
    "data-analysts@example.com",
    "looker-developers@example.com"
  ],
  "next_page_token": "AE12aBcDeFgHiJkLmNoPqRsTuVwXyZ"
}

レスポンスのフィールド

レスポンスには、次のフィールドが含まれます。

フィールド	タイプ	説明
`groups`	`array of strings`	認証済みユーザーが属するエンタープライズグループの ID またはメールアドレスのリスト。
`next_page_token`	`string`	結果の次のページを取得するために、後続のリクエストで `page_token` として渡すことができるトークン。このフィールドが空の場合、または省略されている場合は、後続のページはありません。

/groups エンドポイントから返されるエラーレスポンスについては、Cloud OAuth ユーザー情報とグループのエラーをご覧ください。