Endpoint Summaries

This topic provides a short summary for each available endpoint in the ArcGIS Portal Administrator Directory API to help quickly identify which documentation you might need to access depending on your workflow and needs.

Site Root

Name	Endpoint type	Description
Site Root	Resource	The site root is a collection of resources for administering your ArcGIS Enterprise portal.
Backup Restore Information	Resource	The `backupRestoreInfo` resource displays the backup and restore information for your Enterprise portal.
Create Site	Operation	The `createNewSite` operation initializes and configures your Enterprise portal for use.
Export Site	Operation	The `exportSite` operation exports the Enterprise portal site configuration to a specified location.
Import Site	Operation	The `importSite` operation lets you restore your site from a backup site configuration file, importing the configuration generated from the `exportSite` operation into a currently running Enterprise portal site.
Join Site	Operation	The `joinSite` operation connects a machine to an existing Enterprise portal site.
Upgrade	Operation	The `upgrade` operation upgrades your Enterprise portal from the previous version of the software to a newer version.

System

Name	Endpoint type	Description
System	Resource	The `system` resource is an umbrella resource for a collection of system-wide resources for your Enterprise portal.
Web Adaptors	Resource	The `webadaptors` resource lists the ArcGIS Web Adaptor configured with Portal for ArcGIS.
Web Adaptors Configuration	Resource	The `config` resource provides a collection of configuration properties that apply to your configured ArcGIS Web Adaptor.
Update Web Adaptor Configuration	Operation	The `update` operation changes the common properties and configuration for your configured ArcGIS Web Adaptor.
Web Adaptor	Resource	The web adaptor resource returns the properties of an individual ArcGIS Web Adaptor.
Unregister Web Adaptor	Operation	The unregister operation unregisters an ArcGIS Web Adaptor from Portal for ArcGIS.
Directories	Resource	The `directories` resource is a collection of directories used by the Enterprise portal to store and manage content.
Directory	Resource	The directory resource returns the specific directory's properties.
Edit Directory	Operation	The `edit` operation changes the physical path and description properties of a directory.
Database	Resource	The `database` resource returns the name, version, and administrative database account information of the current database server.
Update Admin Account	Operation	The `updateAdminAccount` operation allows you to update the database administrator account credentials.
Database Settings	Resource	The `settings` resource returns whether incremental backups have been enabled or disabled for ArcGIS Enterprise.
Edit Database Settings	Operation	The `edit` operation disables incremental backups for ArcGIS Enterprise if backups had been enabled using the webgisdr utility.
Indexer	Resource	The `indexer` resource contains connection information for the default indexing service.
Reindex	Operation	The `reindex` operation allows you to generate or update content indexes.
Reconfigure	Operation	The `reconfigure` operation recreates the index service metadata, schema, and data in the event that the information is corrupted.
Index Status	Resource	The `status` resource allows you to view the number of users, groups, and search items in both the database and index.
System Properties	Resource	The `properties` resource lists the system properties in place to control your Enterprise portal.
Update System Properties	Operation	The `update` operation updates one or more system properties.
Email Settings	Resource	The `emailSettings` resource returns the email settings that have been configured for your organization.
Update Email Settings	Operation	The `update` operation allows you to configure email settings for your organization.
Test Email Settings	Operation	The `test` operation can be used to send a test email to the SMTP server to ensure that your organization's email settings have been properly configured.
Delete Email Settings	Operation	The `delete` operation deletes the current email settings for your organization.
Languages	Resource	The `languages` resource lists the languages that will appear in Enterprise portal content search results.
Update Languages	Operation	The `update` operation changes the languages that will have their content displayed in Enterprise portal search results.
Content	Resource	The `content` resource provides access to the update content configuration resource.
Content Configuration	Resource	The `configuration` resource provides access to the update content configuration operation.
Update Content Configuration	Operation	The `update` operation allows you to enable or disable external content discovery from the Enterprise portal website.

Security

Name	Endpoint type	Description
Security	Resource	The `security` resource is the root of the security configurations and operations.
Users	Resource	The `users` resource is an umbrella resource for operations that manage members within your organization.
Create User	Operation	The `createUser` operation allows you to pre-create built-in or enterprise accounts for users.
Get Enterprise User	Operation	The `getEnterpriseUser` operation returns the description, full name, and email address for a specified user in the enterprise identity store configured with Enterprise portal.
Update Enterprise User	Operation	The `updateEnterpriseUser` operation allows you to update the `idpUsername` for an enterprise user.
Search Enterprise Users	Operation	The `searchEnterpriseUsers` searches users in the configured enterprise user store.
Refresh Membership	Operation	The `refreshMembership` operation iterates over every configured enterprise group in your Enterprise portal and determines if the input user account belongs to any of those groups.
Groups	Resource	The `groups` resource is an umbrella for operations that manage enterprise groups within Enterprise portal.
Search Enterprise Groups	Operation	The `searchEnterpriseGroups` operation searches groups in the configured enterprise group store.
Refresh Membership	Operation	The `refreshMembership` operation iterates over every enterprise account in your Enterprise portal and determines if a user account is a part of the specified enterprise groups.
Get Users Within Enterprise Group	Operation	The `getUsersWithinEnterpriseGroup` operation returns the users that are currently assigned to the specified enterprise group.
Get Enterprise Groups for User	Operation	The `getEnterpriseGroupsForUser` operation lists the groups assigned to a user account in the configured enterprise group store.
Token Configuration	Resource	The `tokens` resource returns the token configuration for your Enterprise portal.
Update Token Configuration	Operation	The `update` operation updates the shared key for your Enterprise portal.
OAuth	Resource	The `oauth` resource contains a set of operations that updates the OAuth2-specific properties of registered applications.
Change AppID	Operation	The `changeAppID` operation changes the client ID of an application, as specified by the application developer.
Get App Info	Operation	The `getAppInfo` operation retrieves the client ID and redirect URIs of an application.
Update App	Operation	The `updateAppInfo` operation allows you to update the OAuth-specific properties associated with an application.
Security Configuration	Resource	The `config` resource returns the current identity store configuration.
Update Security Configuration	Operation	The `update` operation allows you to update Enterprise portal's security settings.
Update Identity Store	Operation	The `updateIdentityStore` operation changes the identity provider and group store configuration for your Enterprise portal.
Test Identity Store	Operation	The `testIdentityStore` operation allows you to test the connection to the user or group store.
SSL Certificates	Resource	The `sslCertificates` resource lists all certificates (self-signed and CA-signed) created for the portal machine, as well as the certificates currently configured with Portal for ArcGIS.
Update Web Server Certificate	Operation	The `update` operation allows you to configure the web server certificate, TLS protocols, and cipher suites used by your Enterprise portal.
Generate Certificate	Operation	The `generateCertificate` operation allows you to create a self-signed certificate. This operation can also act a starting point for getting a production-ready CA-signed certificate.
Import Root or Intermediate Certificate	Operation	The `importRootOrIntermediate` operation imports CA root and intermediate certificates into the keystore.
Import Existing Server Certificate	Operation	The `importExistingServerCertificate` operation imports an existing server certificate (PKCS #12 format) into the keystore.
SSL Certificate	Resource	The `certificate` resource returns the details of the specific SSL certificate.
Generate CSR	Operation	The `generateCsr` operation generates a certificate signing request (CSR) for a self-signed certificate.
Export Certificate	Operation	The `export` operation downloads an SSL certificate.
Delete Certificate	Operation	The `delete` operation deletes an SSL certificate from the key store.
Import Signed Certificate	Operation	The `importSignedCertificate` operation imports a certificate authority (CA) signed SSL certificate into the key store.

Federation

Name	Endpoint type	Description
Federation	Resource	The `federation` resource returns information about the ArcGIS Server registered with Portal for ArcGIS.
Federate Server	Operation	The `federate` server enables ArcGIS Server to be federated with Portal for ArcGIS.
Validate Servers	Operation	The `validate` operation returns information on the status of ArcGIS Server registered with Portal for ArcGIS.
Servers	Resource	The `servers` resource returns detailed information about the ArcGIS Server registered with Portal for ArcGIS.
Validate Server	Operation	The `validate` operation provides status information for a specific ArcGIS Server federated with Portal for ArcGIS.
Update Server	Operation	The `update` operation allows you to set an ArcGIS Server, federated with Portal for ArcGIS, as the hosting server or to enforce fine-grained access control to a federated server.
Unfederate Server	Operation	The `unfederate` operation unfederates an ArcGIS Server from Portal for ArcGIS.

Logs

Name	Endpoint type	Description
Logs	Resource	The `logs` resources provides access to various operations and resources that allow you to query and clean logs, as well as edit the log settings.
Query Logs	Operation	The `query` operation allows you to aggregate, filter, and page through logs for ArcGIS Enterprise portal.
Clean Logs	Operation	The `clean` operation deletes all the log files on the machine hosting Portal for ArcGIS, freeing up disk space.
Log Settings	Resource	The `settings` resource returns the current log settings for ArcGIS Enterprise portal.
Edit Log Settings	Operation	The `edit` operation updates the log settings for ArcGIS Enterprise portal.

Machines

Name	Endpoint type	Description
Machines	Resource	The `machines` resource lists all machines registered with the site.
Machine	Resource	The machine resource returns information on a specific server machine registered with ArcGIS Enterprise portal.
Machine Status	Resource	The `status` operation checks whether an ArcGIS Enterprise portal machine is ready to receive requests.
SSL Certificates	Resource	The `sslCertificates` resource lists all the certificates (self-signed and CA-signed) created for the ArcGIS Enterprise portal machine as well as the certificates currently configured with ArcGIS Enterprise portal.
Update Web Server Certificate	Operation	The `update` operation configures the web server certificate, TLS protocols, and cipher suites used by ArcGIS Enterprise portal.
Generate Certificate	Operation	The `generateCertificate` operation can be used to create a self-signed certificate or as a starting point for getting a production-ready CA-signed certificate.
Import Root or Intermediate Certificate	Operation	The `importRootOrIntermediate` operation imports a certificate authority's (CA) root and intermediate certificates into the key store.
Import Existing Server Certificate	Operation	The `importExistingServerCertificate` imports an existing server certificate, stored in the PKCS #12 format, into the key store.
SSL Certificate	Resource	The SSL certificate resource returns the certificate details for an SSL certificate and provides access to operations that can be used to manage SSL certificates in a highly available portal.
Generate CSR	Operation	The `generateCsr` operation generates a certificate signing request (CSR) for a self-signed certificate.
Export	Operation	The `export` operation downloads an SSL certificate.
Delete Certificate	Operation	The `delete` operation deletes an SSL certificate form the key store.
Import Signed Certificate	Operation	The `importSignedCertificate` operation imports a certificate authority (CA)-signed SSL certificate into the key store.

License

Name	Endpoint type	Description
License	Resource	The `license` resource returns higher level information such as the total number of registered members that can be added, the current number of members in the organization, the ArcGIS Enterprise portal version, and license manager information.
Validate License	Operation	The `validateLicense` operation validates an input license file
Import License	Operation	The `importLicense` operation imports a new license file
Populate License	Operation	The `populateLicense` operation applies the license information from the license files used to create or upgrade your ArcGIS Enterprise portal.
Update License Manager	Operation	The `updateLicenseManager` operation changes the license server connection information for your ArcGIS Enterprise portal.
Release License	Operation	The `releaseLicense` operation releases an ArcGIS Pro license for the account of a user who had previously checked out the license for offline or disconnected user.
Get Future License	Operation	The `getFutureLicense` operation returns your future user types and add-on license information.

Mode

Name	Endpoint type	Description
Mode	Resource	The `mode` resource returns whether your ArcGIS Enterprise deployment has been set to read-only mode.
Update Mode	Operation	The `update` operation enables read-only mode for your ArcGIS Enterprise deployment.