- URL:
- https://<root>/system/database/updateAdminAccount
- Methods:
POST- 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.
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 update operation changes the database administrator account credentials. By default, the initial administrator account you define during the Create Site operation is used as the database administrator account. To change just the password for the account, provide the password parameter. If you want to create a completely new account for the database, provide new values for the username and password parameters.
Request parameters
| Parameter | Details |
|---|---|
| The new database administrator user name. If this parameter is not provided, only the password for the account is changed. Example |
| The new password for the account. Example |
| The response parameter. The default response parameter is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/portaladmin/system/database/updateAdminAccount HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=newdbadmin&password=newdbadminpassword&f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}