Обзор API каталогов
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
API каталога является частью API RESTful Admin SDK, который можно использовать для программного создания и управления ресурсами, контролируемыми администратором, принадлежащим учётной записи Google Workspace. Примеры использования:
- Создание и управление пользователями, добавление администраторов.
- Создание и управление группами и членством в группах.
- Мониторинг устройств, подключенных к вашему домену, и принятие мер в случае утери устройств.
- Управление организационной структурой и структурами организации.
- Аудит приложений, к которым ваши пользователи предоставили доступ, и отзыв неавторизованных приложений.
Ниже приведен список общих терминов, используемых в API каталога:
- Клиент
- Субъект, которому принадлежит учетная запись Google Workspace, представленная ресурсом «Клиент» .
- Домен
- Если применимо, DNS-домен, связанный с учётной записью Google Workspace, представленный ресурсом «Домен» . Не все учётные записи имеют связанный домен.
- Организационная единица (OU)
- Подразделение организационной структуры учётной записи Google Workspace, используемое для группировки и сортировки пользователей с целью применения политик и предоставления полномочий. Подразделение представлено ресурсом OrgUnit .
- Привилегия
- Возможность пользователя выполнять действие с ресурсом Google Workspace. Применяется в основном к администраторам. Привилегия представлена ресурсом «Privilege» .
- Роль
- Определенный набор привилегий, которые могут быть назначены пользователю или группе пользователей, представленных ресурсом «Роль» .
- Назначение ролей
- Запись, указывающая, какому пользователю назначены те или иные роли и в какой области действия. Назначение роли представлено ресурсом RoleAssignment .
- Схема
- Объект JSON, определяющий пользовательские атрибуты для вашей организации, представленный ресурсом Schema .
- Пользователь
- Отдельная учетная запись конечного пользователя с доступом к приложениям и ресурсам Google Workspace, представленная ресурсом Пользователь .
Следующие шаги
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-29 UTC.
[null,null,["Последнее обновление: 2025-08-29 UTC."],[],[],null,["# Directory API Overview\n\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| Got 5 minutes? Help us improve our Google Workspace documentation by taking a quick [online survey](https://forms.gle/XcqRP3PJiQv9ADuj9). |\n\nThe Directory API is part of the RESTful Admin SDK API that can be used to\nprogrammatically create and manage admin-controlled resources owned by a\nGoogle Workspace account. Some use cases include:\n\n- Creating and managing users and adding administrators.\n- Creating and managing groups and group memberships.\n- Monitoring devices connected to your domain and taking action on lost devices.\n- Managing your org chart and organization structures.\n- Auditing applications your users have granted access to and revoking unauthorized apps.\n\nFollowing is a list of common terms used in the Directory API:\n\n*Customer*\n: The entity that owns the Google Workspace account, represented by the\n [Customer](/workspace/admin/directory/reference/rest/v1/customers) resource.\n\n*Domain*\n: If applicable, the DNS domain associated with a Google Workspace account,\n represented by the\n [Domain](/workspace/admin/directory/reference/rest/v1/domains) resource. Not all\n accounts have an associated domain.\n\n*Organizational unit (OU)*\n: A sub-unit of a Google Workspace account's organizational tree, used to\n group and sort users for the purpose of applying policies and granting\n authorizations. An OU is represented by the\n [OrgUnit](/workspace/admin/directory/reference/rest/v1/orgunits) resource.\n\n*Privilege*\n: The ability of a user to perform an action on a Google Workspace resource.\n Applies primarily to admins. A privilege is represented by the\n [Privilege](/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege)\n resource.\n\n*Role*\n: A defined collection of privileges that can be assigned to a user or set of\n users, represented by the\n [Role](/workspace/admin/directory/reference/rest/v1/roles) resource.\n\n*Role assignment*\n: A record indicating which user is granted what roles, and over what scope.\n A role assignment is represented by the\n [RoleAssignment](/workspace/admin/directory/reference/rest/v1/roleAssignments)\n resource.\n\n*Schema*\n: A JSON object that defines custom user attributes for your organization,\n represented by the\n [Schema](/workspace/admin/directory/reference/rest/v1/schemas) resource.\n\n*User*\n: An individual end user account with access to Google Workspace apps and\n resources, represented by the\n [User](/workspace/admin/directory/reference/rest/v1/users) resource.\n\nNext steps\n----------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to\n [Get started as a Workspace developer](/workspace/guides/getstarted-overview).\n\n- To learn how to configure and run a simple Directory API app, try the\n [JavaScript quickstart](/workspace/admin/directory/v1/quickstart/js)."]]
