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 アカウントには、どのドメインも含めることができます。複数ドメイン アカウントでは、1 つのドメインのユーザーは他のアカウント ドメインのユーザーとサービスを共有できます。複数のドメインのユーザーの詳細については、API の複数ドメイン情報をご覧ください。
- 競合するアカウントが存在する可能性があります。追加する予定のユーザーがすでに Google アカウントを持っているかどうかを確認します。それらのアカウントとの競合を回避する手順は次のとおりです。競合するアカウントを見つけて解決するをご覧ください。
- ビジター アカウントが存在する可能性があります。Google アカウントを持たない組織外のユーザーをドライブでの共同編集に招待すると、ユーザーは「<ユーザー名>@<ドメイン名>.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 フィールドを更新できるのは全体としてのみです。リストにある個人に直接対応して、関係タイプの変更や削除を行うことはできません。上記の例では、既存のマネージャーとの関係を削除し、点線のマネージャーをオーナー ユーザーのマネージャーにするには、フィールドのすべての値を使用して、オーナー ユーザーのアカウントを更新します。
{
"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 つのユーザー アカウントが返されます。
{
"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 ステータス コードが返されます。レスポンスでは、ステータス コードとともに、このアカウントのすべてのユーザーが返されます。
{
"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アカウントに複数のドメインがある場合は、次の
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 リファレンスをご覧ください。
この例では、アカウント管理者がアカウント内の削除済みユーザーすべてをリクエストしています。
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 に含まれている Base64 エンコード関数とデコード関数が Apache ライセンスの下でリリースされています。
管理者以外のユーザーを取得する
ユーザー アカウントを変更できるのは管理者のみですが、ドメインのすべてのユーザーがユーザー プロフィールを読み取ることができます。管理者以外のユーザーは、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 ステータス コードのみが返されます。削除を取り消したユーザーのアカウントを表示するには、ユーザーを取得するオペレーションを使用します。