Pure API: Access definitions for content and field filteringPure API: Access definitions for content and field filtering

Overview

Setting available to user role: Administrator          
Location in Pure: Administrator > Pure API > Access definitions

Each API keys is now linked to an access definition:

• You can create multiple access definitions.
• You can use the same definition with multiple API keys (one-to-many).
• One API key can be paired with only one access definition (one-to-one).

Access definition: customizing accessible types and fields

Access definition editor > Types and fields lets you edit each available type to:

• Specify access mode to the type (read-only, or read and write).
• Choose fields exposed for that type:
  • You can allow all fields by enabling the 'Allow all fields' setting.
    • All new fields added to the type in the future will also become available in that definition.
  • When the setting is off, you can manually select allowed fields.
    • There is an option to 'Add all' or 'Remove all' fields.

This means that you have flexibility to, for example, allow read-only access to some types, and read and write access to others.

Note: The names of the fields in the editor correspond to the field names in the JSON response from the API. 

Adding an access definition to a new API key

1. When you create a new API key, you need to link it to a specific access definition.
2. Once you have selected the definition, you can preview the details of the definition directly in the API key editor (1) to cross-check how the types and filters have been setup.
3. Important: You still need to configure the endpoints that the API key can access in the API key editor (2). The access definition assigned to the key will only work for the endpoints that are explicitly added for this key.