|
3 | 3 | :page-description: A how to guide to configuring your org so that unregistered users will not be able to perform actions that spend credits
|
4 | 4 | :experimental:
|
5 | 5 |
|
6 |
| -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 xref:orchestrate:triggers-overview.adoc[Triggers overview]. |
| 6 | +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 xref:orchestrate:triggers-overview.adoc[Triggers overview]. |
7 | 7 |
|
8 | 8 | ****
|
9 |
| -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 link:https://support.circleci.com/hc/en-us/articles/360034783154[active user]. |
| 9 | +*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 link:https://support.circleci.com/hc/en-us/articles/360034783154[active user]. Unregistered users count towards your plan usage. |
10 | 10 |
|
11 | 11 | For more information about unregistered users, see this link:https://support.circleci.com/hc/en-us/articles/360037744473-What-is-an-Unregistered-User-[support article]
|
12 | 12 | ****
|
13 | 13 |
|
14 | 14 | [#prerequisites]
|
15 | 15 | == Prerequisites
|
16 | 16 |
|
17 |
| -* A CircleCI account connected to your code. You can link:https://circleci.com/signup/[sign up for free] |
18 |
| -* You must be on the link:https://circleci.com/pricing/[Performance or Scale Plan] |
19 |
| -* You must be an org admin |
| 17 | +* A CircleCI account connected to your code. You can link:https://circleci.com/signup/[sign up for free]. |
| 18 | +* You must be on the link:https://circleci.com/pricing/[Performance or Scale Plan]. |
| 19 | +* You must be an org admin. |
20 | 20 |
|
21 | 21 | [#steps]
|
22 | 22 | == Steps
|
23 | 23 |
|
24 | 24 | Follow these steps to prevent unregistered users from triggering work that consumes credits:
|
25 | 25 |
|
26 |
| -. In the CircleCI web app, click btn:[Plan] in the sidebar |
| 26 | +. In the link:https://app.circleci.com/[CircleCI web app], select *Plan* in the sidebar. |
27 | 27 | . 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.
|
28 |
| -. Click the switch for the **Prevent unregistered user spend** option to "On" |
| 28 | +. Select **Prevent unregistered user spend** option to switch it to "On". |
29 | 29 |
|
30 | 30 | To disable this feature you can toggle this switch "Off" at any time.
|
31 | 31 |
|
32 | 32 | 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:
|
33 | 33 |
|
34 |
| -* The pipeline will fail to start |
| 34 | +* The pipeline will fail to start. |
35 | 35 | * The `block-unregistered-user` error will be displayed in a banner on the dashboard
|
0 commit comments