Method: enterprises.generateEnterpriseUpgradeUrl

  • This document outlines the process and details for generating an enterprise upgrade URL to transition a managed Google Play Accounts enterprise to a managed Google domain.

  • The HTTP request is a POST call to a specific Google API endpoint, requiring the enterprise name as a path parameter.

  • The request body optionally includes allowedDomains to restrict admin email domains and adminEmail to prefill the signup form, though it can be changed by the user.

  • A successful response body contains the generated upgrade URL that an enterprise admin can use.

  • The process requires authorization using the https://www.googleapis.com/auth/androidmanagement OAuth scope.

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 allowedDomains is non-empty then this must belong to one of the allowedDomains.

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.