Users
Delete user permanently
Changed onPermanently removes a user from your environment and deletes all associated data. Use this endpoint when you need to completely remove a user account. This action deletes the user's profile, memberships, and all related data across all organizations. This operation cannot be undone, so use with caution.
delete/api/v1/users/{id}
Request
- Base URLhttps://$SCALEKIT_ENVIRONMENT_URL
- AuthOAuth 2Client credentialsToken URLhttps://$SCALEKIT_ENVIRONMENT_URL/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
System-generated user ID. Must start with 'usr_' (19-25 characters)
Response
User successfully deleted. No content returned
unknown required
Changes
- warning
deleted the
queryrequest parameterexternal_id
- warning