admin_user.invite

Invite a new operator by email (status invited). First OTP/OIDC login activates them. locale starts them in a language (‘en’ | ‘pt-BR’ | ‘es’); omitted, they inherit the instance default and can change it themselves. admin_login_url is the admin login screen the invitation mail links to, and is used for that mail only; a loopback address is dropped and the mail goes out without the link.

• Scope: admin.users.write
• System: no
• Reachable from: POST /v1/commands/admin_user.invite — the tenant data face, with a tenant credential carrying admin.users.write · MCP tool admin_user.invite · SDK client.call('admin_user.invite', …)
• Events: admin_user.invited

Input (JSON Schema)

{
  "properties": {
    "admin_login_url": {
      "format": "uri",
      "maxLength": 2000,
      "type": "string"
    },
    "email": {
      "format": "email",
      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "type": "string"
    },
    "locale": {
      "maxLength": 10,
      "minLength": 2,
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "role": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "admin_user_id": {
      "type": "string"
    }
  },
  "required": [
    "admin_user_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)