User

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "description": "The user object contains information about an individual user who can use the Konnect application and API.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The User ID.",
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "readOnly": true
    },
    "email": {
      "description": "The email registered to the user.",
      "type": "string",
      "format": "email",
      "example": "[email protected]",
      "maxLength": 250
    },
    "full_name": {
      "description": "The User's full name.",
      "type": "string",
      "example": "Jane Doe",
      "maxLength": 250,
      "pattern": "^[\\w \\W]+$"
    },
    "preferred_name": {
      "description": "The User's preferred name.",
      "type": "string",
      "example": "Jane",
      "maxLength": 250
    },
    "active": {
      "description": "Returns True if a user has verified their email address.",
      "type": "boolean",
      "default": true,
      "readOnly": true
    },
    "inferred_region": {
      "description": "The Konnect region closest to the user's IP address. This property might only be set for users on signup through Konnect\u2019s build-in native authentication.",
      "type": "string",
      "example": "us",
      "readOnly": true
    },
    "created_at": {
      "description": "The time stamp for the date the account was registered.",
      "type": "string",
      "format": "date-time",
      "example": "2022-02-07T17:46:57.52Z",
      "readOnly": true
    },
    "updated_at": {
      "description": "A Unix timestamp representation of the most recent change to the User account.",
      "type": "string",
      "format": "date-time",
      "example": "2022-10-08T17:00:00.52Z",
      "readOnly": true
    }
  },
  "example": {
    "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "email": "[email protected]",
    "full_name": "Test User",
    "preferred_name": "test",
    "active": true,
    "inferred_region": "us",
    "created_at": "2022-02-07T17:46:57.52Z",
    "updated_at": "2022-10-08T17:00:00.52Z"
  }
}