Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Enterprises: generateSignupUrl
Stay organized with collections
Save and categorize content based on your preferences.
Generates a sign-up URL.
Request
HTTP request
POST https://www.googleapis.com/androidenterprise/v1/enterprises/signupUrl
Parameters
| Parameter name |
Value |
Description |
| Optional query parameters |
adminEmail |
string |
Optional. Email address used to prefill the admin field of the enterprise
signup form. This value is a hint only and can be altered by the user.
If `allowedDomains` is non-empty then this must belong to one of
the `allowedDomains`.
|
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 always allowed, but will result in the creation of a managed
Google Play Accounts enterprise.
|
callbackUrl |
string |
The callback URL to which the Admin will be redirected after successfully
creating an enterprise. Before redirecting there the system will add a
single query parameter to this URL named "enterpriseToken" which will
contain an opaque token to be used for the CompleteSignup request.
Beware that this means that the URL will be parsed, the parameter added
and then a new URL formatted, i.e. there may be some minor formatting
changes and, more importantly, the URL must be well-formed so that it can
be parsed.
|
Authorization
This request requires authorization with the following scope:
| Scope |
|---|
https://www.googleapis.com/auth/androidenterprise |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": string,
"url": string,
"completionToken": string
}
| Property name |
Value |
Description |
Notes |
url |
string |
A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe. |
|
completionToken |
string |
An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup. |
|
kind |
string |
Deprecated.
|
|
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-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[[["\u003cp\u003eGenerates a sign-up URL for Android enterprise enrollment using the \u003ccode\u003esignupUrl\u003c/code\u003e endpoint with an optional admin email and callback URL.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful signup, a response provides a sign-up URL for the admin and a completion token for finalizing the process with the \u003ccode\u003eCompleteSignup\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope is necessary to use this endpoint.\u003c/p\u003e\n"]]],[],null,["# Enterprises: generateSignupUrl\n\n| **Note:** Requires [authorization](#auth).\n\nGenerates a sign-up URL.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/androidenterprise/v1/enterprises/signupUrl\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Optional query parameters** |||\n| `adminEmail` | `string` | Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user. If \\`allowedDomains\\` is non-empty then this must belong to one of the \\`allowedDomains\\`. |\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 always allowed, but will result in the creation of a managed Google Play Accounts enterprise. |\n| `callbackUrl` | `string` | The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/androidenterprise` |\n\nFor more information, see the [authentication and authorization](/android/work/play/emm-api/v1/how-tos/authorizing) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": string,\n \"url\": string,\n \"completionToken\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `url` | `string` | A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe. | |\n| `completionToken` | `string` | An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup. | |\n| `kind` | `string` | Deprecated. | |"]]