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.
Note:
The endpoint names listed below correspond to the names displayed in the REST API UI.
Site Root
Name | Endpoint type | Description |
---|---|---|
Resource | The site root is a collection of resources for administering your ArcGIS Enterprise portal. | |
Resource | The backupRestoreInfo resource displays the backup and restore information for your Enterprise portal. | |
Operation | The createNewSite operation initializes and configures your Enterprise portal for use. | |
Operation | The exportSite operation exports the Enterprise portal site configuration to a specified location. | |
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. | |
Operation | The joinSite operation connects a machine to an existing Enterprise portal site. | |
Operation | The upgrade operation upgrades your Enterprise portal from the previous version of the software to a newer version. |
System
Name | Endpoint type | Description |
---|---|---|
Resource | The system resource is an umbrella resource for a collection of system-wide resources for your Enterprise portal. | |
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. |
Operation | The update operation changes the common properties and configuration for your configured ArcGIS Web Adaptor. | |
Resource | The web adaptor resource returns the properties of an individual ArcGIS Web Adaptor. | |
Operation | The unregister operation unregisters an ArcGIS Web Adaptor from Portal for ArcGIS. | |
Resource | The directories resource is a collection of directories used by the Enterprise portal to store and manage content. | |
Resource | The directory resource returns the specific directory's properties. | |
Operation | The edit operation changes the physical path and description properties of a directory. | |
Resource | The database resource returns the name, version, and administrative database account information of the current database server. | |
Operation | The updateAdminAccount operation allows you to update the database administrator account credentials. | |
Resource | The settings resource returns whether incremental backups have been enabled or disabled for ArcGIS Enterprise. | |
Operation | The edit operation disables incremental backups for ArcGIS Enterprise if backups had been enabled using the webgisdr utility. | |
Resource | The indexer resource contains connection information for the default indexing service. | |
Operation | The reindex operation allows you to generate or update content indexes. | |
Operation | The reconfigure operation recreates the index service metadata, schema, and data in the event that the information is corrupted. | |
Resource | The status resource allows you to view the number of users, groups, and search items in both the database and index. | |
Resource | The properties resource lists the system properties in place to control your Enterprise portal. | |
Operation | The update operation updates one or more system properties. | |
Resource | The emailSettings resource returns the email settings that have been configured for your organization. | |
Operation | The update operation allows you to configure email settings for your organization. | |
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. | |
Operation | The delete operation deletes the current email settings for your organization. | |
Resource | The languages resource lists the languages that will appear in Enterprise portal content search results. | |
Operation | The update operation changes the languages that will have their content displayed in Enterprise portal search results. | |
Resource | The content resource provides access to the update content configuration resource. | |
Resource | The configuration resource provides access to the update content configuration operation. | |
Operation | The update operation allows you to enable or disable external content discovery from the Enterprise portal website. |
Security
Name | Endpoint type | Description |
---|---|---|
Resource | The security resource is the root of the security configurations and operations. | |
Resource | The users resource is an umbrella resource for operations that manage members within your organization. | |
Operation | The createUser operation allows you to pre-create built-in or enterprise accounts for users. | |
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. | |
Operation | The updateEnterpriseUser operation allows you to update the idpUsername for an enterprise user. | |
Operation | The searchEnterpriseUsers searches users in the configured enterprise user store. | |
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. | |
Resource | The groups resource is an umbrella for operations that manage enterprise groups within Enterprise portal. | |
Operation | The searchEnterpriseGroups operation searches groups in the configured enterprise group store. | |
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. | |
Operation | The getUsersWithinEnterpriseGroup operation returns the users that are currently assigned to the specified enterprise group. | |
Operation | The getEnterpriseGroupsForUser operation lists the groups assigned to a user account in the configured enterprise group store. | |
Resource | The tokens resource returns the token configuration for your Enterprise portal. | |
Operation | The update operation updates the shared key for your Enterprise portal. | |
Resource | The oauth resource contains a set of operations that updates the OAuth2-specific properties of registered applications. | |
Operation | The changeAppID operation changes the client ID of an application, as specified by the application developer. | |
Operation | The getAppInfo operation retrieves the client ID and redirect URIs of an application. | |
Operation | The updateAppInfo operation allows you to update the OAuth-specific properties associated with an application. | |
Resource | The config resource returns the current identity store configuration. | |
Operation | The update operation allows you to update Enterprise portal's security settings. | |
Operation | The updateIdentityStore operation changes the identity provider and group store configuration for your Enterprise portal. | |
Operation | The testIdentityStore operation allows you to test the connection to the user or group store. | |
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. | |
Operation | The update operation allows you to configure the web server certificate, TLS protocols, and cipher suites used by your Enterprise portal. | |
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. | |
Operation | The importRootOrIntermediate operation imports CA root and intermediate certificates into the keystore. | |
Operation | The importExistingServerCertificate operation imports an existing server certificate (PKCS #12 format) into the keystore. | |
Resource | The certificate resource returns the details of the specific SSL certificate. | |
Operation | The generateCsr operation generates a certificate signing request (CSR) for a self-signed certificate. | |
Operation | The export operation downloads an SSL certificate. | |
Operation | The delete operation deletes an SSL certificate from the key store. | |
Operation | The importSignedCertificate operation imports a certificate authority (CA) signed SSL certificate into the key store. |
Federation
Name | Endpoint type | Description |
---|---|---|
Resource | The federation resource returns information about the ArcGIS Server registered with Portal for ArcGIS. | |
Operation | The federate server enables ArcGIS Server to be federated with Portal for ArcGIS. | |
Operation | The validate operation returns information on the status of ArcGIS Server registered with Portal for ArcGIS. | |
Resource | The servers resource returns detailed information about the ArcGIS Server registered with Portal for ArcGIS. | |
Operation | The validate operation provides status information for a specific ArcGIS Server federated with Portal for ArcGIS. | |
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. | |
Operation | The unfederate operation unfederates an ArcGIS Server from Portal for ArcGIS. |
Logs
Name | Endpoint type | Description |
---|---|---|
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. | |
Operation | The query operation allows you to aggregate, filter, and page through logs for ArcGIS Enterprise portal. | |
Operation | The clean operation deletes all the log files on the machine hosting Portal for ArcGIS, freeing up disk space. | |
Resource | The settings resource returns the current log settings for ArcGIS Enterprise portal. | |
Operation | The edit operation updates the log settings for ArcGIS Enterprise portal. |
Machines
Name | Endpoint type | Description |
---|---|---|
Resource | The machines resource lists all machines registered with the site. | |
Resource | The machine resource returns information on a specific server machine registered with ArcGIS Enterprise portal. | |
Resource | The status operation checks whether an ArcGIS Enterprise portal machine is ready to receive requests. | |
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. | |
Operation | The update operation configures the web server certificate, TLS protocols, and cipher suites used by ArcGIS Enterprise portal. | |
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. | |
Operation | The importRootOrIntermediate operation imports a certificate authority's (CA) root and intermediate certificates into the key store. | |
Operation | The importExistingServerCertificate imports an existing server certificate, stored in the PKCS #12 format, into the key store. | |
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. | |
Operation | The generateCsr operation generates a certificate signing request (CSR) for a self-signed certificate. | |
Operation | The export operation downloads an SSL certificate. | |
Operation | The delete operation deletes an SSL certificate form the key store. | |
Operation | The importSignedCertificate operation imports a certificate authority (CA)-signed SSL certificate into the key store. |
License
Name | Endpoint type | Description |
---|---|---|
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. | |
Operation | The validateLicense operation validates an input license file | |
Operation | The importLicense operation imports a new license file | |
Operation | The populateLicense operation applies the license information from the license files used to create or upgrade your ArcGIS Enterprise portal. | |
Operation | The updateLicenseManager operation changes the license server connection information for your ArcGIS Enterprise portal. | |
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. | |
Operation | The getFutureLicense operation returns your future user types and add-on license information. |
Mode
Name | Endpoint type | Description |
---|---|---|
Resource | The mode resource returns whether your ArcGIS Enterprise deployment has been set to read-only mode. | |
Operation | The update operation enables read-only mode for your ArcGIS Enterprise deployment. |