Admin SDK: Directory API

Admin SDK Directory API を使用すると、エンタープライズ ドメインの管理者は組織のユーザー、グループ、デバイス、関連リソースを表示、管理できます。Cloud Identity API には、同じリソースの一部を管理するための追加の方法が用意されています。

サービス: admin.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://admin.googleapis.com

REST リソース: asps

メソッド
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
ユーザーが発行した ASP を削除します。
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
ユーザーが発行した ASP に関する情報を取得します。
list GET /admin/directory/v1/users/{userKey}/asps
ユーザーが発行した ASP を一覧表示します。

REST リソース: chromeosdevices

メソッド
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
代わりに BatchChangeChromeOsDeviceStatus を使用してください。
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
ChromeOS デバイスのプロパティを取得します。
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
アカウント内の ChromeOS デバイスのページネーション付きリストを取得します。
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
複数の ChromeOS デバイスを組織部門に移動または挿入します。
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
デバイスの更新可能なプロパティ（annotatedUser、annotatedLocation、notes、orgUnitPath、annotatedAssetId など）を更新します。
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
デバイスの更新可能なプロパティ（annotatedUser、annotatedLocation、notes、orgUnitPath、annotatedAssetId など）を更新します。

REST リソース: customer.devices.chromeos

メソッド
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
ChromeOS デバイスのバッチのステータスを変更します。
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
デバイスが実行するコマンドを送信します。

REST リソース: customer.devices.chromeos.commands

メソッド
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
デバイスに発行された特定のコマンドのコマンドデータを取得します。

REST リソース: customers

メソッド
get GET /admin/directory/v1/customers/{customerKey}
顧客を取得します。
patch PATCH /admin/directory/v1/customers/{customerKey}
お客様にパッチを適用します。
update PUT /admin/directory/v1/customers/{customerKey}
顧客を更新します。

REST リソース: domainAliases

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
お客様のドメイン エイリアスを削除します。
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
お客様のドメイン エイリアスを取得します。
insert POST /admin/directory/v1/customer/{customer}/domainaliases
お客様のドメイン エイリアスを挿入します。
list GET /admin/directory/v1/customer/{customer}/domainaliases
お客様のドメイン エイリアスを一覧表示します。

REST リソース: domains

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
お客様のドメインを削除します。
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
お客様のドメインを取得します。
insert POST /admin/directory/v1/customer/{customer}/domains
お客様のドメインを挿入します。
list GET /admin/directory/v1/customer/{customer}/domains
お客様のドメインを一覧表示します。

REST リソース: groups

メソッド
delete DELETE /admin/directory/v1/groups/{groupKey}
グループを削除します。
get GET /admin/directory/v1/groups/{groupKey}
グループのプロパティを取得します。
insert POST /admin/directory/v1/groups
グループを作成します。
list GET /admin/directory/v1/groups
ドメインまたはユーザーキーが指定されたユーザーのすべてのグループを取得します（ページネーションあり）。
patch PATCH /admin/directory/v1/groups/{groupKey}
グループのプロパティを更新します。
update PUT /admin/directory/v1/groups/{groupKey}
グループのプロパティを更新します。

REST リソース: groups.aliases

メソッド
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
エイリアスを削除します。
insert POST /admin/directory/v1/groups/{groupKey}/aliases
グループのエイリアスを追加します。
list GET /admin/directory/v1/groups/{groupKey}/aliases
グループのすべてのエイリアスを一覧表示します。

REST リソース: members

メソッド
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
グループからメンバーを削除します。
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
グループ メンバーのプロパティを取得します。
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
指定されたユーザーがグループのメンバーかどうかを確認します。
insert POST /admin/directory/v1/groups/{groupKey}/members
指定されたグループにユーザーを追加します。
list GET /admin/directory/v1/groups/{groupKey}/members
グループ内のすべてのメンバーのパージネーション リストを取得します。
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
指定されたグループ内のユーザーのメンバーシップ プロパティを更新します。
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
指定されたグループ内のユーザーのメンバーシップを更新します。

REST リソース: mobiledevices

メソッド
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
モバイル デバイスに影響するアクションを実行します。
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
モバイル デバイスを削除します。
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
モバイル デバイスのプロパティを取得します。
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
アカウントのユーザー所有のすべてのモバイル デバイスのページネーション付きリストを取得します。

REST リソース: orgunits

メソッド
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
組織部門を削除します。
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
組織部門を取得します。
insert POST /admin/directory/v1/customer/{customerId}/orgunits
組織部門を追加します。
list GET /admin/directory/v1/customer/{customerId}/orgunits
アカウントのすべての組織部門のリストを取得します。
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
組織部門を更新します。
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
組織部門を更新します。

REST リソース: privileges

メソッド
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
お客様のすべての権限のパージネーション リストを取得します。

REST リソース: resources.buildings

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
建物を削除します。
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
建物を取得します。
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
建物を挿入します。
list GET /admin/directory/v1/customer/{customer}/resources/buildings
アカウントの建物のリストを取得します。
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
建物にパッチを適用します。
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
建物を更新します。

REST リソース: resources.calendars

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
カレンダー リソースを削除します。
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
カレンダー リソースを取得します。
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
カレンダー リソースを挿入します。
list GET /admin/directory/v1/customer/{customer}/resources/calendars
アカウントのカレンダー リソースのリストを取得します。
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
カレンダー リソースにパッチを適用します。
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
カレンダー リソースを更新します。

REST リソース: resources.features

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
特徴を削除します。
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Feature を取得します。
insert POST /admin/directory/v1/customer/{customer}/resources/features
Feature を挿入します。
list GET /admin/directory/v1/customer/{customer}/resources/features
アカウントの機能のリストを取得します。
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
特徴にパッチを適用します。
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
特徴の名前を変更します。
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
特徴を更新します。

REST リソース: roleAssignments

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
ロールの割り当てを削除します。
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
ロールの割り当てを取得します。
insert POST /admin/directory/v1/customer/{customer}/roleassignments
ロールの割り当てを作成します。
list GET /admin/directory/v1/customer/{customer}/roleassignments
すべての roleAssignment のページネーション リストを取得します。

REST リソース: roles

メソッド
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
ロールを削除します。
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
ロールを取得します。
insert POST /admin/directory/v1/customer/{customer}/roles
ロールを作成します。
list GET /admin/directory/v1/customer/{customer}/roles
ドメイン内のすべてのロールのパージネーション リストを取得します。
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
ロールにパッチを適用します。
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
ロールを更新します。

REST リソース: schemas

メソッド
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
スキーマを削除します。
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
スキーマを取得します。
insert POST /admin/directory/v1/customer/{customerId}/schemas
スキーマを作成します。
list GET /admin/directory/v1/customer/{customerId}/schemas
お客様のすべてのスキーマを取得します。
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
スキーマにパッチを適用します。
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
スキーマを更新します。

REST リソース: tokens

メソッド
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
ユーザーがアプリケーションに対して発行したすべてのアクセス トークンを削除します。
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
ユーザーによって発行されたアクセス トークンに関する情報を取得します。
list GET /admin/directory/v1/users/{userKey}/tokens
指定したユーザーがサードパーティ アプリケーションに発行したトークンのセットを返します。

REST リソース: twoStepVerification

メソッド
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
ユーザーの 2 段階認証プロセスを無効にします。

REST リソース: users

メソッド
delete DELETE /admin/directory/v1/users/{userKey}
ユーザーを削除します。
get GET /admin/directory/v1/users/{userKey}
ユーザーを取得します。
insert POST /admin/directory/v1/users
ユーザーを作成します。
list GET /admin/directory/v1/users
削除されたユーザーまたはドメイン内のすべてのユーザーのページネーション付きリストを取得します。
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
ユーザーを特権管理者にします。
patch PATCH /admin/directory/v1/users/{userKey}
パッチ セマンティクスを使用してユーザーを更新します。
signOut POST /admin/directory/v1/users/{userKey}/signOut
すべてのウェブ セッションとデバイス セッションからユーザーをログアウトし、ログイン Cookie をリセットします。
undelete POST /admin/directory/v1/users/{userKey}/undelete
削除したユーザーの削除を取り消します。
update PUT /admin/directory/v1/users/{userKey}
ユーザーを更新します。
watch POST /admin/directory/v1/users/watch
ユーザーリストの変更を監視します。

REST リソース: users.aliases

メソッド
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
エイリアスを削除します。
insert POST /admin/directory/v1/users/{userKey}/aliases
エイリアスを追加します。
list GET /admin/directory/v1/users/{userKey}/aliases
ユーザーのすべてのエイリアスを一覧表示します。
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
ユーザーリストの変更を監視します。

REST リソース: users.photos

メソッド
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
ユーザーの写真を削除します。
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
ユーザーの写真を取得します。
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
ユーザーの写真を追加します。
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
ユーザーの写真を追加します。

REST リソース: verificationCodes

メソッド
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
ユーザーの新しいバックアップ確認コードを生成します。
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
ユーザーの現在のバックアップ確認コードを無効にします。
list GET /admin/directory/v1/users/{userKey}/verificationCodes
指定したユーザーの有効なバックアップ確認コードの現在のセットを返します。