Users.delete (Method)
Deletes a user. If the deleted user owns content, a different contributor must be specified to inherit ownership.
Returns:
Boolean
Arguments:
Name | Type | Required | Description |
---|---|---|---|
userID | UserID_NonValidated | Required | The user ID of the user being marked as deleted. |
replacementID | ContributorUserID_0 | Required | The user ID of user that will become the owner of the objects previously owned by the deleted user. |
Context:
License Requirements | None |
Permission Requirements | User:Admin |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the customer level, calls to this method will be logged |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
66018 | The replacement cannot be the user or group being deleted. |
66019 | |
66039 | The replacement user must be a contributor. |
Notes:
None