Method: roleAssignments.list

すべての roleAssignment のページネーションされたリストを取得します。

HTTP リクエスト

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments

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

パスパラメータ

パラメータ
customer

string

お客様の Google Workspace アカウントの一意の ID。複数ドメインのアカウントで、お客様のすべてのグループを取得するには、domain ではなくこのフィールドを使用します。my_customer エイリアスを使用してアカウントの customerId を表すこともできます。customerId は、Users リソースの一部として返されます。customer パラメータまたは domain パラメータのいずれかを指定する必要があります。

クエリ パラメータ

パラメータ
maxResults

integer

返される結果の最大数。

pageToken

string

リストの次のページを指定するトークン。

roleId

string

ロールの不変の ID。リクエストに含めると、このロール ID を含むロールの割り当てのみが返されます。

userKey

string

メインのメールアドレス、エイリアス メールアドレス、または一意のユーザー ID またはグループ ID。リクエストに含めると、このユーザーまたはグループのロール割り当てのみが返されます。

includeIndirectRoleAssignments

boolean

true に設定すると、直接のロール割り当てだけでなく、間接的なロール割り当て(グループを介したロール割り当て)も取得します。デフォルトは false です。userKey を指定する必要があります。指定しないと、間接ロールの割り当てが含まれません。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (RoleAssignment)
    }
  ],
  "nextPageToken": string
}
フィールド
kind

string

API リソースのタイプ。これは常に admin#directory#roleAssignments です。

etag

string

リソースの ETag。

items[]

object (RoleAssignment)

RoleAssignment リソースのリスト。

nextPageToken

string

認可スコープ

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

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

詳しくは、認可ガイドをご覧ください。