Skip to main content

CRM User API

The CRM User API provides functionality for managing users of the CRM system. This module is restricted to users with the OWNER role and provides operations for creating, updating, retrieving, and deleting CRM users.

Authentication​

Authentication is automatically managed through HTTP cookies, with the system handling both the accessToken and the refreshToken.

Authorization​

All operations in the CRM User API are restricted to users with the OWNER role. This is enforced through the @Roles(CrmUserRole.OWNER) decorator and AppGuard.

Available Operations​

Queries​

  • crmUser: Retrieve a specific CRM user by ID
  • crmUsers: Retrieve a paginated list of CRM users with filtering and sorting options

Mutations​

  • createUpdateCrmUser: Create a new CRM user or update an existing one
  • unlockCrmUser: Unlock a CRM user who has been locked due to failed login attempts
  • deleteCrmUsers: Delete one or more CRM users by their IDs

Security Considerations​

  • All API endpoints are protected and require authentication
  • Operations are restricted to users with the OWNER role
  • Users cannot unlock themselves (security measure)
  • The API implements appropriate error handling for all operations

API Usage​

Please refer to the operations documentation for detailed information on how to use each API endpoint, including request parameters, response formats, and examples.