Function disableUser

POST /users/disable - Disables an active user account.

Remarks

This endpoint is only available for Cognito.

📥 Request

Body:

provider: The authentication provider (required). Must be cognito-user.
email: The email of the user to disable. (required)
userPoolId: The Cognito User Pool ID where the user resides. (required)

Path Parameters:

None

Query Parameters:

None

📤 Response

204 No Content – Successfully disabled user.

❗ Errors

Status Code	Meaning	When it Happens
`400`	Bad Request	Missing or invalid parameters
`401`	Unauthorized	Missing or invalid authentication token
`403`	Forbidden	Insufficient privileges
`404`	Not Found	User not found
`429`	Too Many Requests	Rate limit exceeded
`500`	Internal Server Error	Unexpected error

Error Response Format

{
  "error": "Detailed error message here"
}

📦 Examples

📥 Cognito Request

POST /users/disable
{
  "provider": "cognito-user",
  "email": "user@district.com",
  "userPoolId": "us-east-1_abc123",
}

📤 Cognito Response

{}

disableUser(
    event: APIGatewayProxyEvent,
    context: Context,
    callback: Callback<APIGatewayProxyResult>,
): void | Promise<APIGatewayProxyResult>
Parameters
- event: APIGatewayProxyEvent
  The API Gateway event containing the request.
- context: Context
- callback: Callback<APIGatewayProxyResult>
Returns void | Promise<APIGatewayProxyResult>
A Promise resolving to an API Gateway-compatible response.