Users
Delete user by external ID
Changed onPermanently removes a user identified by your application's external identifier. This action deletes the user's profile, memberships, and all related data across all organizations. This operation cannot be undone.
delete/api/v1/users:external/{external_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
external_idstring required
External system identifier from connected directories. Must match existing records
Response
User successfully deleted. No content returned
unknown required
Changes
- info
endpoint added
- info