Skip to main content
DELETE
Remove User

Overview

Removes a user from your account, revoking their access and removing them from the shared user list. This action cannot be undone.

Purpose

User Removal

  • Revoke Access: Remove user access to your account
  • Clean Up: Remove inactive or unnecessary users
  • Security: Remove users who no longer need access
  • Account Management: Maintain clean user lists

Access Control

  • Immediate Effect: Access is revoked immediately
  • Complete Removal: User is removed from all account access
  • Security Measure: Prevent unauthorized access
  • Account Cleanup: Remove users who have left the organization

Path Parameters

ParameterTypeRequiredDescriptionExample
shared-user-idintegerYesID of the shared user to remove479

Response

Success Response (204 No Content)

The request succeeds and returns no content, indicating the user has been successfully removed.

Error Responses

User Not Found (404)

Unauthorized (401)

Examples

Remove User

Response (Success)

Important Considerations

Before Removing a User

  • Verify User ID: Ensure you have the correct user ID
  • Check User Activity: Review user’s recent activity
  • Backup Data: Ensure any important data is backed up
  • Communicate: Inform the user if appropriate

After Removing a User

  • Access Revoked: User loses all access immediately
  • No Recovery: User cannot be restored automatically
  • Re-invitation: User must be re-invited to regain access
  • Data Impact: User’s QR codes remain in the account

Integration Examples

JavaScript - User Removal with Confirmation

Python - User Removal with Logging

PHP - User Removal with Confirmation

Use Cases

User Management

  • Remove Inactive Users: Clean up users who no longer need access
  • Security Cleanup: Remove users who have left the organization
  • Access Control: Revoke access for security reasons
  • Account Maintenance: Keep user lists clean and current

Administrative Tasks

  • User Lifecycle: Handle user departure from organization
  • Access Auditing: Remove users during access audits
  • Security Incidents: Remove users during security incidents
  • Account Cleanup: Regular cleanup of user accounts

API Integration

  • Automated Cleanup: Automatically remove inactive users
  • User Synchronization: Sync user removal with external systems
  • Access Management: Integrate with access management systems
  • User Lifecycle: Handle user lifecycle events

Best Practices

Before Removal

  • Verify Identity: Ensure you’re removing the correct user
  • Check Dependencies: Verify no critical dependencies exist
  • Communicate: Inform the user if appropriate
  • Document: Keep records of user removals

After Removal

  • Verify Removal: Confirm user has been removed
  • Update Systems: Update any external systems
  • Monitor Access: Monitor for any access attempts
  • Document: Record the removal for audit purposes

Security Considerations

  • Immediate Effect: Access is revoked immediately
  • No Recovery: User cannot be restored automatically
  • Re-invitation: User must be re-invited to regain access
  • Audit Trail: Keep records of all removals
Removing a user is a permanent action that cannot be undone. The user will lose all access to your account immediately and must be re-invited to regain access.
Be very careful when removing users, especially Admin users, as this action cannot be undone. Make sure you have the correct user ID and that the removal is necessary.
The user’s QR codes and other data will remain in your account after removal. Only the user’s access is revoked.

Authorizations

Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Path Parameters

shared-user-id
integer
required

ID of the shared user to remove

Response

User removed successfully