Environments

📘

This feature requires an ENTERPRISE license. If you would like to enable this feature for your Airkit Organization, please contact your Airkit representative or contact [email protected].

Environments provide the capability to isolate data, integrations, resources, APIs, tokens, and deployments within an organization. Environments serve as a container to organize these resources and allow builders to silo them, ensuring users access to the right resources. Every organization comes pre-provisioned with three default environments: Development, QA, and Production. These environments can then be used to assign resources to their respective environment, which can then be tied to a specific application using profiles. Environment access is also determined by the user role as well.

Below is a list of resources that can be separated by environment:

  • Datastores
  • Phone Numbers
  • URL Domains
  • URL Routes
  • Email Domains
  • Email Addresses
  • Embeds
  • Encryption keys
  • API Tokens
  • Standard integrations
  • Custom integrations
  • Deployments
  • Application Profiles
  • Applications Activity
  • Reporting
  • Logs and App Notifiers

Controlling access to resources (RBAC)

Managing access to resources can be done through role-based access control (RBAC). By assigning specific user roles, you can manage who has access to what resources and what environments they have access to. There are four user roles that you can assign to a user:

  • Agent
  • Developer
  • Admin
  • Custom Role

For more information on user roles, see User Roles.

Assigning a resource to an environment

When creating an integration, resource, or API in the console, builders have the option to select the environment in which it will be accessible in.  For example, when adding an integration, there is the option to select the environment that the integration will be created in.

By creating the integration in the Development Environment, the integration will only appear as a selectable option if the Development environment is selected in Settings.  To select the environment, go to Settings > Global and select Development in the Environment dropdown. 

Then when adding the integration, the integration should be accessible in the list of options. 

organizing info

Environments and Profiles

It is considered best practice to have your profiles and environments aligned. For example, the development profile should have the Development environment configured, QA profile with the QA environment, and the Production profile with the Production environment. By default, the environments are tied to their corresponding profiles, but you do have the option to change them. If changed, the resources will need to be reselected after switching.