Portal Administrator Root

URL:: https://organization.example.com/<context>/portaladmin
Methods:: GET
Operations:: Create Site, Export Site, Import Site, Join Site, Upgrade
Child Resources:: Info, Backup Restore Info, About, System
Version Introduced:: 10.2.1

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.

Add Manage Licenses Link to Organization-specific Group Security and Infrastructure Organization Website Collaborations Member Roles Servers Utility services

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 generateToken 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.

Learn how to generate a token

Description

This is the root resource for administering your portal. Starting from this root, all of the portal's environment is organized into a hierarchy of resources and operations. A version number is returned as a part of this resource.

After installation, the portal can be configured using the Create Site operation. Once initialized, the portal environment is available through System and Security resources.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL used to access the site root:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/portaladmin?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "isPostUpgrade": <true|false>,
  "isLicensePopulated": <true|false>,
  "siteKey": "<siteKey>",
  "resource": ["resource1", "resource2", ...],
  "isPortalLicensed": <true|false>,
  "isLicenseFileRequired": <true|false>
  "isUserTypeLicensing": <true|false>,
  "version": "<version>",
  "currentbuild": "<build>"
}

JSON Response example

Use dark colors for code blocksCopy
{
  "isPostUpgrade": false,
  "isLicensePopulated": true,
  "siteKey": "e4949632-0493-4c0b-bfc9-6fd2331a3be8",
  "resources": [
    "license",
    "system",
    "security",
    "federation",
    "logs",
    "machines",
    "license",
    "mode",
    "privilege"
  ],
  "isPortalLicensed": true,
  "isLicenseFileRequired": false,
  "isUserTypeLicensing": true,
  "version": "11.1.0",
  "currentbuild": "11.1.0.42854"
}