Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Server Administrator API must include a token in the request body.
Description
The psa resource provides access to operations that configure the credentials and the login privileges of the primary site administrator account. This account is stored within server and can be used to log into the server and perform administrative workflows. Use the Update operation to change the name and the password for the account. However, if you don't want to use this default administrative account (and prevent anybody from using it to log into Manager), you can use the Disable operation to disable the login capabilities of the account. The JSON response for this resource returns if this account has been disabled or not.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the psa resource:
https://organization.example.com/<context>/admin/security/psa?f=pjsonJSON Response example
{
"disabled": "true"
}