CreateUserInvitationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coactive/main/json-schema/coactive-create-user-invitation-request-schema.json",
  "title": "CreateUserInvitationRequest",
  "description": "Request model for creating a new user invitation.\n\nThis model is used to invite a new user to join an organization. The invitation\nwill be sent to the specified email address and will include the roles that will\nbe assigned to the user upon acceptance.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/coactive-user-management-api-openapi.yml#/components/schemas/CreateUserInvitationRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the invited user"
    },
    "email": {
      "type": "string",
      "description": "Email address to send the invitation to"
    },
    "roles": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Role"
      },
      "description": "List of roles to assign to the user"
    }
  },
  "required": [
    "name",
    "email"
  ],
  "$defs": {
    "Role": {
      "type": "object",
      "properties": {
        "role_id": {
          "type": "string",
          "description": "Name of the role (e.g., 'admin', 'editor', 'viewer')"
        },
        "resource": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional resource type the role applies to (e.g., 'dataset')"
        },
        "resource_instance": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional resource instance ID the role applies to"
        }
      },
      "required": [
        "role_id"
      ],
      "description": "Role model for user and client roles",
      "title": "Role"
    }
  }
}