- URL:
- https://<root>/createNewSite
- Methods:
POST- Version Introduced:
- 10.2
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The create operation initializes and configures an ArcGIS Enterprise portal for use. It must be the first operation invoked after installation. Creating a new site involves the following:
- Creating the initial administrator account
- Creating a database administrator account (which is same as the initial administrator account)
- Creating token shared keys
- Registering directories
This operation is time consuming, as the database is initialized and populated with default templates and content. If the database directory is not empty, the operation attempts to migrate the database to the current version while keeping its data intact. At the end of the operation, the web server that hosts the API is automatically restarted.
Request parameters
| Parameter | Details |
|---|---|
| The initial administrator account name. Example |
| The password for the initial administrator account. Example |
| The full name for the initial administrator account. Example |
| The account email address. Example |
| An optional description for the account. Example |
| The index of the secret question to retrieve a forgotten password. The secret questions and their indexes are listed below. Example |
| The answer to the secret question specified in the Example |
| The JSON string including the path to the location of the site's content. Example |
| The portal license file. You obtain the portal license file (a multipart POST file that contains information regarding your user types, apps, and app bundles) from My Esri. For more information, see Obtain a portal license file. |
| The user type for the initial administrator account. The values listed below are the user types that are compatible with the Administrator role. For more information about roles and user types, see User types, roles, and privileges. Values: |
| Introduced at ArcGIS Enterprise 11.3. Specifies the log level when creating a portal site. If Values: |
| Introduced at ArcGIS Enterprise 12.0. This parameter specifies whether the operation is performed asynchronously. If set as Values: |
| The formatting parameter. The default format is Values: |
Secret questions and indexes
The security parameter defines a security question that is used when retrieving a forgotten password. Listed below are the security questions and their associated index numbers:
| Index number | Security question |
|---|---|
1 | What city were you born in? |
2 | What was your high school mascot? |
3 | What is your mother's maiden name? |
4 | What was the make of your first car? |
5 | What high school did you go to? |
6 | What is the last name of your best friend? |
7 | What is the middle name of your youngest sibling? |
8 | What is the name of the street on which you grew up? |
9 | What is the name of your favorite fictional character? |
10 | What is the name of your favorite pet? |
11 | What is the name of your favorite restaurant? |
12 | What is the title of your favorite book? |
13 | What is your dream job? |
14 | Where did you go on your first date? |
Example usage
The following is a sample POST request for the create operation:
POST /<context>/portaladmin/createNewSite HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----boundary
Content-Length: []
------boundary
Content-Disposition: form-data; name="username"
cadmin
------boundary
Content-Disposition: form-data; name="password"
admin.secret
------boundary
Content-Disposition: form-data; name="fullname"
Administrator
------boundary
Content-Disposition: form-data; name="email"
admin@email.com
------boundary
Content-Disposition: form-data; name="description"
The initial admin account
------boundary
Content-Disposition: form-data; name="securityQuestionIdx"
1
------boundary
Content-Disposition: form-data; name="securityQuestionAns"
Mumbai
------boundary
Content-Disposition: form-data; name="contentStore"
{"type": "fileStore","provider": "FileSystem","connectionString": "C:/arcgisportal/content"}
------boundary
Content-Disposition: form-data; name="file"; filename=""
Content-Type: application/octet-stream
portal_license.json
------boundary
Content-Disposition: form-data; name="userLicenseTypeId"
creatorUT
------boundary
Content-Disposition: form-data; name="async"
true
------boundary
Content-Disposition: form-data; name="f"
pjson
------boundaryJSON Response examples
The sample response below is returned when the operation is performed synchronously and the site is created succesfully:
{
"status": "success",
"recheckAfterSecs": 10
}