Skip To Content

Renew ArcGIS credentials

Beginning with version 5.0, ArcGIS Maps for SharePoint uses a server-side user login solution that makes use of an app ID and refresh token to generate a powerful and secure access token. Access tokens represent your ArcGIS credentials and are used to ensure secure transactions when using ArcGIS Maps for SharePoint. In most cases, refresh tokens do not expire, but you can optionally configure them to do so.

If you have configured your refresh tokens to expire, you can set up ArcGIS Maps for SharePoint to periodically run a SharePoint timer job to automatically renew the refresh tokens before they expire.

The ArcGIS Maps Refresh Token Autorenewal feature leverages new functionality in ArcGIS Online and ArcGIS Enterprise 10.6 and later. The process takes an existing unexpired refresh token and returns a new refresh token. As soon as the new refresh token is issued, the old refresh token is immediately invalidated (all access tokens issued by this refresh token are also immediately invalidated). In very limited instances, the refresh token is not properly written back to SharePoint; you must manually renew the refresh token using the ArcGIS Maps for SharePoint configuration settings.

Note:

  • This solution is available only with ArcGIS Maps for SharePoint on-premises using ArcGIS Online or ArcGIS Enterprise 10.6 and later. If you're using an earlier version of ArcGIS Enterprise, you'll need to manually renew your refresh tokens.
  • If your refresh tokens have not been set to expire, you do not need to activate the ArcGIS Maps Refresh Token Autorenewal feature. It is recommended that you activate this feature only if your tokens are set to expire.
  • Set the Renew ArcGIS Refresh Token timer job frequency to run before the tokens expire. Because the timer job is maintained by the standard SharePoint Timer Service, the timer job may be delayed or stopped by other processes. If this occurs, you must manually renew the refresh tokens.

Set up the ArcGIS Maps Refresh Token Autorenewal feature during installation

Prerequisite:

You must be a SharePoint farm administrator to access the ArcGIS Maps for SharePoint administration menu and configure the app.

Note:

If your refresh tokens have not been set to expire, you do not need to activate the ArcGIS Maps Refresh Token Autorenewal feature.

To set up the ArcGIS Maps Refresh Token Autorenewal feature during installation, do the following:

  1. In the Renew your ArcGIS credentials in SharePoint pane of the installation wizard, choose the Activate ArcGIS Maps Refresh Token auto-renewal option.
    Install the
    Note:

    Although the first option installs the farm-scoped ArcGIS Maps Refresh Token Autorenewal feature, the feature remains deactivated, meaning the timer job is not deployed. You can manually activate the feature at any time using the SharePoint Central Administration application.

  2. In the interval field, type a value that is shorter than the token's expiration time.

    For example, if your tokens are set to expire after 60 minutes, set the timer interval to run every 40 minutes. Acceptable values here must be between 1 and 59 minutes, but you can change these settings later to specify different timelines.

  3. Click Next to continue the installation.

After the installation is complete, the Renew ArcGIS Refresh Token timer job is created and runs automatically. You can also change the interval settings for the timer job and view its history to troubleshoot errors.

Activate the ArcGIS Maps Refresh Token Autorenewal feature after installation

Prerequisite:

You must be a SharePoint farm administrator to access the ArcGIS Maps for SharePoint administration menu and configure the app.

If you chose not to install and set up the ArcGIS Maps Refresh Token Autorenewal feature during installation, the feature must be manually activated for it to deploy the timer job.

To activate the ArcGIS Maps Token Refresh Autorenewal feature, do the following:

  1. Browse to the SharePoint Central Administration home page.
  2. In the System Settings section, under Farm Management, click Manage farm features.

    The page lists all available features for that SharePoint farm.

  3. Scroll to ArcGIS Maps Token Refresh Autorenewal and click Activate.
    Activate Renew

    The Renew ArcGIS Refresh Token timer job is installed and runs automatically according to the default interval.

  4. To remove the Renew ArcGIS Refresh Token timer job and the SharePoint service that contains the timer job, click Deactivate.

Change the Renew ArcGIS Refresh Token timer job settings

Prerequisite:

You must be a SharePoint farm administrator to access the ArcGIS Maps for SharePoint administration menu and configure the app.

Use the SharePoint Central Administration application to change the timer job interval.

  1. On the Central Administration home page, in the Monitoring section, under Timer Jobs, click Review job definitions.

    By default, SharePoint lists all available job definitions.

  2. To filter the view, click View > Service in the drop-down menu.
  3. From the Service drop-down menu, choose Change service.

    A pop-up window appears, listing available services.

  4. Click ArcGIS Refresh Token Renewal Service.

    The service appears on the Job Definition page.

  5. Click Refresh ArcGIS refresh token to view the timer job details.

    The Edit Timer Job page appears, showing the default timer value (every 30 seconds) or the timer interval you set during installation.

    Renew
  6. Set the timer interval.

    You can set the timer schedule by minute, hour, day, week, or month.

    When choosing the timer interval, choose an interval that is shorter than the life-span of the ArcGIS Mapsrefresh token. For example, if your tokens are set to expire after 60 minutes, set the timer job interval to 40 minutes.

    Remember that, because the timer job is run by the SharePoint Timer Service, the Renew ArcGIS Refresh Token timer job may be delayed or stopped by other processes. If this occurs, you must manually renew refresh tokens.

  7. Click Run now to immediately run the Renew ArcGIS Refresh Token timer job and renew the refresh tokens for all site collections within the current SharePoint farm that have ArcGIS credentials set.

    Alternatively, click one of the following buttons:

    • Click OK to save the changes and close the timer job page. The Renew ArcGIS Refresh Token timer job will run at the specified interval.
    • Click Disable to deactivate the timer job. The Renew ArcGIS Refresh Token timer job will not run again until the service is reactivated.
    • Click Cancel to return to the Job Definitions page without making any changes.

Troubleshoot Renew ArcGIS Refresh Token timer job failure

The SharePoint Central Administration application includes a timer job history page that allows you to quickly establish whether a job has run successfully or failed. If a job fails, click the failed link to view a detailed log of the timer job to determine why it failed.

For example, the Renew ArcGIS Refresh Token timer job requires new functionality available in ArcGIS Online and ArcGIS Enterprise 10.6 and later. If the job history log contains a message such as grant_type invalid, this indicates that you're using an older, unsupported version of ArcGIS Enterprise.

Manually renew ArcGIS refresh tokens

Renewing the refresh tokens consists of updating the ArcGIS identity used to ensure secure transactions when using ArcGIS Maps for SharePoint. You can set the configuration options for multiple site collections at once, or you can configure the add-in on individual site collections.

Use the Central Administration application to manually renew the refresh tokens for all selected SharePoint site collections in a SharePoint farm. To renew a refresh token for a single site collection, use the local ArcGIS Maps for SharePoint configuration page for that site collection.

The configuration page shows the amount of time remaining before the refresh token expires.

Renew refresh tokens for multiple site collections

Prerequisite:

You must be a SharePoint farm administrator to access the ArcGIS Maps for SharePoint administration menu and configure the app.

If you have multiple site collections that use the same ArcGIS Maps for SharePoint settings, you can renew the refresh tokens for all (or some) site collections at the same time.

To renew refresh tokens for multiple site collections, do the following:

  1. On the Central Administration home page, in the Security section, under ArcGIS Maps for SharePoint Administration, click App Configuration.

    The ArcGIS Maps for SharePoint Configuration page appears, listing all site collections available to be configured.

    Batch configuration page in SharePoint Central Administration
  2. In the Configuration targets section, use the arrows to choose the site collections to configure.
  3. In the ArcGIS credentials section, enter the ArcGIS credentials to use to generate the refresh tokens and click Set.

    A message appears; click OK.

  4. Sign in to ArcGIS using a valid ArcGIS account.

    The refresh tokens associated with the selected site collections are renewed. A message appears, showing the amount of time remaining before the tokens expire. You can renew these settings at any time.

    Reset ArcGIS identity to renew refresh tokens

Renew refresh tokens for a single site collection

To renew the refresh token for a single site collection, do the following:

  1. Browse to the Site Settings page for the site collection that you want to modify.
    Site settings
  2. In the ArcGIS Maps for SharePoint Administration section, click App configuration.

    The ArcGIS Maps for SharePoint Configuration page for that site collection appears.

  3. In the ArcGIS credentials section, enter the ArcGIS credentials to use to generate the refresh token and click Set.

    A message appears; click OK.

  4. Sign in to ArcGIS using a valid ArcGIS account.

    The refresh token associated with the site collection is renewed. A message appears, showing the amount of time remaining before the token expires. You can renew these settings at any time.

    Reset the ArcGIS identity to renew refresh tokens.