Présentation de l'API Directory
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
L'API Directory fait partie de l'API RESTful du SDK Admin. Vous pouvez l'utiliser pour créer et gérer de façon programmatique des ressources contrôlées par l'administrateur appartenant à un compte Google Workspace. Voici quelques cas d'utilisation :
- Créer et gérer des utilisateurs, et ajouter des administrateurs
- Créer et gérer des groupes et des appartenances à des groupes.
- Surveiller les appareils connectés à votre domaine et prendre des mesures en cas de perte d'appareils.
- Gérer votre organigramme et les structures de votre organisation.
- Vérifier les applications auxquelles vos utilisateurs ont accordé l'accès et révoquer les applications non autorisées.
Vous trouverez ci-dessous une liste des termes courants utilisés dans l'API Directory :
- Client
- Entité propriétaire du compte Google Workspace, représentée par la ressource Customer.
- Domaine
- Le cas échéant, le domaine DNS associé à un compte Google Workspace, représenté par la ressource Domain. Tous les comptes ne sont pas associés à un domaine.
- Unité organisationnelle (UO)
- Sous-unité de l'arborescence organisationnelle d'un compte Google Workspace, utilisée pour regrouper et trier les utilisateurs afin d'appliquer des règles et d'accorder des autorisations. Une UO est représentée par la ressource OrgUnit.
- Droit
- Capacité d'un utilisateur à effectuer une action sur une ressource Google Workspace.
S'applique principalement aux administrateurs. Un privilège est représenté par la ressource Privilege.
- Rôle
- Ensemble défini de droits d'accès pouvant être attribués à un utilisateur ou à un ensemble d'utilisateurs, représenté par la ressource Role.
- Attribution de rôle
- Enregistrement indiquant les rôles attribués à un utilisateur et leur portée.
Une attribution de rôle est représentée par la ressource RoleAssignment.
- Schéma
- Objet JSON qui définit les attributs utilisateur personnalisés pour votre organisation, représentés par la ressource Schema.
- Utilisateur
- Compte d'utilisateur final individuel ayant accès aux applications et ressources Google Workspace, représenté par la ressource User.
Étapes suivantes
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 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)."]]
