System and identity

System namespaces cover tenants, users, roles, permissions, organisation structure, teams, groups, webhooks, activity logs, launchpad apps, and identity flows.

Key namespaces and models

system.Tenant
system.TenantDomain
system.TenantApp
system.Organisation
system.Department
system.Unit
system.Position
system.Team
system.User
system.Contact
system.Group
system.GroupMembership
system.Role
system.Permission
system.UserInvitation
system.LoginWhitelist
system.Webhook
system.WebhookListener
system.WebhookListenerEvent
system.ActivityLog
settings.Currency
settings.Holiday
settings.LocationCluster
settings.Location
settings.Preference
settings.UserMenu

Common controller intents

system.User.authenticate
system.User.verifyAuthentication
system.User.refreshToken
system.User.discoverTenants
system.User.switchTenant
system.Registration.createSuperAdminAccount
system.Registration.registerCustomer
system.Tenant.retrieveTenantDetails
system.Tenant.getLaunchpad
system.Team.addTeamMember
system.Webhook.subscribeToWebhook

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json

{
  "__meta__": {
    "schema": "model",
    "namespace": "system.User",
    "intent": "retrieve",
    "authenticationClass": "jwt",
    "ordering": "-created",
    "limit": 20
  },
  "id": null,
  "created": null
}

Create example

json

{
  "__meta__": {
    "schema": "model",
    "namespace": "system.Team",
    "intent": "create",
    "authenticationClass": "jwt",
    "return": {
      "id": null,
      "name": null,
      "alias": null
    }
  },
  "name": "Customer success",
  "alias": "customer-success"
}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.

Authentication example

json

{
  "__meta__": {
    "schema": "controller",
    "namespace": "system.User",
    "intent": "authenticate",
    "authenticationClass": "jwt"
  },
  "email": "admin@example.com",
  "password": "correct-horse-battery-staple",
  "return": {
    "id": null,
    "email": null,
    "firstName": null,
    "lastName": null
  }
}

Key namespaces and models

Common controller intents

Common model intents

Retrieve example

Create example

Related guides and modules

Authentication example