Method: projects.locations.userStores.userLicenses.list

ユーザー ライセンスを一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}/userLicenses

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親 UserStore リソース名。形式: projects/{project}/locations/{location}/userStores/{userStoreId}。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合、デフォルトは 10 です。最大値は 50 です。50 を超える値は 50 に強制変換されます。

このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
pageToken

string

省略可。前回の userLicenses.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、userLicenses.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

省略可。リスト リクエストのフィルタ。

サポートされているフィールド:

  • licenseAssignmentState

例:

  • licenseAssignmentState = ASSIGNED: 割り当てられたユーザー ライセンスを一覧表示します。
  • licenseAssignmentState = NO_LICENSE: ライセンスが付与されていないユーザーを一覧表示します。
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN: ログインを試みたがライセンスが割り当てられていないユーザーを一覧表示します。
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN: ログインを試みたがライセンスが割り当てられていないユーザーを除外します。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

UserLicenseService.ListUserLicenses に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
フィールド
userLicenses[]

object (UserLicense)

お客様のすべての UserLicense。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.userStores.listUserLicenses

詳細については、IAM のドキュメントをご覧ください。