A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/ below:

Introduction to API key authentication | Documentation

API key authentication is a type of authentication that uses long-lived access tokens embedded directly into an application to authenticate requests to access secure ArcGIS services and items. The access tokens are called API keys and managed through API key credentials. It is the easiest type of authentication to set up, and is the recommended type of authentication for public applications that access ArcGIS Location Services.

You can use API key authentication to:

Billing

All API key usage is billed to the ArcGIS subscription associated with the developer's account who created the key.

How API key authentication works The API key authentication workflow

API key authentication requires creating and configuring API key credentials so you can get an API key. An API key is a long-lived access token. API key credentials are an item created in your portal that are used to create API keys and manage their privileges.

The general steps to implement API key authentication are:

  1. Create API key credentials to get an API key.

  2. Paste the API key access token into your application.

  3. Your application uses the API key as an access token to access secure resources.

Your API key must have the correct privileges to access secure resources. It is also recommended that you set referrer URLs in order to enhance the security of the token. These properties are managed through setting page of API key credentials.

Tutorial

To learn how to create and manage an API key, go to the Create an API key tutorial.

API key credentials

API key credentials are an item in your portal used to create and manage API keys. You can manage the settings of API key credentials on their item page to generate up to two API keys, define their privileges and set their expiration dates. API key credentials can also be used to regenerate or invalidate existing API keys.

API key authentication requires API key credentials. The most common pattern is to create a new API key credentials item for each application. API key credentials are used to configure the privileges of an API key, which grant access to specific services, items, and operations in ArcGIS.

Topic

To learn more, go to API key credentials.

Hybrid authentication

In ArcGIS APIs, the AuthenticationManager and IdentityManager classes automatically implement a hybrid approach when using both API key authentication and user authentication.

Applications can use both API keys and user authentication, utilizing their API key to access services while the user is signed out and then switching to an access token from user authentication when the user signs in.

Tip

ArcGIS Maps SDKs will automatically prefer an API key over a token from user authentication if both are configured. To learn more, go to User authentication with ArcGIS APIs.

Product and account requirements

API key authentication is available with ArcGIS Location Platform, ArcGIS Online, and ArcGIS Enterprise.

To create and manage API key credentials for API key authentication, you need an ArcGIS account with a user type of Creator or higher. Your account must also have these additional privileges:

ArcGIS Location Platform accounts have these privileges by default. If you have an ArcGIS Online or ArcGIS Enterprise account, your organization administrator can grant you these privileges using a custom role. Learn more in the FAQ.

Note

API key authentication is available with ArcGIS Enterprise version 11.4 or greater. The steps in this chapter apply to the latest version of ArcGIS Enteprise (11.5).

Tutorials

Create an API key

Create and configure API key credentials to get a long-lived API key access token.


Manage API key credentials

Manage previously created API key credentials to regenerate, edit privileges, and edit item access of API keys.


Update to API key credentials

Migrate from an API key (legacy) created before June 2024 to an API key from API key credentials.


Rotate API keys

Rotate API keys in a deployed application to refresh their expiration dates.


Limitations ArcGIS Enterprise

Version requirement: API key authentication is only available with ArcGIS Enterprise version 11.4 or greater. ArcGIS Enterprise does not support API keys (legacy).

Service limitations: API key authentication cannot be used to access ArcGIS Location Services with ArcGIS Enterprise. However, API keys can still be used to access secure items in your Enterprise portal, such as locators (geocoding services) and hosted data services.

API key credentials

Creating credentials: There is no limit to the number of API key credentials and API keys you can create.

Accessing items: An API key credential can be configured to access a maximum of 100 items you own.

Viewing API keys: The value of an API key can only be viewed when the API key is first generated. After a key has been created, its full value is no longer accessible and is not stored in ArcGIS. If you lose the value of an API key, you have to invalidate it and generate a new key using the API key credentials item page.

Changing properties: Editing any of the privileges, item access privileges, or the expiration date of API key credentials will invalidate all associated API keys. New keys can be generated in the Settings section of the API key credentials item page.

Topic

To learn more, go to API Key Credentials.

API keys (legacy) Attention

API keys (legacy) are being retired. All legacy API keys should be replaced with keys from API key credentials. To learn more, go to API key (legacy) retirement.

Prior to June 2024, API key authentication used API keys (legacy). These API keys still function, but can no longer be created or modified and will soon be retired. All new API keys must be created using API key credentials.

Service support

The following table provides an overview of the functionality available with each type of authentication:

API key authentication User authentication App authentication ArcGIS Location Services 1 1 1 Data services (Item access) Spatial analysis services 1 1 Portal service (General privileges) Portal service (Admin privileges) Full support Partial support No support API support Full support Partial support No support

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4