Method: users.aliases.list

ユーザーのすべてのエイリアスを一覧表示します。

HTTP リクエスト

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/aliases

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

パスパラメータ

パラメータ
userKey

string

API リクエスト内でユーザーを識別します。値には、ユーザーのメインのメールアドレス、エイリアス メールアドレス、一意のユーザー ID のいずれかを指定できます。

クエリ パラメータ

パラメータ
event

enum (Event)

監視するイベント。

リクエスト本文

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

レスポンスの本文

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

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

string

リソースの種類。

etag

string

リソースの ETag。

aliases[]

object (UserAlias)

エイリアス オブジェクトのリスト。

認可スコープ

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

  • https://apps-apis.google.com/a/feeds/alias/
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.alias
  • https://www.googleapis.com/auth/admin.directory.user.alias.readonly
  • https://www.googleapis.com/auth/admin.directory.user.readonly

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

イベント

サブスクリプション イベントのタイプ

列挙型
ADD エイリアス作成イベント
DELETE エイリアス削除イベント