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

Methods
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

Methods
action POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Chrome OS デバイスに影響するアクションを実行します。
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Chrome OS デバイスのプロパティを取得します。
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
アカウント内の Chrome OS デバイスのページ分けされたリストを取得します。
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
複数の Chrome OS デバイスを組織部門に移動または挿入します。
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

Methods
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
デバイスで実行するコマンドを発行します。

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

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

REST リソース: customers

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

REST リソース: domainAliases

Methods
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

Methods
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

Methods
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
userKey（ページ設定）が指定されたドメインまたはユーザーのすべてのグループを取得します。
patch PATCH /admin/directory/v1/groups/{groupKey}
グループのプロパティを更新します。
update PUT /admin/directory/v1/groups/{groupKey}
グループのプロパティを更新します。

REST リソース: groups.aliases

Methods
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

Methods
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

Methods
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

Methods
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 リソース: privilegeds

Methods
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
顧客に対するすべての権限のページ分けされたリストを取得します。

REST リソース: resources.buildings

Methods
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

Methods
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

Methods
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
特徴を削除します。
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
特徴を取得します。
insert POST /admin/directory/v1/customer/{customer}/resources/features
特徴を挿入します。
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

Methods
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
すべての roleAssignments のページ分けされたリストを取得します。

REST リソース: roles

Methods
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

Methods
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

Methods
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

Methods
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
ユーザーに対して 2 段階認証プロセスが無効になります。

REST リソース: users

Methods
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

Methods
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

Methods
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

Methods
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
指定したユーザーの現在の有効なバックアップ確認コードのセットを返します。