Method: roles.list

ドメイン内のすべてのロールのページ分けされたリストを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customer

string

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

クエリ パラメータ

パラメータ
maxResults

integer

返される結果の最大数。
pageToken

string

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

リクエスト本文

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

レスポンスの本文

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

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

string

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

string

リソースの ETag。
items[]

object (Role)

Role リソースのリスト。
nextPageToken

string

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。