Group Management

These API endpoints allow tenants to manage user groups in the FinCore™ platform, enabling efficient organization and permission management for both individual (B2C) and business (B2B) customers.

Use Cases

  • Creating and managing user groups
  • Assigning users to groups
  • Managing group-based permissions
  • Organizational structure management
  • Role-based access control implementation

Integration Notes

Group management is an important component of the FinCore™ platform’s access control system. The group management system supports:

  • Hierarchical group structures
  • Group-based permission inheritance
  • Dynamic group membership
  • Cross-organizational groups
  • Audit logging of group changes

For Enterprise subscription tier tenants, additional group management features are available to support complex organizational structures and enhanced security requirements.

Key Endpoints

Get All Groups

GET /v2/group

Retrieves all available groups.

Create Group

POST /v2/group

Creates a new user group.

Update Group

PUT /v2/group/{groupId}

Updates an existing user group.

Get Users by Group

GET /v2/group/users

Retrieves all users belonging to a specific group.

Response Codes

CodeDescription
200Operation successful
400Invalid request parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient permissions
404Group not found
500Internal Server Error