Skip to main content

deleteUser Mutation

Removes the specified User object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_users] when the specified object is not the signed-in User and a value for 'customer' does not exist on the object. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_users] when the specified object is not the signed-in User and a value for 'customer' exists on the object. 3. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers] when the specified object is not the signed-in User and a value for 'customer' exists on the object.

Input fields (DeleteUserInput!)

ArgumentTypeDescription
idIDThe ID of the User to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (DeleteUserPayload)

clientMutationId (String)
errors ([ErrorType!]!)
user (User)