What is an Access Key? Why would I want to customize it?
An Access Key is an authentication key generated by the API to identify the source or user making a request to the Keen platform service. The Custom Access Key feature is designed as a security enhancement to your event data architecture and design.
Custom Access Keys can be created and used to create finer controls over basic read & write functions. Some abilities include limiting read access to just a particular event collection, a specific timeframe, or data limited by a particular filter. This guarantees that each of your users can only explore the data they need because their granted permission credentials can be specified.
How to Create an Access Key
Access Keys can be generated, revoked or modified via two methods 1) the Keen User Interface and 2) the Keen API (allows for programmatic creation).
Create a New Access Key via the User Interface
Step 1: Log in to keen.io/home and select your Organization name
Step 2: Select your Project name
Step 3: Select Access (upper left navigation)
Step 4: Scroll down to the Access Keys section
Step 5: Click the New Access Key button
Step 6: An editing window will appear. Specify the particular queries, options, timeframe, or filters for this API Key and click the Create Access Key button
For details on Access Key Options, see: https://keen.io/docs/access/custom-access-keys/
Fig 1: Edit and save your Access Key
Create a New Access Key via the Keen API
While the point-and-click user interface allows you to create one Access Key at a time, the ability for keys to be generated via an API endpoint allows you create Access Keys for customers as part of your signup or onboarding flow. Many customers who create dashboards and customer-facing analytics for their users, automatically generate a key when onboarding a new account.
Custom Access Keys can be created programmatically via the Keen API. See our code samples and commands for creating custom Access Keys via the API in our API Reference Guide.