API - DELETE organization, does it delete all documents and workspaces?

Juan_Carvajal_B · July 31, 2023, 3:07pm

As the title says, does the API endpoint for organization delete all documents and workspaces associated with it?

paul-grist · July 31, 2023, 3:46pm

I don’t believe it does @Juan_Carvajal_B. The supported way to delete an organization is to call the method Doom.deleteOrg:

github.com

gristlabs/grist-core/blob/e1df6039c2e047ebecadc226b2a363bd1412b61d/app/gen-server/lib/Doom.ts#L31-L49


      
          public async deleteOrg(orgKey: number) {
            await this._removeBillingFromOrg(orgKey);
            const workspaces = await this._getWorkspaces(orgKey);
            for (const workspace of workspaces) {
              await this.deleteWorkspace(workspace.id);
            }
            const finalWorkspaces = await this._getWorkspaces(orgKey);
            if (finalWorkspaces.length > 0) {
              throw new ApiError(`Failed to remove all workspaces from org ${orgKey}`, 500);
            }
            // There is a window here in which user could put back docs, would be nice to close it.
            const scope: Scope = {
              userId: this._dbManager.getPreviewerUserId(),
              specialPermit: {
                org: orgKey
              }
            };
            await this._dbManager.deleteOrg(scope, orgKey);
          }

but I don’t think it has an endpoint yet.

There is an old undocumented DELETE /api/orgs/ORGID endpoint, but I’m not sure it have been updated to delete all site resources (as opposed to database listings for those resources).

Updating and documenting an endpoint for this should in principle be straightforward, is this a blocker for you? We also happily accept pull requests at GitHub - gristlabs/grist-core: Grist is the evolution of spreadsheets.

Juan_Carvajal_B · August 2, 2023, 9:35am

thanks, unfortunately I am not familiar at all with the grist codebase, otherwise I’d glad to help.

For the moment we will use the following endpoint to get the list of docs and workspaces and delete them manually.

https://{subdomain}.getgrist.com/api/orgs/{orgId}/workspaces