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

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

Directory API には、ユーザーの作成、更新、削除を行うプログラムメソッドが用意されています。個々のユーザーに関する情報や、指定した条件を満たすユーザーのリストも取得できます。以下に、基本的なユーザー操作の例を示します。

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

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

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

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

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

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

JSON リクエスト

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

{
"primaryEmail": "[email protected]",
"name": {
 "givenName": "Elizabeth",
 "familyName": "Smith"
},
"suspended": false,
"password": "new user password",
"hashFunction": "SHA-1",
"changePasswordAtNextLogin": false,
"ipWhitelisted": false,
"ims": [
 {
  "type": "work",
  "protocol": "gtalk",
  "im": "[email protected]",
  "primary": true
 }
],
"emails": [
 {
  "address": "[email protected]",
  "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 アカウントには、どのドメインでも含めることができます。複数のドメインアカウントの場合、1 つのドメインのユーザーは他のアカウントドメインのユーザーとサービスを共有できます。複数のドメインのユーザーについて詳しくは、API の複数ドメイン情報をご覧ください。
競合するアカウントが存在する可能性があります。追加する予定のユーザーがすでに Google アカウントを持っていないかどうかを確認してください。その後、既存アカウントとの競合を回避する操作を行います。競合するアカウントを特定して競合を解決する方法はこちらをご確認ください。
ビジターアカウントがある可能性があります。ユーザーが Google アカウントを持たない組織外のユーザーをドライブでのコラボレーションに招待すると、visitor'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": "[email protected]",
      "type": "work",
      "primary": true
    }
}

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

PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]

{
  "name": {
    "givenName": "Liz",
   },
  "emails": [
    {
      "address": "[email protected]",
      "type": "work",
      "primary": true
    },
    {
      "address": "[email protected]",
      "type": "home"
    }
  ]
}

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

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

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

ユーザーを管理者にする

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

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

JSON リクエスト

この例では、userKey が [email protected] であるユーザーが特権管理者になります。

POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/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 フィールドは全体としてのみ更新できます。リストされている個々のユーザーにアクセスして、関係の種類を変更したり、削除したりすることはできません。上記の例では、既存のマネージャー関係を削除し、点線マネージャーを所有ユーザーのマネージャーにするには、所有ユーザーのアカウントを更新して、フィールドの値をすべて希望どおりにします。

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

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

{
  "relations": []
}

ユーザーを取得する

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

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

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

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]

JSON レスポンス

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

{
 "kind": "directory#user",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "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": "[email protected]",
   "primary": true
  }
 ],
 "emails": [
  {
   "address": "[email protected]",
   "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": [
  "[email protected]",
  "[email protected]"
 ],
 "nonEditableAliases": [
  "[email protected]"
 ],
 "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 ドメインの 2 つのユーザーアカウントが返されます（maxResults=2）。

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

{
 "kind": "directory#users",
 "users": [
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "[email protected]",
   "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": "[email protected]",
     "primary": true
    }
   ],
   "emails": [
    {
     "address": "[email protected]",
     "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": [
    "[email protected]",
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "corp/engineering",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "user unique ID",
   "primaryEmail": "[email protected]",
   "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": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "contractor license number",
     "type": "custom",
     "customType": "work"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "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": "[email protected]",
   "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": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
     "[email protected]"
   ],
   "nonEditableAliases": [
     "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "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": "[email protected]",
     "type": "home",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "bank"
    }
   ],
   "relations": [
    {
     "value": "liz",
     "type": "friend",
     "customType": ""
    }
   ],
   "aliases": [
    "[email protected]",
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "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": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "customerId": "C03az79cb",
   "orgUnitPath": "/",
   "isMailboxSetup": true,
   "includeInGlobalAddressList": true
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "username": "[email protected]",
   "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": "[email protected]",
     "type": "work",
     "customType": "",
     "primary": true
    }
   ],
   "externalIds": [
    {
     "value": "employee number",
     "type": "custom",
     "customType": "office"
    }
   ],
   "aliases": [
    "[email protected]"
   ],
   "nonEditableAliases": [
    "[email protected]"
   ],
   "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 に設定すると、リクエストはドメイン内のすべてのユーザーを取得すると同じレスポンスを返します。

アカウントに複数のドメインがある場合は、アカウント全体から過去 20 日以内に削除されたユーザーを取得できます。次の 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&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": "[email protected]"
  },
  {
   "kind": "directory#user",
   "id": "the unique user id",
   "primaryEmail": "[email protected]"
  }
 ],
 "nextPageToken": "token for next page of deleted users"
}

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

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

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

この例では、[email protected] の最新の写真が返されます。

GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail

JSON Response

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

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "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

この例では、[email protected] の写真が更新されます。

PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail

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

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

JSON Response

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

{
 "kind": "directory#user#photo",
 "id": "the unique user id",
 "primaryEmail": "[email protected]",
 "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

この例では、[email protected] のユーザーアカウントが削除されます。

DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]

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

ユーザーを削除する前に、次の点を考慮してください。

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

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

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

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

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

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

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

成功すると、HTTP 204 のステータスコードのみが返されます。復元されたユーザーのアカウントを確認するには、ユーザーを取得するの操作を使用します。

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

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

JSON リクエスト

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

リクエストの例

ユーザーを管理者にする

JSON リクエスト

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

ユーザー間の関係を作成する

リレーションシップを更新または削除する

ユーザーを取得する

JSON レスポンス

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

JSON レスポンス

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

JSON レスポンス

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

JSON レスポンス

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

JSON Response

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

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

JSON Response

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

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

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

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

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

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

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

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

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