Page Summary
-
The
generateSignupUrlmethod creates a sign-up URL for an enterprise. -
This request requires authorization using the
https://www.googleapis.com/auth/androidenterprisescope. -
Optional query parameters include
adminEmail,allowedDomains, andcallbackUrlto customize the signup process. -
The response contains a
urlfor the signup page and acompletionTokenneeded for theCompleteSignuprequest.
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.
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. |
