Enterprises: generateSignupUrl

Generates a sign-up URL.


HTTP request



Parameter name Value Description
Optional query parameters
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.
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.


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


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.