Skip to main content

Identity Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 57


Api Keys

List API keys

GET/api-keysBearer token
userIdstring

query parameter


Create a new API key

POST/api-keysBearer token

Request Body: CreateApiKeyDto

namestringRequired

—

userIdstringRequired

—


Delete an API key

DELETE/api-keys/:idBearer token
idstringRequired

path parameter


Audit Logs

List audit logs with filters

GET/audit-logsBearer token
queryQueryAuditLogsDtoRequired

query parameter


Create audit log entry (service-to-service only)

POST/audit-logsBearer token

Request Body: CreateAuditLogDto

actorIdstringRequired

—

actorType'user' | 'service' | 'system' | 'api_key'Required

—

actionstringRequired

—

resourcestringRequired

—

resourceIdstring

—

tenantIdstring

—

correlationIdstring

—

previousStateRecordstring, unknown

—

newStateRecordstring, unknown

—

metadataRecordstring, unknown

—

descriptionstring

—


Auth

Register a new user

POST/auth/register

Request Body: RegisterDto

emailstringRequired

—

passwordstringRequired

—

firstNamestringRequired

—

lastNamestringRequired

—

companyNamestring

—

countrystring

—

inviteTokenstring

—


Login with email and password

POST/auth/login

Request Body: LoginDto

emailstringRequired

—

passwordstringRequired

—

mfaCodestring

—


Refresh access token

POST/auth/refresh

Request Body: RefreshTokenDto

refreshTokenstringRequired

—


Logout current user

POST/auth/logoutBearer token

Initiate Google OAuth login

GET/auth/oauth/google

GET /auth/oauth/google/callback

GET/auth/oauth/google/callback

Initiate GitHub OAuth login

GET/auth/oauth/github

GET /auth/oauth/github/callback

GET/auth/oauth/github/callback

Initiate Microsoft OAuth login

GET/auth/oauth/microsoft

GET /auth/oauth/microsoft/callback

GET/auth/oauth/microsoft/callback

Service Auth

Issue a service-to-service JWT token

POST/v1/auth/service-token

Request Body: ServiceTokenDto

serviceNamestringRequired

—

serviceSecretstringRequired

—


Gdpr

Export all personal data (GDPR Art. 20 — Data Portability)

GET/users/me/exportBearer token

Request data erasure (GDPR Art. 17 — Right to be Forgotten)

DELETE/users/me/eraseBearer token

GET/users/me/consentBearer token

GET/users/me/consent/historyBearer token

POST/users/me/consentBearer token

Request Body: RecordConsentDto

consentType'marketing' | 'analytics' | 'essential' | 'third_party'Required

—

grantedbooleanRequired

—


Health

Liveness probe

GET/health

Readiness probe

GET/ready

Partner API

Create an OAuth2 client for partner API access

POST/api/partner/clients

Request Body: CreateOAuthClientDto

namestringRequired

—

scopesstring[]Required

—

rateLimitPerMinutenumber

—

allowedIpsstring[]

—


List all OAuth2 clients for this tenant

GET/api/partner/clients

Revoke an OAuth2 client (deactivate without deleting)

POST/api/partner/clients/:id/revoke
idstringRequired

path parameter


Permanently delete an OAuth2 client

DELETE/api/partner/clients/:id
idstringRequired

path parameter


OAuth2 Client Credentials Grant — issue access token

POST/api/partner/oauth/token

Request Body: OAuthTokenRequestDto

grant_typestringRequired

—

client_idstringRequired

—

client_secretstringRequired

—

scopestring

—


Roles

List all role definitions

GET/rolesBearer token

Get a role by ID

GET/roles/:idBearer token
idstringRequired

path parameter


Create a new role definition

POST/rolesBearer token

Request Body: CreateRoleDto

namestringRequired

—

displayNamestringRequired

—

descriptionstring

—

categoryRoleCategory

—

permissionsstring[]

—


Update a role definition

PUT/roles/:idBearer token
idstringRequired

path parameter

Request Body: UpdateRoleDto

displayNamestring

—

descriptionstring

—

permissionsstring[]

—

isActiveboolean

—


Delete a role definition (non-system only)

DELETE/roles/:idBearer token
idstringRequired

path parameter


Get roles for a user (with full details)

GET/roles/users/:userIdBearer token
userIdstringRequired

path parameter


Assign roles to a user

POST/roles/users/:userId/assignBearer token
userIdstringRequired

path parameter

Request Body: AssignRolesDto

rolesstring[]Required

—


Remove roles from a user

POST/roles/users/:userId/removeBearer token
userIdstringRequired

path parameter

Request Body: RemoveRolesDto

rolesstring[]Required

—


Tenants

Create a new tenant

POST/tenantsBearer token

Request Body: CreateTenantDto

namestringRequired

—

type'customer' | 'partner' | 'internal'Required

—

countrystringRequired

—

configRecordstring, any

—


List all tenants

GET/tenantsBearer token
typestring

query parameter


Get a tenant by name

GET/tenants/by-name/:nameBearer token
namestringRequired

path parameter


Get a tenant by ID

GET/tenants/:idBearer token
idstringRequired

path parameter


Update a tenant

PATCH/tenants/:idBearer token
idstringRequired

path parameter

Request Body: UpdateTenantDto

namestring

—

type'customer' | 'partner' | 'internal'

—

countrystring

—

configRecordstring, any

—


Delete a tenant

DELETE/tenants/:idBearer token
idstringRequired

path parameter


Get the number of users in a tenant

GET/tenants/:id/user-countBearer token
idstringRequired

path parameter


Get tenant settings

GET/tenants/:id/settingsBearer token
idstringRequired

path parameter


Update tenant settings (partial)

PATCH/tenants/:id/settingsBearer token
idstringRequired

path parameter

Request Body: UpdateSettingsDto

localestring

—

timezonestring

—

currencystring

—

dateFormatstring

—

maxUsersnumber

—

maxInstancesnumber

—

featuresTenantFeaturesDto

—

brandingTenantBrandingDto

—


Invite a user to this tenant

POST/tenants/:id/invitesBearer token
idstringRequired

path parameter

Request Body: CreateInviteDto

emailstringRequired

—

rolestring

—


List invites for a tenant

GET/tenants/:id/invitesBearer token
idstringRequired

path parameter


Revoke an invite

DELETE/tenants/:id/invites/:inviteIdBearer token
idstringRequired

path parameter

inviteIdstringRequired

path parameter


Validate an invite token (public)

GET/tenants/invites/validate/:tokenBearer token
tokenstringRequired

path parameter


Users

Get current user profile

GET/users/meBearer token

Update own profile (firstName, lastName)

PATCH/users/meBearer token

Request Body: UpdateProfileDto

firstNamestring

—

lastNamestring

—


Change own password

POST/users/me/change-passwordBearer token

Request Body: ChangePasswordDto

currentPasswordstringRequired

—

newPasswordstringRequired

—


List all users (admin, paginated)

GET/usersBearer token
queryQueryUsersDtoRequired

query parameter


Get a user by ID (admin)

GET/users/:idBearer token
idstringRequired

path parameter


Update a user (admin)

PUT/users/:idBearer token
idstringRequired

path parameter

Request Body: AdminUpdateUserDto

firstNamestring

—

lastNamestring

—

emailstring

—

statusUserStatus

—

rolesstring[]

—


Deactivate (suspend) a user

POST/users/:id/deactivateBearer token
idstringRequired

path parameter


Reactivate a user

POST/users/:id/reactivateBearer token
idstringRequired

path parameter