Domains / Customer Management/ API Endpoint

User Management API

REST API for user lifecycle management including invitations, role assignments, and access revocation.

API Endpoint Application active

User Management API provides endpoints for managing users within a tenant workspace. It supports invitation workflows, role/permission assignment, user suspension, and bulk operations.

Endpoints

  • POST /api/v1/users/invite — Send user invitation
  • GET /api/v1/users — List users in tenant
  • PATCH /api/v1/users/{id}/role — Update user role
  • DELETE /api/v1/users/{id} — Revoke user access
  • POST /api/v1/users/bulk-import — Bulk import users from CSV

Relationships

◇ Composes outgoing 1
Target Element Element Type
User Auth Service Software Subsystem
◇ Part of incoming 1
Source Element Element Type
User Auth Service Software Subsystem
→ Served by incoming 5
Source Element Element Type
Bulk Import Completed Domain Event
Permission Policy Changed Domain Event
User Deactivated Domain Event
User Invited Domain Event
User Role Changed Domain Event

Architecture Context

Diagrams

Properties

Type API Endpoint
Layer Application
Domain Customer Management
Status active
Owner Platform Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface
Togaf Type Information System Service

Meta Model

Business
Organization
Application current
Technology

Actions