canonical: https://jentic.com/apis/googleapis.com/google-managed-microsoft-ad # Google Managed Service for Microsoft Active Directory API Managed Service for Microsoft Active Directory provides a hardened, highly available Microsoft AD running on Google Cloud, with the API covering domain provisioning, trust relationships, schema extension, LDAPS configuration, backups, and migration from existing on-premises forests. Operations are scoped to project locations and most state changes return long-running operation handles for polling. The API also exposes domain-join helpers, peerings, and SQL integration controls used by hybrid Windows workloads. ## For AI agents Provision and manage Google Cloud's managed Microsoft Active Directory: create domains, attach trusts, extend the schema, configure LDAPS, run backups, and join machines to the domain. ## Scope Does not handle AD user accounts, group policy, or DNS records inside the domain - use for managed domain lifecycle, trusts, schema, LDAPS, backups, and migration only. ## Capabilities - Provision and delete managed Microsoft AD domains in Google Cloud project locations - Attach, detach, validate, and reconfigure forest trusts with on-premises or other AD environments - Extend the AD schema with custom attributes via the extendSchema operation - Configure and update LDAPS settings on a managed domain - Trigger and restore from domain backups for disaster recovery - Initiate, check, disable, and enable migration from an existing AD forest into the managed service - Domain-join machines and manage peerings to connected VPCs ## Use cases ### Hybrid Windows workload identity Stand up a managed Microsoft Active Directory domain in Google Cloud and attach a forest trust to an existing on-premises AD so that Windows VMs and SQL Server workloads in Google Cloud authenticate users from the corporate directory. The managed service handles patching, replication, and high availability so platform teams do not run their own domain controllers. Example prompt: Create a managed AD domain named corp.example.com in projects/acme/locations/global, then call attachTrust with the on-premises forest target and validate the trust ### AD forest migration to Google Cloud Migrate from a self-managed Active Directory forest into Managed Microsoft AD using the migration endpoints, which let you check, enable, and disable migration permission and execute the cutover. The flow keeps existing SIDs and group memberships so workloads continue to authenticate without reconfiguration. Example prompt: Call checkMigrationPermission on the source domain, enableMigration if eligible, and poll the returned operation until cutover is complete ### Schema extension and LDAPS hardening Extend the managed AD schema to add custom attributes that downstream applications require, and configure LDAPS so applications that demand encrypted LDAP can bind securely to the managed domain. The schema extension and LDAPS update endpoints both return long-running operations. Example prompt: Call extendSchema with the LDIF describing a new employeeBadgeID attribute, then update the domain's ldapssettings to enforce LDAPS only ### Agent integration via Jentic AI agents managing Windows fleets on Google Cloud can use this API through Jentic to provision domains, join VMs, or kick off backups without holding the underlying OAuth refresh token in the prompt. Long-running operation handles are returned for the agent to poll. Example prompt: Call domainJoinMachine for the VM corp-app-1 in projects/acme and confirm the join completes by polling the returned operation ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /v1/{+parent}/domains | List managed AD domains in a location | | DELETE | /v1/{+name} | Delete a managed AD domain | | POST | /v1/{+name}:attachTrust | Attach a forest trust | | POST | /v1/{+domain}:extendSchema | Extend the AD schema | | POST | /v1/{+domain}:domainJoinMachine | Join a machine to the managed domain | | POST | /v1/{+domain}:checkMigrationPermission | Check AD migration eligibility | | POST | /v1/{+domain}:enableMigration | Enable migration mode | | GET | /v1/{+name}/ldapssettings | Read LDAPS settings | ## Key resources - **domains** — Provision, list, update, and delete managed Microsoft AD domains - **trusts** — Attach, detach, validate, and reconfigure forest trusts - **ldapssettings** — Configure and update LDAPS encryption on a domain - **backups** — Create and list backups of managed AD domains - **peerings** — Manage VPC peerings used by the managed AD service - **operations** — Track and cancel long-running operations across all resources ## Why Jentic - **Setup:** Wiring the Managed Service for Microsoft Active Directory API by hand means setting up Google OAuth 2.0 with the cloud-platform scope, refreshing bearer tokens, and polling long-running domain operations yourself against the managedidentities.googleapis.com host. Through Jentic you install once, import the Managed Service for Microsoft Active Directory API from the API Directory, store the OAuth credential once, and your agent calls it. - **Permission scoping:** This API puts the managed domain name in the URL path (/v1/{+domain}... and /v1/{+name}...), so a rule can pin your agent to one managed domain: it can attach trusts and read LDAPS settings there and nothing else. You choose the operations it may call, so destructive ones like domain deletion or enabling migration are not included unless you add them. - **Credential handling:** Your Google OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'provision a managed Active Directory domain' or 'attach an AD trust', and Jentic returns the matching managed-AD operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Identity and Access Management (IAM) API** — Google Cloud's native IAM for service accounts, roles, and policy bindings on Google Cloud resources - **Compute Engine API** — Provisions the Windows VMs that join the managed AD domain - **IAM Service Account Credentials API** — Issues short-lived credentials for Google Cloud workloads when LDAP-based identity is not required ## FAQ ### What authentication does the Managed Microsoft AD API use? The API uses Google OAuth 2.0 with the https://www.googleapis.com/auth/cloud-platform scope. Through Jentic the OAuth client credentials and refresh tokens are stored encrypted; the agent only ever sees a scoped, short-lived bearer token. ### Can I attach a trust to an on-premises AD forest through this API? Yes, the attachTrust endpoint creates a forest or external trust between a managed domain and a remote forest. You then call validateTrust to confirm the relationship is healthy before relying on it for authentication. ### What are the rate limits for this API? Per-project quotas are listed under the Managed Service for Microsoft AD service in the Google Cloud Console quotas page. Most lifecycle and trust operations are long-running and have concurrency caps in addition to per-minute request limits. ### How do I migrate an existing AD forest to managed AD through Jentic? Search Jentic for migrate active directory to google cloud, load the checkMigrationPermission and enableMigration operations, and execute them in sequence with the domain resource path. Jentic injects the OAuth token and surfaces the returned long-running operation for polling. ### Is the Managed Microsoft AD API free? API calls themselves are not separately billed, but managed AD domains incur a per-hour charge per domain plus network egress. See the Managed Service for Microsoft AD pricing page for current rates. ### Does this API let me create AD users or groups? No, user, group, and OU management happens through standard Windows tools or LDAP clients connected to the running domain. This API manages the domain itself, trusts, schema, LDAPS, backups, and migrations. ### Can I limit what my agent is allowed to do with the Managed Microsoft AD API? Yes. Because this API carries the managed domain name in the URL path (/v1/{+domain} and /v1/{+name}), a rule in your self-hosted Jentic One instance can pin the agent to a single domain, letting it do things like attach trusts or read LDAPS settings there and nothing else. You decide which operations the agent may call, so destructive ones such as domain deletion or enableMigration are excluded unless you add them. Your own rules and your stored OAuth credential control exactly what the agent can reach.