atom/icon/16/caret-leftatom/icon/16/caret-leftatom/icon/24/cc-sacloseatom/icon/16/cropatom/icon/16/data_repo/atom/icon/16/drawatom/icon/16/emailatom/icon/16/expandatom/icon/16/eyeatom/icon/16/eye-closedatom/icon/16/folderatom/icon/16/folder--emptyatom/icon/16/layeratom/icon/16/locationatom/icon/16/locationatom/icon/16/mapatom/icon/16/megaphoneatom/icon/16/alarmatom/icon/16/quoteatom/icon/16/set/atom/icon/16/settingsGroup 9Combined Shapeatom/icon/16/zoom-to

Site Admin APIs

Get Started Account and Support File Formats and Data Types Find and Export Data Esri REST Services, Query API and Web Services Import Data Manage Your Site Plugins Publish Data Site Admin APIs
API Admin Glossary API Client Library Cartography API Data Catalog API Data Object Identifiers API Data Sources API Documents API Export API Feedback API Introducing the Admin API Layers & tables API License API Metadata API Permissions API Publishing API Redaction API Sets API Set scopes for an API token Users & Groups API
Update Data Users and Groups Desktop App Frequently Asked Questions
  1. Home
  2. Site Admin APIs
  3. Set scopes for an API token

Set scopes for an API token

API tokens are used to manage a range of tasks using the Koordinates APIs.  

Users can set the scopes for an API token by creating an API key in the user interface. 

1

Select API Keys in your user profile menu

2

Select Create API Key with the Manual scope

Be sure to give your API Key an appropriate label.

3

Determine the scopes for your Admin API token

API keys can have optional scopes and controls which limit what they can do. These work in addition to dataset and service permissions and user group membership but do not override these - for example an API key with WMTS set to "No access" will not be usable against any WMTS endpoint regardless of the users status and dataset settings, nor will that API key have wider dataset access than the user account which created the API key.

The API key dashboard will provide you with a range of options to set the scopes for your API token. Select which scopes you wish to include. 

4

Set referrer domains to your API Key

For paid-seat users in eligible sites, we provide the option to lock API keys to one or more domains. This scope ensures that some user cannot copy an API key to gain access to a service into their own software. To learn more about this functionality, see https://help.koordinates.com/classic/api/publisher-admin-api/token-api/