Introduction to User Management

Rocket.Chat provides a set of APIs to programmatically manage users, permissions, roles, and LDAP integration. These APIs allow administrators to automate user management tasks, enforce access control, and integrate with external identity providers.

Users API

  • Create, update, and delete user accounts via API requests.

  • Manage user profiles programmatically, including names, emails, and avatars.

  • Configure user preferences such as language settings and notification options.

  • Generate and manage authentication tokens for API access and integrations.

Permissions API

  • Define and enforce granular access controls for Rocket.Chat features.

  • Assign or restrict permissions for actions like messaging, file uploads, and administrative tasks.

  • Customize permission sets through API calls to align with security policies.

Roles API

  • Assign predefined or custom roles (e.g., Administrator, Moderator, Guest) using API methods.

  • Control role-based access to features and settings.

  • Manage hierarchical roles to structure user permissions efficiently.

LDAP Integration API

  • Programmatically configure and sync user accounts with an LDAP server.

  • Perform test synchronizations to validate authentication and data consistency.

  • Automate user provisioning and access management through directory service settings.