Directory API: ユーザー エイリアス

ユーザー エイリアスを作成する

ユーザーのエイリアスは、ユーザーのメインのメールアドレスと同じメールボックスを使用する予備のメールアドレスです。ユーザー エイリアスは、ユーザーのメインのメールアドレスで使用されているドメインとは別のアカウント ドメインに関連付けることが可能です。最長でも 24 時間ほど経過すると、作成したエイリアス アドレス宛てのメールがユーザーに届くようになります。この API では、ユーザー エイリアスを作成する前に、ドメインの所有権を証明する必要があります。

ユーザー エイリアスを作成するには、次の POST リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey には、ユーザーのメインのメールアドレス、ユーザー id、ユーザーのエイリアス メールアドレスのいずれかを使用できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

JSON リクエスト

次の JSON リクエストは、ユーザーのエイリアスを作成するサンプル リクエストを示しています。ユーザーは [email protected] で、エイリアスは [email protected] です。

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases
 リクエストの本文に新しいエイリアス情報があります。
{  
 "alias": "[email protected]"
}

成功すると、レスポンスとして HTTP 201 のステータス コードが返されます。レスポンスでは、ステータス コードとともに新しいユーザー エイリアスのプロパティが返されます。

ユーザーのエイリアスをすべて取得する

すべてのドメインのユーザー エイリアスをすべて取得するには、次の GET リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey には、ユーザーのメインのメールアドレス、ユーザー id、ユーザーのエイリアス メールアドレスのいずれかを使用できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
たとえば、次のリクエスト URI は、userKey が [email protected] のすべてのエイリアスを返します。
GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases

すべてのユーザー エイリアスがアルファベット順で返されます。「すべてのエイリアスを取得する」のレスポンスに使用される maxResults クエリ文字列やページ分けなどのページサイズはありません。

JSON レスポンス

成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。レスポンスでは、ステータス コードとともにユーザーのエイリアスがアルファベット順で返されます。以下のエイリアス ドメインは、アカウントのプライマリ ドメインと他の複数のドメインです。

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "[email protected]",
  "alias": "[email protected]"
 }
]
}

ユーザーのエイリアスを削除する

ユーザー エイリアスを削除するには、次の DELETE リクエストを使用し、リクエストを承認するで説明されている承認を含めます。エイリアスが削除されるまで、最長で 24 時間ほどかかることがあります。userKey には、ユーザーのメインのメールアドレス、ユーザー id、ユーザーのエイリアス メールアドレスのいずれかを使用できます。aliasId は、削除されるエイリアスのメールアドレスです。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
たとえば、次の DELETE リクエストでは、userKey が [email protected] であるエイリアス [email protected] が削除されます。
DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]/aliases/[email protected]

成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。