Method: enterprises.generateEnterpriseUpgradeUrl
Stay organized with collections
Save and categorize content based on your preferences.
Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide for more details.
HTTP request
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*}:generateEnterpriseUpgradeUrl
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the enterprise to be upgraded in the form enterprises/{enterpriseId}.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"allowedDomains": [
string
],
"adminEmail": string
} |
| Fields |
allowedDomains[] |
string
Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has *. prefixed to the domain name (e.g. *.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed.
|
adminEmail |
string
Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If allowedDomainsallowedDomains
|
Response body
Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.
Note: This feature is not generally available.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"url": string
} |
| Fields |
url |
string
A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidmanagement
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-10 UTC.
[null,null,["Last updated 2025-06-10 UTC."],[],[],null,["# Method: enterprises.generateEnterpriseUpgradeUrl\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GenerateEnterpriseUpgradeUrlResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGenerates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See [the guide](https://developers.google.com/android/management/upgrade-an-enterprise) for more details.\n\n### HTTP request\n\n`POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*}:generateEnterpriseUpgradeUrl`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the enterprise to be upgraded in the form `enterprises/{enterpriseId}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------|\n| ``` { \"allowedDomains\": [ string ], \"adminEmail\": string } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `allowedDomains[]` | `string` Optional. A list of domains that are permitted for the admin email. The IT admin cannot enter an email address with a domain name that is not in this list. Subdomains of domains in this list are not allowed but can be allowed by adding a second entry which has `*.` prefixed to the domain name (e.g. \\*.example.com). If the field is not present or is an empty list then the IT admin is free to use any valid domain name. Personal email domains are not allowed. |\n| `adminEmail` | `string` Optional. Email address used to prefill the admin field of the enterprise signup form as part of the upgrade process. This value is a hint only and can be altered by the user. Personal email addresses are not allowed. If [`allowedDomains`](/android/management/reference/rest/v1/enterprises/generateEnterpriseUpgradeUrl#body.request_body.FIELDS.allowed_domains) is non-empty then this must belong to one of the [`allowedDomains`](/android/management/reference/rest/v1/enterprises/generateEnterpriseUpgradeUrl#body.request_body.FIELDS.allowed_domains). |\n\n### Response body\n\nResponse message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.\n\n**Note:** This feature is not generally available.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------|\n| ``` { \"url\": string } ``` |\n\n| Fields ||\n|-------|--------------------------------------------------------------------------------------------------------------|\n| `url` | `string` A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidmanagement`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
