Prevent unregistered users from spending credits

Language Icon 2 months ago · 2 min read
Cloud
Contribute Go to Code

Unregistered users trigger pipelines, spend credits and count towards your plan usage. You can choose to use the Prevent unregistered user spend option to only allow registered (users with a CircleCI account) users the ability to trigger work that consumes credits. For a full breakdown of the various ways pipelines can be triggered, see the Triggers overview.

Unregistered users are how CircleCI track users who have triggered builds but have not signed up for a CircleCI account. Each unregistered user within an org is mapped to, and counts as, a single active user. Unregistered users count towards your plan usage.

For more information about unregistered users, see this support article

Prerequisites

Steps

Follow these steps to prevent unregistered users from triggering work that consumes credits:

  1. In the CircleCI web app, select Plan in the sidebar.

  2. Select the Usage Controls tab. If you do not see this option you might be on the Free Plan, or you may not be an org admin, in which case this guide does not apply to you.

  3. Select Prevent unregistered user spend option to switch it to "On".

To disable this feature you can toggle this switch "Off" at any time.

Once enabled, any unregistered users, that is, users who do not have a CircleCI account, will see the following if they attempt to trigger a pipeline:

  • The pipeline will fail to start.

  • The block-unregistered-user error will be displayed in a banner on the dashboard