Different mabl API keys are permissioned for different use cases. Keys only have the read/write permissions necessary for a specific use case. See managing API keys for more information on working with API keys in mabl.
Key types fall into two groups. Workspace API keys act within a single workspace and are created by workspace owners from Settings > APIs. Company API keys act across every workspace your company owns and are created by account admins from the account dashboard.
Workspace API keys
| API key type | Use |
|---|---|
| CI/CD Integration | Use with mabl’s CI/CD integrations, including Jenkins, Bamboo, Microsoft Azure DevOps, GitHub Actions, and Octopus Deploy. |
| Command Line Interface | Use with the mabl CLI. |
| Deployment Trigger | Use to start tests with the Deployment Events API and to retrieve test results with the Execution Result API. |
| Editor | Use to perform actions permitted by the editor role. |
| Issue Tracker | Use with the mabl Jira plugin. |
| Java Selenium Agent | Use with Selenium Java Agent. |
| Link Agent | Use with the mabl Link agent. |
| Usage Analytics | Use with the mabl Segment integration. |
| Viewer | Use for mabl API endpoints that are read-only, such as the Reporting API. |
| Workspace admin | Use for read-write permissions with credentials and Link Agents. |
Company API keys
Company API keys are available to workspace owners with account admin permissions. Each type carries permission for one area of company-level work and nothing else, so a script that provisions workspaces cannot also read test results or manage users.
| API key type | Use |
|---|---|
| Reporting | Use with company-level test activity endpoints, including test run counts, execution seconds, and maximum test run concurrency at the account level. |
| User management | Use to automate user provisioning and role assignment at the company level. See manage workspaces and users with the mabl API. |
| Workspace lifecycle | Use to create, rename, and delete workspaces at the company level, along with read access to workspace settings. See manage workspaces and users with the mabl API. |
Workspace admin and Workspace lifecycle
These two types sound similar but differ in both scope and purpose. Workspace admin is a workspace key for managing credentials and Link Agents inside one workspace. Workspace lifecycle is a company key for creating, renaming, and deleting workspaces across your company.
The Integration key type is deprecated. Existing legacy Integration keys will continue to function, but users cannot create new API keys of this type.