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 status resource returns the current status of the indexing service and the number of users, groups, and search items in both the database (store) and the index.
If, in the response, the database and index values do not match, indexing is either in progress or there is a problem with the index. If indexing is in progress, you can view the status by refreshing the page. If indexing is complete and there is a problem with the index, perform the Reindex to correct any issues.
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 status resource:
https://organization.example.com/<context>/portaladmin/system/indexer/status?f=pjsonJSON Response example
{
"indexes": [
{
"name": "users",
"databaseCount": 118,
"indexCount": 118
},
{
"name": "groups",
"databaseCount": 455,
"indexCount": 455
},
{
"name": "search",
"databaseCount": 16451,
"indexCount": 16451
}
],
"syncStatus": true
}