Aiven Integration

You must be an organization admin in Aiven to create application users.

1. Sign in to your Aiven Console.

2. Click Admin, then open Application users.

   
   

3. Click Create application user.

   
   

4. Enter a descriptive name (e.g., compyl-integration), and click Create application user.

   
   

5. Next, select Permissions from the left-hand menu, click on Grant permissions and select Grant to users.

   
   

6. In the Grant permissions window:

   • Under Users, select the application user you just created.

   • For Resource, choose your organization.

   • And for Permissions select:

     
     
     • role:organization:admin (required)
     • Each in-scope project (or org/unit-wide) that the integration should sync with:
       • operator
       • service:data:write
     • Optionally (only if you enable high-volume service log sync):
       • service:logs:read

   • Then click Grant permissions.

     📘

     Note

     role:organization:admin is broader than ideal, but it is the only Aiven permission that authorizes account authentication-method reads. Without it, Compyl cannot ingest account IdP / SAML / SCIM authentication configuration. Compyl does not call billing APIs.

   
   

7. Go back to Application users and then open your created Application user.

   
   

8. Click on Generate token.

   
   

9. OPTIONAL: Enter a description, set a session duration, and add an IP address range allowlist for the token. If you set scopes, use the optional scope list above and omit billing/payment scopes.

   
   

10. Click the Copy icon and store the token in a secure location (password manager or secrets vault). You will paste this value into Compyl as the API Key.

    
    

    ❗

    Important

    Aiven shows the token only at creation time. You cannot view it again after you close the window. Copy and store it securely immediately.