このページは Cloud Translation API によって翻訳されました。

ユーザーアカウントを管理する

Directory API は、ユーザーの作成、更新、削除をプログラムで行う方法を提供します。また、指定した条件を満たす個々のユーザーまたはユーザーのリストに関する情報も取得できます。基本的なユーザー操作の例を次に示します。

ユーザーアカウントの作成

ユーザーアカウントは、Google Workspace アカウントのどのドメインにも追加できます。ユーザーアカウントを追加する前に、ドメインの所有権をご確認ください。

個人用 Gmail アカウントを独自のドメイン名のビジネス用メールアカウントにアップグレードした場合、新しいユーザーアカウントを作成するには、Google Workspace の追加設定のロックを解除する必要があります。詳しくは、G Suite のビジネス用メールアカウントを G Suite Basic に更新をご覧ください。

ドメインの 1 つを使用してユーザーアカウントを作成するには、次の POST リクエストを使用し、認証と認可の詳細で説明されている承認を含めます。Directory API で使用可能なスコープは、OAuth 2.0 スコープリストで確認できます。リクエストのクエリ文字列のプロパティについては、users.insert() メソッドをご覧ください。

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

すべての作成リクエストで、そのリクエストの処理に必要な情報を送信する必要があります。クライアントライブラリを使用している場合は、選択した言語のデータオブジェクトが JSON データ形式のオブジェクトに変換されます。

JSON リクエスト

次の JSON は、ユーザーを作成するためのサンプルリクエストを示しています。リクエストとレスポンスのプロパティの全一覧については、API リファレンスをご覧ください。

{
"primaryEmail": "liz@example.com",
"name": {
 "givenName": "Elizabeth",
 "familyName": "Smith"
},
"suspended": false,
"password": "new user password",
"hashFunction": "SHA-1",
"changePasswordAtNextLogin": false,
"ipWhitelisted": false,
"ims": [
 {
  "type": "work",
  "protocol": "gtalk",
  "im": "liz_im@talk.example.com",
  "primary": true
 }
],
"emails": [
 {
  "address": "liz@example.com",
  "type": "home",
  "customType": "",
  "primary": true
 }
],
"addresses": [
 {
  "type": "work",
  "customType": "",
  "streetAddress": "1600 Amphitheatre Parkway",
  "locality": "Mountain View",
  "region": "CA",
  "postalCode": "94043"
 }
],
"externalIds": [
 {
  "value": "12345",
  "type": "custom",
  "customType": "employee"
 }
],
"organizations": [
 {
  "name": "Google Inc.",
  "title": "SWE",
  "primary": true,
  "type": "work",
  "description": "Software engineer"
 }
],
"phones": [
 {
  "value": "+1 nnn nnn nnnn",
  "type": "work"
 }
],
"orgUnitPath": "/corp/engineering",
"includeInGlobalAddressList": true
}

作成リクエストのクエリレートが高すぎると、割り当てを超過したことを示す HTTP 503 レスポンスが API サーバーから返される場合があります。こうしたレスポンスを受け取った場合は、指数バックオフアルゴリズムを使用してリクエストを再試行します。

新しいアカウントに関する注意事項:

Google アカウントでメールライセンスを購入している場合、新しいユーザーアカウントにはメールボックスが自動的に割り当てられます。この割り当てが完了して有効になるまでに数分かかることがあります。
リクエスト内の読み取り専用フィールド（isAdmin など）の編集は、API サービスによって通知なく無視されます。
1 つのアカウントで許可されるドメインの最大数は 600（プライマリドメイン 1 個 + 追加ドメイン 599 個）です。
ユーザーアカウントの作成時にユーザーが特定の組織部門に割り当てられていない場合、そのアカウントは最上位の組織部門に属します。ユーザーがアクセスできる Google Workspace サービスは、ユーザーの組織部門によって決まります。ユーザーを新しい組織に移動すると、ユーザーのアクセス権が変更されます。組織構造について詳しくは、管理者向けヘルプセンターをご覧ください。ユーザーを別の組織に移動する方法について詳しくは、ユーザーを更新するをご覧ください。
新しいユーザーアカウントには password が必要です。hashFunction を指定する場合は、パスワードを有効なハッシュキーにする必要があります。指定しない場合、パスワードはクリアテキストで、8 ～ 100 文字の ASCII 文字にする必要があります。詳細については、API リファレンスをご覧ください。
Google Workspace のフレキシブルプランをご利用の場合、この API を使用してユーザーを作成すると金銭的な影響があり、お客様の請求先アカウントに請求されます。詳しくは、API のお支払い情報をご覧ください。
Google Workspace アカウントには、任意のドメインを含めることができます。複数ドメインのアカウントを使用すると、あるドメインのユーザーが他のアカウントドメインのユーザーとサービスを共有できます。複数のドメインのユーザーの詳細については、API の複数ドメインの情報をご覧ください。
競合するアカウントが存在する可能性があります。追加する予定のユーザーがすでに Google アカウントを持っているかどうかを確認してください。これらのアカウントとの競合を回避する手順は次のとおりです。競合するアカウントを特定して解決するをご覧ください。
ビジターのアカウントがある可能性があります。Google アカウントを持たない組織外のユーザーをドライブで共同編集できるようにすると、招待したユーザーには「visit's_username@your_domain.com」という形式のビジターアカウントが届きます。ビジターアカウントと同じユーザー名のユーザーを追加すると、このアカウントは完全な Google Workspace アカウントに変換されます。そのアカウントでは、現在のドライブファイルの権限が維持されます。ドキュメントをビジターと共有するをご覧ください。

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

ユーザーアカウントを更新する

ユーザーアカウントを更新するには、次の PUT リクエストを使用し、リクエストを承認するで説明されている承認を含めます。userKey には、ユーザーのメインのメールアドレス、一意のユーザー id、ユーザーのエイリアスメールアドレスのいずれかを指定できます。

PUT https://admin.googleapis.com/admin/directory/v1/users/userKey

リクエストとレスポンスの本文にはどちらも User のインスタンスが含まれます。ただし、Directory API はパッチのセマンティクスをサポートしているため、リクエスト内の更新されたフィールドを送信するだけで済みます。

サンプルリクエスト

次の例では、ユーザーアカウントの作成時にユーザーの givenName は「Elizabeth」で、仕事用メールアドレスのみが指定されています。

{
  "name": {
    "givenName": "Elizabeth",
    "familyName": "Smith"
   },
  "emails": [
    {
      "address": "liz@example.com",
      "type": "work",
      "primary": true
    }
}

以下のリクエストでは、givenName を「Elizabeth」から「Liz」に更新し、自宅のメールアドレスも追加します。フィールドが配列なので両方のメールアドレスが指定されています

PUT https://admin.googleapis.com/admin/directory/v1/users/liz@example.com

{
  "name": {
    "givenName": "Liz",
   },
  "emails": [
    {
      "address": "liz@example.com",
      "type": "work",
      "primary": true
    },
    {
      "address": "liz@home.com",
      "type": "home"
    }
  ]
}

成功すると、HTTP 200 ステータスコードと、更新されたフィールドを含む User リソースが返されます。

ユーザーのアカウント名を更新する場合は、次の点に注意してください。

ユーザーアカウントの名前を変更すると、ユーザーのメインのメールアドレスと、このユーザーの情報の取得に使用されるドメインが変更されます。ユーザー名を変更する前に、すべてのブラウザセッションとサービスからユーザーをログアウトすることをおすすめします。
ユーザーアカウントの名前を変更する処理がすべてのサービスに反映されるまで、最大で 10 分かかることがあります。
ユーザーの名前を変更すると、古いユーザー名がエイリアスとして保持され、メール転送設定によるメール配信が継続されます。新しいユーザー名としては使用できません。
メールアドレスは変更される可能性があるため、通常は、ユーザーのメールアドレスを永続データのキーとして使用しないことをおすすめします。
ユーザーの名前を変更した場合の Google Workspace アプリへの影響の完全なリストについては、管理者用ヘルプセンターをご覧ください。

ユーザーを管理者にする

ユーザーを特権管理者にするには、次の POST リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。userKey には、ユーザーのメインのメールアドレス、一意のユーザー id、ユーザーのエイリアスメールアドレスのいずれかを指定できます。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。特権管理者の詳細については、管理者向けヘルプセンターをご覧ください。

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

JSON リクエスト

この例では、userKey が liz@example.com であるユーザーが特権管理者になります。

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/makeAdmin

{
 "status": true
}

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

ユーザーとの関係を管理する

Directory API では、relations フィールドを使用してユーザー間のさまざまな関係を定義します。ビジネス環境では、一般的に管理職と従業員やアシスタントの関係にこのフィールドを使用しますが、他の多くのタイプもサポートしています。関係は、カードをサポートしている Google Workspace アプリケーションのユーザーの [関連情報] カードに表示されます。カードが表示される場所の例については、ユーザーのディレクトリプロフィールに情報を追加するをご覧ください。

ユーザー間の関係を築く

リレーションは、レコードに relations フィールドを含む「所有」ユーザーから始まる一方向にのみ定義できます。type は、自分と他のユーザーとの関係を表します。たとえば、マネージャーと従業員の関係では、従業員は所有ユーザーであり、manager タイプを使用してアカウントに relations フィールドを追加します。使用できる型については、User オブジェクトリファレンスをご覧ください。

リレーションを設定するには、relations フィールドを含む JSON リクエストの本文で、所有するユーザーを作成または更新します。1 つのリクエストで複数の関係を作成できます。

{
  "relations": [
    {
      "value": "EMAIL_ADDRESS_RELATION_1",
      "type": "manager"
    },
    {
      "value": "EMAIL_ADDRESS_RELATION_2",
      "type": "dotted_line_manager"
    }
  ]
}

関係を更新または削除する

relations フィールドの更新は、全体としてのみ行えます。リストされた個人を指定して、関係タイプの変更や削除を行うことはできません。上記の例では、既存の MCC との関係を削除し、点線の MCC を所有者ユーザーのマネージャーにするには、フィールドのすべての値を使用して、所有者ユーザーのアカウントを更新します。

{
  "relations": [
    {
      "value": "EMAIL_ADDRESS_RELATION_2",
      "type": "manager"
    }
  ]
}

所有するユーザーの関係をすべて削除するには、relations を空に設定します。

{
  "relations": []
}

ユーザーを取得する

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

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

この例では、メインまたはエイリアスのメールアドレスが liz@example.com であるユーザーのユーザーアカウントのプロパティを返します。

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com

JSON レスポンス

成功すると、HTTP 200 のステータスコードが返されます。レスポンスでは、ステータスコードとともにユーザーアカウントのプロパティが返されます。

{
 "kind": "directory#user",
 "id": "the unique user id",
 "primaryEmail": "liz@example.com",
 "name": {
  "givenName": "Liz",
  "familyName": "Smith",
  "fullName": "Liz Smith"
 },
 "isAdmin": true,
 "isDelegatedAdmin": false,
 "lastLoginTime": "2013-02-05T10:30:03.325Z",
 "creationTime": "2010-04-05T17:30:04.325Z",
 "agreedToTerms": true,
 "hashFunction": "SHA-1",
 "suspended": false,
 "changePasswordAtNextLogin": false,
 "ipWhitelisted": false,
 "ims": [
  {
   "type": "work",
   "protocol": "gtalk",
   "im": "lizim@talk.example.com",
   "primary": true
  }
 ],
 "emails": [
  {
   "address": "liz@example.com",
   "type": "home",
   "customType": "",
   "primary": true
  }
 ],
 "addresses": [
  {
   "type": "work",
   "customType": "",
   "streetAddress": "1600 Amphitheatre Parkway",
   "locality": "Mountain View",
   "region": "CA",
   "postalCode": "94043"
  }
 ],
 "externalIds": [
  {
   "value": "employee number",
   "type": "custom",
   "customType": "office"
  }
 ],
 "organizations": [
  {
   "name": "Google Inc.",
   "title": "SWE",
   "primary": true,
   "customType": "",
   "description": "Software engineer"
  }
 ],
 "phones": [
  {
   "value": "+1 nnn nnn nnnn",
   "type": "work"
  }
 ],
 "aliases": [
  "lizsmith@example.com",
  "lsmith@example.com"
 ],
 "nonEditableAliases": [
  "liz@test.com"
 ],
 "customerId": "C03az79cb",
 "orgUnitPath": "corp/engineering",
 "isMailboxSetup": true,
 "includeInGlobalAddressList": true
}

ドメイン内のすべてのユーザーを取得する

同じドメイン内のすべてのユーザーを取得するには、次の GET リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。この例では、読みやすくするために改行を使用しています。

GET https://admin.googleapis.com/admin/directory/v1/users
?domain=primary domain name&pageToken=token for next results page
&maxResults=max number of results per page
&orderBy=email, givenName, or familyName
&sortOrder=ascending or descending
&query=email, givenName, or familyName:the query's value*

リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

JSON レスポンス

この例では、example.com ドメイン内のすべてのユーザーが、レスポンスページあたり最大 2 つのユーザードメインとともに返されます。このレスポンスには、後続のユーザーリストの nextPageToken があります。デフォルトでは、100 人のユーザーのリストがユーザーのメールアドレスのアルファベット順で返されます。

GET https://admin.googleapis.com/admin/directory/v1/users?domain=example.com&maxResults=2

成功すると、HTTP 200 のステータスコードが返されます。レスポンスでは、ステータスコードとともに、example.com ドメイン（maxResults=2）内の 2 つのユーザーアカウントが返されます。

注: ドメイン内のすべてのユーザーを取得する場合、lastLoginTime の値が不正確になる場合があります。lastLoginTime の最も正確な値を取得するには、代わりにユーザーを取得してください。

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "liz@example.com",
   "name": {
    "givenName": "Liz",
    "familyName": "Smith",
    "fullName": "Liz Smith"
   },
   "isAdmin": true,
   "isDelegatedAdmin": false,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "ims": [
    {
     "type": "work",
     "protocol": "gtalk",
     "im": "lizim@talk.example.com",
     "primary": true
    }
   ],
   "emails": [
    {
     "address": "liz@example.com",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "addresses": [
    {
     "type": "work",
     "customType": "",
     "streetAddress": "1600 Amphitheatre Parkway",
     "locality": "Mountain View",
     "region": "CA",
     "postalCode": "94043"
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "organizations": [
    {
     "name": "Google Inc.",
     "title": "SWE",
     "primary": true,
     "customType": "",
     "description": "Software engineer"
    }
   ],
   "phones": [
    {
     "value": "+1 nnn nnn nnnn",
     "type": "work"
    }
   ],
   "aliases": [
    "lizsmith@example.com",
    "lsmith@example.com"
   ],
   "nonEditableAliases": [
    "liz@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "corp/engineering",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "user unique ID",
   "primaryEmail": "admin2@example.com",
   "name": {
    "givenName": "admin",
    "familyName": "two",
    "fullName": "admin two"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": true,
   "suspensionReason": "ADMIN",
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "admin2@example.com",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "contractor license number",
     "type": "custom",
     "customType": "work"
    }
   ],
   "aliases": [
    "second_admin@example.com"
   ],
   "nonEditableAliases": [
    "admin@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "corp/engineering",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  }
 ],
 "nextPageToken": "next page token"
}

すべてのアカウントユーザーを取得する

複数のドメインで構成されている可能性のあるアカウント内のすべてのユーザーを取得するには、次の GET リクエストを使用して、リクエストを承認するで説明されている承認を含めます。この例では、読みやすくするために改行を使用しています。

GET https://admin.googleapis.com/admin/directory/v1/users
?customer=my_customer or customerId&pageToken=token for next results page
&maxResults=max number of results per page
&orderBy=email, givenName, or familyName
&sortOrder=ascending or descending
&query=user attributes

customer クエリ文字列は、my_customer または customerId の値です。
文字列 my_customer を使用して、アカウントの customerId を表します。
販売パートナー管理者は、販売パートナー経由で購入されたお客様の customerId を使用します。customerId には、ドメイン内のすべてのユーザーを取得する操作のリクエストでアカウントのプライマリドメイン名を使用します。結果のレスポンスには customerId 値が含まれます。
オプションの orderBy クエリ文字列は、リストをユーザーのメインのメールアドレス、姓、名のいずれで並べ替えるかを決定します。orderBy を使用する場合は、sortOrder クエリ文字列を使用して結果を昇順または降順で一覧表示することもできます。
オプションの query クエリ文字列を使用すると、コアフィールドとカスタムフィールドの両方を含む、ユーザープロフィールのさまざまなフィールドを検索できます。例については、ユーザーの検索をご覧ください。

リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

この例では、アカウント管理者が、アカウント内のすべてのユーザーをレスポンスページに 1 つずつユーザーエントリとして返すようリクエストしています。nextPageToken を実行すると、次の結果ページが表示されます。

GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&maxResults=1

この例では、販売パートナー管理者が、customerId の値が C03az79cb の販売パートナー経由で購入されたアカウントのすべてのユーザーをリクエストしています。

GET https://admin.googleapis.com/admin/directory/v1/users?customer=C03az79cb&maxResults=1

JSON レスポンス

成功すると、HTTP 200 のステータスコードが返されます。レスポンスでは、ステータスコードとともに、このアカウントのすべてのユーザーが返されます。

注: すべてのアカウントユーザーを取得する場合、lastLoginTime の値が不正確になる場合があります。lastLoginTime の最も正確な値を取得するには、代わりにユーザーを取得してください。

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "admin2@example.com",
   "name": {
    "givenName": "admin",
    "familyName": "two",
    "fullName": "admin two"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "2013-02-05T10:30:03.325Z",
   "creationTime": "2010-04-05T17:30:04.325Z",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "admin2@example.com",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
     "second_admin@example.com"
   ],
   "nonEditableAliases": [
     "another_admin@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "liz@example.com",
   "name": {
    "givenName": "Elizabeth",
    "familyName": "Smith",
    "fullName": "Elizabeth Smith"
   },
   "isAdmin": false,
   "isDelegatedAdmin": false,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": false,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "liz@example.com",
     "type": "home",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "bank"
    }
   ],
   "relations": [
    {
     "value": "liz",
     "type": "friend",
     "customType": ""
    }
   ],
   "aliases": [
    "lizsmith@example.com",
    "lsmith@example.com"
   ],
   "nonEditableAliases": [
    "liz@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "test3@example.com",
   "name": {
    "givenName": "Tester",
    "familyName": "Three",
    "fullName": "Tester Three"
   },
   "isAdmin": false,
   "isDelegatedAdmin": false,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "test@example.com",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "tester3@example.com"
   ],
   "nonEditableAliases": [
    "third@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "work_admin@example.com",
   "name": {
    "givenName": "Admin",
    "familyName": "Work",
    "fullName": "Admin Work"
   },
   "isAdmin": true,
   "isDelegatedAdmin": true,
   "lastLoginTime": "1336509883546",
   "creationTime": "1404802800000",
   "agreedToTerms": true,
   "hashFunction": "SHA-1",
   "suspended": false,
   "changePasswordAtNextLogin": false,
   "ipWhitelisted": false,
   "emails": [
    {
     "address": "work_admin@example.com",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "my_alias@example.com"
   ],
   "nonEditableAliases": [
    "other_alias@test.com"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  }
 ],
 "nextPageToken": "NNNNN"
}

最近削除されたユーザーを取得する

過去 20 日間にアカウントまたはアカウントのドメインから削除されたすべてのユーザーを取得するには、次の GET リクエストを使用して、リクエストを承認するで説明されている承認を含めます。ユーザーの削除を取り消すには、ユーザーの削除を取り消すをご覧ください。

アカウントのプライマリドメインまたはサブドメインから過去 20 日以内に削除されたユーザーを取得するには、次の GET リクエストを使用します。domain クエリ文字列は、ドメインのプライマリドメイン名です。ユーザーリクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。この例では、読みやすくするために改行を使用しています。

GET https://admin.googleapis.com/admin/directory/v1/users
?domain=primary domain name&pageToken=token for next results page
&maxResults=max number of results per page
&showDeleted=true

注: showDeleted=false 設定では、リクエストはドメイン内のすべてのユーザーを取得すると同じレスポンスを返します。

アカウントに複数のドメインがある場合は、次の GET リクエストを使用して、アカウント全体から過去 20 日以内に削除されたユーザーを取得できます。この例では、読みやすくするために改行を使用しています。

GET https://admin.googleapis.com/admin/directory/v1/users
?customer=my_customer or customerId&pageToken=token for next results page
&maxResults=max number of results per page&showDeleted=true

customer クエリ文字列は、my_customer または customerId の値です。
アカウント管理者として、文字列 my_customer を使用してアカウントの customerId を表します。
販売パートナー管理者は、販売パートナー経由で購入されたお客様の customerId を使用します。customerId には、ドメイン内のすべてのユーザーを取得する操作のリクエストでアカウントのプライマリドメイン名を使用します。結果のレスポンスには customerId 値が含まれます。

リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

注: showDeleted=false 設定では、リクエストは「すべてのアカウントユーザーを取得する」と同じレスポンスを返します。ユーザーリクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

この例では、アカウント管理者がアカウント内の削除済みユーザーすべてをリクエストしています。

GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&showDeleted=true

JSON レスポンス

成功すると、HTTP 200 のステータスコードが返されます。レスポンスでは、ステータスコードとともに、過去 20 日以内に削除されたすべてのアカウントユーザーが返されます。

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "user1@example.com"
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "user3@example.com"
  }
 ],
 "nextPageToken": "token for next page of deleted users"
}

ユーザーの写真を取得する

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

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

この例では、liz@example.com の最新の写真が返されます。

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/photos/thumbnail

JSON Response

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

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "liz@example.com",
 "mimeType": "the photo mime type",
 "height": "the photo height in pixels",
 "width": "the photo width in pixels",
 "photoData": "web safe base64 encoded photo data"
}

API による写真のウェブセーフ Base64 エンコードは、RFC 4648 の「base64url」に似ています。これは次のことを意味します。

スラッシュ（/）はアンダースコア（_）に置き換えられます。
プラス記号（+）はハイフン（-）に置き換えられます。
等号（=）はアスタリスク（*）に置き換えられます。
パディングについては、パディングに等号（=）を使用する RFC-4648 の baseURL 定義の代わりに、ピリオド（.）が使用されます。これは URL の解析を簡素化するためのものです。
アップロードする写真のサイズに比例して、API によって 96x96 ピクセルに縮小されます。

互換性のあるリンクを JavaScript から作成する必要がある場合、Google Closure Library には、Apache ライセンスの下でリリースされている Base64 エンコードおよびデコード関数が含まれています。

管理者以外のユーザーを取得する

ユーザーアカウントを変更できるのは管理者のみですが、ドメインのすべてのユーザーがユーザープロフィールを読み取ることができます。管理者以外のユーザーは、viewType パラメータを domain_public に設定して users.get または users.list リクエストを行い、ユーザーの公開プロフィールを取得できます。スコープ https://www.googleapis.com/auth/admin.directory.user.readonly は、このユースケースに最適です。

domain_public ビューでは、管理者以外のユーザーが主要なフィールドの標準セットにアクセスできます。カスタムフィールドの場合、スキーマを定義するときに、一般公開にするか限定公開にするかを選択できます。

ユーザーの写真を更新する

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

PUT https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

次の例では、liz@example.com の写真が更新されます。

PUT https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/photos/thumbnail

{
"photoData": "web safe base64 encoded photo data"
}

写真を更新するとき、height と width は API で無視されます。

JSON Response

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

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "liz@example.com",
 "mimeType": "the photo mime type",
 "height": "the photo height in pixels",
 "width": "the photo width in pixels",
 "photoData": "web safe base64 encoded photo data"
}

ユーザーの写真を削除する

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

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnail

削除すると、ユーザーの写真は表示されません。ユーザーの写真が必要な場合は、代わりにシルエットが表示されます。

ユーザーアカウントを削除する

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

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey

この例では、liz@example.com ユーザーアカウントが削除されます。

DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com

成功すると、HTTP 200 のステータスコードのみが返されます。

ユーザーを削除する前に考慮すべき重要な事項:

削除されたユーザーはログインできなくなります。
ユーザーアカウントの削除について詳しくは、管理者向けヘルプセンターをご覧ください。

ユーザーアカウントの削除を取り消す

過去 20 日以内に削除されたユーザーは、アカウントを復元するための特定の条件を満たしている必要があります。

ユーザーアカウントの削除を取り消すには、次の POST リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。userKey は、過去 20 日以内に削除されたユーザーを取得するオペレーションのレスポンスにある一意のユーザー id です。この操作の userKey では、ユーザーのメインのメールアドレスやユーザーのエイリアスメールアドレスのいずれかを使用することはできません。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。

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

この例では、ユーザー liz@example.com の削除を取り消します。このユーザーの以前のアカウントプロパティがすべて復元されます。

POST https://admin.googleapis.com/admin/directory/v1/users/12309329403209438205/undelete

成功すると、HTTP 204 のステータスコードのみが返されます。削除を取り消されたユーザーのアカウントを表示するには、ユーザーを取得するオペレーションを使用します。

ユーザー アカウントを管理する

ユーザー アカウントの作成

JSON リクエスト

ユーザー アカウントを更新する

サンプル リクエスト

ユーザーを管理者にする

JSON リクエスト

ユーザーとの関係を管理する

ユーザー間の関係を築く

関係を更新または削除する

ユーザーを取得する

JSON レスポンス

ドメイン内のすべてのユーザーを取得する

JSON レスポンス

すべてのアカウント ユーザーを取得する

JSON レスポンス

最近削除されたユーザーを取得する

JSON レスポンス

ユーザーの写真を取得する

JSON Response

管理者以外のユーザーを取得する

ユーザーの写真を更新する

JSON Response

ユーザーの写真を削除する

ユーザー アカウントを削除する

ユーザー アカウントの削除を取り消す

ユーザーアカウントを管理する

ユーザーアカウントの作成

ユーザーアカウントを更新する

サンプルリクエスト

すべてのアカウントユーザーを取得する

ユーザーアカウントを削除する

ユーザーアカウントの削除を取り消す