ユーザー エイリアスを作成する
ユーザーのエイリアスは、ユーザーのメインのメールアドレスと同じメールボックスを使用する予備のメールアドレスです。ユーザー エイリアスは、ユーザーのメインのメールアドレスで使用されているドメインとは別のアカウント ドメインに関連付けることが可能です。この API では、ユーザー エイリアスを作成する前に、ドメインの所有権を証明する必要があります。
ユーザー エイリアスを作成するには、次の POST
リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey
には、ユーザーのメインのメールアドレス、ユーザー id
、ユーザーのエイリアス メールアドレスのいずれかを使用できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
JSON リクエスト
次の JSON リクエストは、ユーザーのエイリアスを作成するサンプル リクエストを示しています。ユーザーは liz@example.com で、エイリアスは chica@example.com です。
POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliasesリクエストの本文に新しいエイリアス情報があります。
{ "alias": "chica@example.com" }
成功すると、レスポンスとして HTTP 201 のステータス コードが返されます。レスポンスでは、ステータス コードとともに新しいユーザー エイリアスのプロパティが返されます。
ユーザーのエイリアスをすべて取得する
すべてのドメインのユーザー エイリアスをすべて取得するには、次の GET
リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey
には、ユーザーのメインのメールアドレス、ユーザー id
、ユーザーのエイリアス メールアドレスのいずれかを使用できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
たとえば、次のリクエスト URI は、userKey が liz@example.com のすべてのエイリアスを返します。
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
すべてのユーザー エイリアスがアルファベット順で返されます。「すべてのエイリアスを取得する」のレスポンスに使用される maxResults
クエリ文字列やページ分けなどのページサイズはありません。
JSON レスポンス
成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。レスポンスでは、ステータス コードとともにユーザーのエイリアスがアルファベット順で返されます。以下のエイリアス ドメインは、アカウントのプライマリ ドメインと他の複数のドメインです。
{ "kind": "directory#user#aliases", "aliases": [ { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "chica@example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "support@example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "help@hr.example.com" }, { "kind": "directory#user#alias", "id": "the unique user id", "primary_email": "liz@example.com", "alias": "tickets@jumboinc.com" } ] }
ユーザーのエイリアスを削除する
ユーザー エイリアスを削除するには、次の DELETE
リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey
には、ユーザーのメインのメールアドレス、ユーザー id
、ユーザーのエイリアス メールアドレスのいずれかを使用できます。aliasId
は、削除されるエイリアスのメールアドレスです。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasIdたとえば、次の
DELETE
リクエストでは、userKey が liz@example.com であるエイリアス chica@example.com が削除されます。
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com
成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。