Method: roleAssignments.list

すべての roleAssignments のページ分けされたリストを取得します。

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

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