deactivate-user

Method: PUT
Path: /auth/user/{id}/deactivate

Tags: Auth

Summary

Deactivate account

Description

The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.

Storefront SDK Usage

SDK Method: sdk.auth.deactivateUserAccount()

Example:

// Deactivate a user account
const { data, error } = await sdk.auth.deactivateUserAccount({
  id: "01H9XYZ12345USERID"
});

if (error) {
  console.error("Failed to deactivate account:", error.message);
} else {
  console.log("Account deactivated successfully");
  console.log("Success:", data.success);
}

TypeScript Definition

"deactivate-user": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description user ID */
                id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @description A descriptive message confirming the success or failure of the deactivate account operation. */
                        message: string;
                        /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
                        success: boolean;
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• id (path): user ID

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Auth"
  ],
  "operationId": "deactivate-user",
  "summary": "Deactivate account",
  "description": "The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/deactivate-user",
    "description": "API reference for the deactivate-user operation"
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "user ID",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success"
            ],
            "properties": {
              "message": {
                "description": "A descriptive message confirming the success or failure of the deactivate account operation.",
                "type": "string"
              },
              "success": {
                "description": "Indicates whether the request was successful or failure (true for success, false for failure).",
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "auth",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "deactivateUser"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions