Skip to content

Commit 1e062cc

Browse files
Document organization deletion feature (#9475)
* Adding new page with instructions to delete organizations and projects * Adding navigation item pointing to new page * Adjusting layout * Removing project deletion content and linking to new location * Small fixes * Turning sentence into caution block * Changing header alignment * Rewording * Adding warning * Modifying some text * Adding note and link to 'Stop building' page * Adding notes for BB Data Center * Adding actions and roles to permission matrix * Implementing review suggestions --------- Co-authored-by: Rosie Yohannan <[email protected]>
1 parent 1ffc39f commit 1e062cc

File tree

4 files changed

+155
-33
lines changed

4 files changed

+155
-33
lines changed

docs/guides/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,7 @@
248248
*** xref:security:rotate-project-ssh-keys.adoc[Rotate project SSH keys]
249249
*** xref:security:stop-building-a-project-on-circleci.adoc[Stop building a project on CircleCI]
250250
*** xref:security:rename-organizations-and-repositories.adoc[Rename organizations and repositories]
251+
*** xref:security:delete-organizations-and-projects.adoc[Delete organizations and projects]
251252
252253
* Manage config policies
253254
** xref:config-policies:config-policy-management-overview.adoc[Config policy management overview]

docs/guides/modules/permissions-authentication/pages/roles-and-permissions-overview.adoc

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The table below shows the permissions associated with each CircleCI organization
2020
[cols=4*, options="header"]
2121
|===
2222
| ACTIONS
23-
3+| ORGANIZATION ROLES
23+
3+^| ORGANIZATION ROLES
2424

2525
| *Organization*
2626
^| *Admin*
@@ -101,12 +101,22 @@ The table below shows the permissions associated with each CircleCI organization
101101
^| [.circle-green]#**Yes**#
102102
^| [.circle-red]#**No**#
103103
^| [.circle-red]#**No**#
104+
105+
| Rename org
106+
^| [.circle-green]#**Yes**#
107+
^| [.circle-red]#**No**#
108+
^| [.circle-red]#**No**#
109+
110+
| Delete org
111+
^| [.circle-green]#**Yes**#
112+
^| [.circle-red]#**No**#
113+
^| [.circle-red]#**No**#
104114
|===
105115

106116
[cols=4*, options="header"]
107117
|===
108118
| ACTIONS
109-
3+| ORGANIZATION ROLES
119+
3+^| ORGANIZATION ROLES
110120

111121
| *Insights*
112122
^| *Admin*
@@ -122,7 +132,7 @@ The table below shows the permissions associated with each CircleCI organization
122132
[cols=4*, options="header"]
123133
|===
124134
| ACTIONS
125-
3+| ORGANIZATION ROLES
135+
3+^| ORGANIZATION ROLES
126136

127137
| *Runner*
128138
^| *Admin*
@@ -143,7 +153,7 @@ The table below shows the permissions associated with each CircleCI organization
143153
[cols=4*, options="header"]
144154
|===
145155
| ACTIONS
146-
3+| ORGANIZATION ROLES
156+
3+^| ORGANIZATION ROLES
147157

148158
| *Projects*
149159
^| *Admin*
@@ -169,7 +179,7 @@ The table below shows the permissions associated with each CircleCI organization
169179
[cols=4*, options="header"]
170180
|===
171181
| ACTIONS
172-
3+| ORGANIZATION ROLES
182+
3+^| ORGANIZATION ROLES
173183

174184
| *Contexts*
175185
^| *Admin*
@@ -200,7 +210,7 @@ The table below shows the permissions associated with each CircleCI organization
200210
[cols=4*, options="header"]
201211
|===
202212
| ACTIONS
203-
3+| ORGANIZATION ROLES
213+
3+^| ORGANIZATION ROLES
204214

205215
| *Orbs*
206216
^| *Admin*
@@ -231,7 +241,7 @@ The table below shows the permissions associated with each CircleCI organization
231241
[cols=4*, options="header"]
232242
|===
233243
| ACTIONS
234-
3+| ORGANIZATION ROLES
244+
3+^| ORGANIZATION ROLES
235245

236246
| *Webhooks*
237247
^| *Admin*
@@ -262,7 +272,7 @@ The table below shows the permissions associated with each CircleCI organization
262272
[cols=4*, options="header"]
263273
|===
264274
| ACTIONS
265-
3+| ORGANIZATION ROLES
275+
3+^| ORGANIZATION ROLES
266276

267277
| *Schedule*
268278
^| *Admin*
@@ -283,7 +293,7 @@ The table below shows the permissions associated with each CircleCI organization
283293
[cols=4*, options="header"]
284294
|===
285295
| ACTIONS
286-
3+| ORGANIZATION ROLES
296+
3+^| ORGANIZATION ROLES
287297

288298
|*Triggers*
289299
^| *Admin*
@@ -309,7 +319,7 @@ The table below shows the permissions associated with each CircleCI organization
309319
[cols=4*, options="header"]
310320
|===
311321
| ACTIONS
312-
3+| ORGANIZATION ROLES
322+
3+^| ORGANIZATION ROLES
313323

314324
|*Pipelines*
315325
^| *Admin*
@@ -330,7 +340,7 @@ The table below shows the permissions associated with each CircleCI organization
330340
[cols=4*, options="header"]
331341
|===
332342
| ACTIONS
333-
3+| ORGANIZATION ROLES
343+
3+^| ORGANIZATION ROLES
334344

335345
|*Releases*
336346
^| *Admin*
@@ -387,7 +397,7 @@ The table below shows the permissions associated with each CircleCI project role
387397
[cols=4*, options="header"]
388398
|===
389399
| ACTIONS
390-
3+| PROJECT ROLES
400+
3+^| PROJECT ROLES
391401

392402
| *Projects*
393403
^| *Admin*
@@ -413,12 +423,17 @@ The table below shows the permissions associated with each CircleCI project role
413423
^| [.circle-green]#**Yes**#
414424
^| [.circle-red]#**No**#
415425
^| [.circle-red]#**No**#
426+
427+
| Delete project
428+
^| [.circle-green]#**Yes**#
429+
^| [.circle-red]#**No**#
430+
^| [.circle-red]#**No**#
416431
|===
417432

418433
[cols=4*, options="header"]
419434
|===
420435
| ACTIONS
421-
3+| PROJECT ROLES
436+
3+^| PROJECT ROLES
422437

423438
| *Webhooks*
424439
^| *Admin*
@@ -439,7 +454,7 @@ The table below shows the permissions associated with each CircleCI project role
439454
[cols=4*, options="header"]
440455
|===
441456
| ACTIONS
442-
3+| PROJECT ROLES
457+
3+^| PROJECT ROLES
443458

444459
| *Schedule*
445460
^| *Admin*
@@ -460,7 +475,7 @@ The table below shows the permissions associated with each CircleCI project role
460475
[cols=4*, options="header"]
461476
|===
462477
| ACTIONS
463-
3+| PROJECT ROLES
478+
3+^| PROJECT ROLES
464479

465480
| *Triggers*
466481
^| *Admin*
@@ -486,7 +501,7 @@ The table below shows the permissions associated with each CircleCI project role
486501
[cols=4*, options="header"]
487502
|===
488503
| ACTIONS
489-
3+| PROJECT ROLES
504+
3+^| PROJECT ROLES
490505

491506
| *Contexts*
492507
^| *Admin*
@@ -518,7 +533,7 @@ The table below shows the permissions associated with each CircleCI project role
518533
[cols=4*, options="header"]
519534
|===
520535
| ACTIONS
521-
3+| PROJECT ROLES
536+
3+^| PROJECT ROLES
522537

523538
| *Pipelines*
524539
^| *Admin*
@@ -539,7 +554,7 @@ The table below shows the permissions associated with each CircleCI project role
539554
[cols=4*, options="header"]
540555
|===
541556
| ACTIONS
542-
3+| PROJECT ROLES
557+
3+^| PROJECT ROLES
543558

544559
| *Releases*
545560
^| *Admin*
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
= Delete organizations and projects
2+
:page-platform: Cloud
3+
:page-description: Learn how to delete organizations and projects in CircleCI.
4+
:experimental:
5+
6+
This page details everything you need to know about deleting organizations and projects connected to CircleCI.
7+
8+
If you only want to stop builds for a project and keep the complete build history, see the xref:security:stop-building-a-project-on-circleci.adoc[Stop building a project on CircleCI] page.
9+
10+
[cols="1,^1,^1,2", options="header"]
11+
|===
12+
| VCS integration | Delete organization | Delete project | Notes
13+
14+
| GitHub App
15+
| [.circle-green]#Yes#
16+
| [.circle-green]#Yes#
17+
| The organization will remain visible for several hours before disappearing.
18+
19+
| GitLab
20+
| [.circle-green]#Yes#
21+
| [.circle-green]#Yes#
22+
| The organization will remain visible for several hours before disappearing.
23+
24+
| Bitbucket Data Center
25+
| [.circle-green]#Yes#
26+
| [.circle-green]#Yes#
27+
| The organization will remain visible for several hours before disappearing.
28+
29+
| GitHub OAuth app
30+
| [.circle-green]#Yes#
31+
| [.circle-green]#Yes#
32+
| Deleting the organization removes all content from the organization. The organization will remain visible but without data underneath.
33+
34+
| Bitbucket Cloud
35+
| [.circle-green]#Yes#
36+
| [.circle-green]#Yes#
37+
| Deleting the organization removes all content from the organization. The organization will remain visible but without data underneath.
38+
39+
|===
40+
41+
42+
[#delete-an-organization]
43+
== Delete an organization
44+
45+
[NOTE]
46+
====
47+
You can only delete an organization when both the below conditions are met:
48+
49+
- The organization is on a Free Plan.
50+
- The user performing the action has an admin role in the organization.
51+
====
52+
You can delete your organization from the CircleCI web app or via the CircleCI API:
53+
54+
CAUTION: This action will permanently delete the organization for you and all organization members.
55+
56+
[tabs]
57+
====
58+
CircleCI web app::
59+
+
60+
--
61+
. In the link:https://app.circleci.com[CircleCI web app], select your org from the org cards on your user homepage.
62+
. Select **Organization Settings** in the sidebar.
63+
. Scroll to the bottom of the Overview page and select btn:[Delete Organization].
64+
. Confirm your choice by typing the organization name and selecting btn:[Permanently Delete Organization] in the popup.
65+
--
66+
API::
67+
+
68+
--
69+
. Set up your API authentication. Steps are available in the xref:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide].
70+
. You can use the link:https://circleci.com/docs/api/v2/#tag/Organization/operation/deleteOrganization[Delete an organization] endpoint with either your organization ID or your organization slug. You can retrieve both from the CircleCI web app under menu:Organization Settings[Overview].
71+
+
72+
[,shell]
73+
----
74+
curl --request DELETE \
75+
--url https://circleci.com/api/v2/organization/<org-slug-or-id> \
76+
--header "Circle-Token: ${CIRCLE_TOKEN}"
77+
----
78+
--
79+
====
80+
81+
[#delete-a-project]
82+
== Delete a project
83+
84+
NOTE: Only organization admins and project admins can delete projects.
85+
86+
If you want to remove a project from your CircleCI account, follow the steps below.
87+
88+
CAUTION: Deleting a project will remove the complete build history.
89+
90+
[tabs]
91+
====
92+
CircleCI web app::
93+
+
94+
--
95+
include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[]
96+
97+
[start=4]
98+
. Scroll to the bottom of the Overview page, select **Delete Project**.
99+
. Confirm your choice by typing the project name and selecting btn:[Permanently Delete Project] in the popup.
100+
--
101+
API::
102+
+
103+
--
104+
. Set up your API authentication. Steps are available in the xref:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide].
105+
. You need the project slug to use the link:https://circleci.com/docs/api/v2/#tag/Project/operation/deleteProjectBySlug[Delete a project] endpoint. You can retrieve the project slug from the CircleCI web app under menu:Project Settings[Overview].
106+
+
107+
[,shell]
108+
----
109+
curl --request DELETE \
110+
--url https://circleci.com/api/v2/project/<project-slug> \
111+
--header "Circle-Token: ${CIRCLE_TOKEN}"
112+
----
113+
--
114+
====
115+
116+
If you encounter an error, open a new link:https://support.circleci.com/hc/en-us/requests/new[support request] with details of the project that you wish to remove. Choose the "Build Failure/Configuration Help/Service Issue" option when opening the request.
117+
118+
For more information on submitting support requests, see https://support.circleci.com/hc/en-us/articles/27162205043995-How-to-submit-a-support-ticket[How to submit a support ticket
119+
].

docs/guides/modules/security/pages/stop-building-a-project-on-circleci.adoc

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
[#introduction]
77
== Introduction
8-
This page outlines how to stop builds for a project on CircleCI, and how to delete a project when required.
8+
This page outlines how to stop builds for a project on CircleCI.
99

1010
[#stop-building-a-project]
1111
== Stop building a project
1212

13-
CAUTION: The **Stop Building** option will not automatically remove all project data from the CircleCI databases. To remove all project data from CircleCI you need to contact CircleCI support, as detailed in the <<remove-a-project-from-circleci>> section.
13+
CAUTION: The **Stop Building** option does not automatically remove all project data from the CircleCI databases. To remove all project data from CircleCI, see the xref:security:delete-organizations-and-projects.adoc#delete-a-project[Delete a project] documentation.
1414

1515
include::ROOT:partial$notes/standalone-unsupported.adoc[This feature is not supported for GitLab, GitHub App or Bitbucket Data Center]
1616

@@ -20,16 +20,3 @@ If you are using the GitHub OAuth App or Bitbucket Cloud, to stop building one o
2020
. Scroll to the bottom of the Overview page and select **Stop Building**. You will need to reconfirm your choice in the popup.
2121

2222
NOTE: If you want to start building this project again, just go to the **Projects** page in the web app and select **Set Up Project** and follow the set up steps.
23-
24-
[#remove-a-project-from-circleci]
25-
== Delete a project from CircleCI
26-
27-
If you want to remove a project from your CircleCI account, follow the steps below. Deleting a project will remove the complete build history. Only organization admins and project admins can delete projects.
28-
29-
. In the link:https://app.circleci.com/home/[CircleCI web app], select the organization associated with the project you want to remove.
30-
. Select the project you want to remove from the project cards. If you do not see your project, select **Projects** in the sidebar and find it in the list.
31-
. Select **Project Settings** (or the ellipsis next to your project image:guides:ROOT:icons/more.svg[more icon, role="no-border"] and then select **Project Settings**).
32-
. Scroll to the bottom of the Overview page and select **Delete Project** and reconfirm your choice in the popup.
33-
34-
35-
If you encounter an error, open a new link:https://support.circleci.com/hc/en-us/requests/new[support request] with details of the project that you wish to remove. Choose the "Build Failure/Configuration Help/Service Issue" option when opening the request. For more information on submitting support requests, see this https://support.circleci.com/hc/en-us/articles/27162205043995-How-to-submit-a-support-ticket[support article].

0 commit comments

Comments
 (0)