Skip to main content

Integration Specifications

Prerequisites

Getting your API key

  1. After logging in to Plain, open the settings and select Machine users & Agents under Developer. Plain settings menu with Machine users & Agents under Developer highlighted
  2. Click Add machine user.
  3. Enter a Name and a Public name. Make sure Type is set to API integration, then click Create machine user. Machine user creation screen with API integration selected and the Create machine user button highlighted
  4. Open the machine user you created and click Add API key.
  5. Make sure all of the following permissions are selected, then create the API key.
    • permission:read
    • roles:assign
    • roles:read
    • user:edit
    • user:read
    • workspaceInvite:create
    • workspaceInvite:delete
    • workspaceInvite:edit
    • workspaceInvite:read
  6. Copy the API key you created and store it in a safe place.
To delete accounts from Admina, the API key also needs the user:delete permission in addition to the permissions above.

Setting up the integration

  1. On the integration screen, search for Plain.
  2. Enter the API key you obtained in the previous steps into API key, then click Connect. Plain integration setup screen showing the API key field and the Connect button
  3. Once the integration with Plain succeeds, registered user information appears in the account list. If it doesn’t complete successfully, first try the steps in Troubleshoot SaaS integration errors. If that doesn’t resolve it, check Information to provide and contact support.
Last modified on October 15, 2026