v1
latestOpenAPI 3.0.32026-08-061874701.5 MBRemove user from organization
Removes the user from your organization.
Who can use this operation?
Permissions: System Admin
Important: To remove a user from your plan, refer to Remove user from plan.
If you have <a href="https://help.smartsheet.com/articles/2482433-Enterprise-plan-manager-overview" target="_blank" rel="noopener noreferrer">Enterprise Plan Manager</a> enabled, this endpoint removes the user from organizations that inherit from your organization.
If you're managing users via an external source, such as an identity provider (IdP) or directory integration (DI) provider, you must use that source to remove users. Okta and Azure AD are examples of external sources.
Query parameters
Set this to true to remove the user's access to all assets in your organization and plan.
If you want to transfer ownership of all the removed user's assets and groups to a qualified user*, set this parameter to true and set the transferTo parameter to the ID of the qualified user. The transfer depends on setting the transferTo parameter.
Warning: If your asset transfer size exceeds 38k, the transfer fails with a 400 error that prompts you to contact Support for guidance.
* The receiving user must be a <a href="https://help.smartsheet.com/articles/520100-user-types" target="_blank" rel="noopener noreferrer">Group Admin</a> of the group(s) to be transferred.
Set this to the ID of a qualified user* to receive ownership of all groups the removed user owns.
Also if you set the transferSheets parameter to true, the operation additionally transfers ownership of all the removed user's assets to the assigned user.
* The receiving user must be a <a href="https://help.smartsheet.com/articles/520100-user-types" target="_blank" rel="noopener noreferrer">Group Admin</a> of the groups.
Response
Returns the result object.
Example response
{
"message": "SUCCESS"
}