Prevent unregistered users from spending credits
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.
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, select 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.
-
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-usererror will be displayed in a banner on the dashboard