Prevent unregistered users from spending credits
On This Page
It is possible for unregistered users to trigger pipelines, and therefore, spend credits. Use the Prevent unregistered user spend option to only allow registered 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.
An unregistered user is how CircleCI tracks users who have triggered builds but have not signed up for a CircleCI account. Unregistered user activity within an org is mapped to, and counts as, a single active user. For more information about unregistered users, see this support article |
Prerequisites
-
A CircleCI account connected to your code. You can sign up for free
-
You must be on the Performance or Scale Plan
-
You must be an org admin
Steps
Follow these steps to prevent unregistered users from triggering work that consumes credits:
-
In the CircleCI web app, click Plan in the sidebar
-
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.
-
Click the switch for the Prevent unregistered user spend option to "On"
To disable this feature you can toggle this switch "Off" at any time.
With this option enabled, any unregistered users, that is, users who do not have a CircleCI account, and who are not associated with your org, will see the following if they attempt to trigger a pipeline:
-
The pipeline will fail to start
-
The
block-unregistered-usererror will be displayed in a banner on the dashboard