{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/User",
"title": "User",
"description": "Properties of user.",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "User name",
"example": "jackpatel"
},
"password": {
"type": "string",
"format": "password",
"description": "Password",
"example": "example_value"
},
"login_name": {
"type": "string",
"description": "Login name",
"example": "example_value"
},
"display_name": {
"type": "string",
"description": "Display name",
"example": "example_value"
},
"first_name": {
"type": "string",
"description": "First name",
"example": "example_value"
},
"middle_name": {
"type": "string",
"description": "Middle name",
"example": "example_value"
},
"last_name": {
"type": "string",
"description": "Last name",
"example": "example_value"
},
"email": {
"type": "string",
"description": "Email address",
"example": "user@example.com"
},
"must_change_password": {
"type": "boolean",
"description": "Does this user need to change their password (e.g., after assigning a temp password)",
"example": true
},
"disabled": {
"type": "boolean",
"description": "Has this user been disabled from the system",
"example": true
},
"days_to_expiry": {
"type": "integer",
"description": "How many days until this user expires",
"example": 10
},
"mins_to_unlock": {
"type": "integer",
"description": "How many minutes until the account is unlocked after multiple failed logins",
"example": 10
},
"default_warehouse": {
"type": "string",
"description": "The default warehouse to use when this user starts a session",
"example": "example_value"
},
"default_namespace": {
"type": "string",
"description": "The default namespace to use when this user starts a session",
"example": "example_value"
},
"default_role": {
"type": "string",
"description": "The default role to use when this user starts a session",
"example": "example_value"
},
"default_secondary_roles": {
"type": "string",
"description": "The default secondary roles of this user to use when starting a session. Only valid set values are ALL or NONE. Default is ALL after 2024-07 BCR.",
"enum": [
"ALL",
"NONE"
],
"default": "ALL",
"example": "ALL"
},
"mins_to_bypass_mfa": {
"type": "integer",
"description": "How many minutes until MFA is required again",
"example": 10
},
"rsa_public_key": {
"type": "string",
"description": "RSA public key of the user",
"example": "example_value"
},
"rsa_public_key_2": {
"type": "string",
"description": "Second RSA public key of the user",
"example": "example_value"
},
"comment": {
"type": "string",
"description": "Comment about the user.",
"example": "A distinguished user"
},
"type": {
"type": "string",
"description": "Indicates the type of user (PERSON | SERVICE | LEGACY_SERVICE)",
"example": "example_value"
},
"enable_unredacted_query_syntax_error": {
"type": "boolean",
"description": "Whether to show unredacted query syntax errors in the query history.",
"example": true
},
"network_policy": {
"type": "string",
"description": "Specifies an existing network policy is active for the user. Otherwise, use account default.",
"example": "example_value"
},
"created_on": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"last_successful_login": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"expires_at": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"locked_until": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"has_password": {
"type": "boolean",
"readOnly": true,
"example": true
},
"has_rsa_public_key": {
"type": "boolean",
"readOnly": true,
"example": true
},
"rsa_public_key_fp": {
"type": "string",
"readOnly": true,
"description": "Fingerprint of the user's RSA public key",
"example": "example_value"
},
"rsa_public_key_2_fp": {
"type": "string",
"readOnly": true,
"description": "Fingerprint of the user's second RSA public key",
"example": "example_value"
},
"ext_authn_duo": {
"type": "boolean",
"readOnly": true,
"example": true
},
"ext_authn_uid": {
"type": "string",
"readOnly": true,
"example": "500123"
},
"owner": {
"type": "string",
"readOnly": true,
"example": "example_value"
},
"snowflake_lock": {
"type": "boolean",
"readOnly": true,
"default": false,
"description": "Whether the user, account, or organization is locked by Snowflake.",
"example": true
},
"snowflake_support": {
"type": "boolean",
"readOnly": true,
"default": false,
"description": "Whether Snowflake Support is allowed to use the user or account",
"example": true
},
"mins_to_bypass_network_policy": {
"type": "integer",
"readOnly": true,
"description": "Temporary bypass network policy on the user for a specified number of minutes",
"example": 10
},
"password_last_set": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2026-01-15T10:30:00Z"
},
"custom_landing_page_url": {
"type": "string",
"readOnly": true,
"example": "https://www.example.com"
},
"custom_landing_page_url_flush_next_ui_load": {
"type": "boolean",
"readOnly": true,
"default": false,
"description": "Whether or not to flush the custom landing page of the user on next UI load",
"example": "https://www.example.com"
}
}
}