Snowflake · Schema

User

Properties of user.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
name string User name
password string Password
login_name string Login name
display_name string Display name
first_name string First name
middle_name string Middle name
last_name string Last name
email string Email address
must_change_password boolean Does this user need to change their password (e.g., after assigning a temp password)
disabled boolean Has this user been disabled from the system
days_to_expiry integer How many days until this user expires
mins_to_unlock integer How many minutes until the account is unlocked after multiple failed logins
default_warehouse string The default warehouse to use when this user starts a session
default_namespace string The default namespace to use when this user starts a session
default_role string The default role to use when this user starts a session
default_secondary_roles string 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.
mins_to_bypass_mfa integer How many minutes until MFA is required again
rsa_public_key string RSA public key of the user
rsa_public_key_2 string Second RSA public key of the user
comment string Comment about the user.
type string Indicates the type of user (PERSON | SERVICE | LEGACY_SERVICE)
enable_unredacted_query_syntax_error boolean Whether to show unredacted query syntax errors in the query history.
network_policy string Specifies an existing network policy is active for the user. Otherwise, use account default.
created_on string
last_successful_login string
expires_at string
locked_until string
has_password boolean
has_rsa_public_key boolean
rsa_public_key_fp string Fingerprint of the user's RSA public key
rsa_public_key_2_fp string Fingerprint of the user's second RSA public key
ext_authn_duo boolean
ext_authn_uid string
owner string
snowflake_lock boolean Whether the user, account, or organization is locked by Snowflake.
snowflake_support boolean Whether Snowflake Support is allowed to use the user or account
mins_to_bypass_network_policy integer Temporary bypass network policy on the user for a specified number of minutes
password_last_set string
custom_landing_page_url string
custom_landing_page_url_flush_next_ui_load boolean Whether or not to flush the custom landing page of the user on next UI load
View JSON Schema on GitHub

JSON Schema

user-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "User",
  "type": "object",
  "description": "Properties of user.",
  "properties": {
    "name": {
      "type": "string",
      "description": "User name"
    },
    "password": {
      "type": "string",
      "description": "Password"
    },
    "login_name": {
      "type": "string",
      "description": "Login name"
    },
    "display_name": {
      "type": "string",
      "description": "Display name"
    },
    "first_name": {
      "type": "string",
      "description": "First name"
    },
    "middle_name": {
      "type": "string",
      "description": "Middle name"
    },
    "last_name": {
      "type": "string",
      "description": "Last name"
    },
    "email": {
      "type": "string",
      "description": "Email address"
    },
    "must_change_password": {
      "type": "boolean",
      "description": "Does this user need to change their password (e.g., after assigning a temp password)"
    },
    "disabled": {
      "type": "boolean",
      "description": "Has this user been disabled from the system"
    },
    "days_to_expiry": {
      "type": "integer",
      "description": "How many days until this user expires"
    },
    "mins_to_unlock": {
      "type": "integer",
      "description": "How many minutes until the account is unlocked after multiple failed logins"
    },
    "default_warehouse": {
      "type": "string",
      "description": "The default warehouse to use when this user starts a session"
    },
    "default_namespace": {
      "type": "string",
      "description": "The default namespace to use when this user starts a session"
    },
    "default_role": {
      "type": "string",
      "description": "The default role to use when this user starts a session"
    },
    "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."
    },
    "mins_to_bypass_mfa": {
      "type": "integer",
      "description": "How many minutes until MFA is required again"
    },
    "rsa_public_key": {
      "type": "string",
      "description": "RSA public key of the user"
    },
    "rsa_public_key_2": {
      "type": "string",
      "description": "Second RSA public key of the user"
    },
    "comment": {
      "type": "string",
      "description": "Comment about the user."
    },
    "type": {
      "type": "string",
      "description": "Indicates the type of user (PERSON | SERVICE | LEGACY_SERVICE)"
    },
    "enable_unredacted_query_syntax_error": {
      "type": "boolean",
      "description": "Whether to show unredacted query syntax errors in the query history."
    },
    "network_policy": {
      "type": "string",
      "description": "Specifies an existing network policy is active for the user. Otherwise, use account default."
    },
    "created_on": {
      "type": "string"
    },
    "last_successful_login": {
      "type": "string"
    },
    "expires_at": {
      "type": "string"
    },
    "locked_until": {
      "type": "string"
    },
    "has_password": {
      "type": "boolean"
    },
    "has_rsa_public_key": {
      "type": "boolean"
    },
    "rsa_public_key_fp": {
      "type": "string",
      "description": "Fingerprint of the user's RSA public key"
    },
    "rsa_public_key_2_fp": {
      "type": "string",
      "description": "Fingerprint of the user's second RSA public key"
    },
    "ext_authn_duo": {
      "type": "boolean"
    },
    "ext_authn_uid": {
      "type": "string"
    },
    "owner": {
      "type": "string"
    },
    "snowflake_lock": {
      "type": "boolean",
      "description": "Whether the user, account, or organization is locked by Snowflake."
    },
    "snowflake_support": {
      "type": "boolean",
      "description": "Whether Snowflake Support is allowed to use the user or account"
    },
    "mins_to_bypass_network_policy": {
      "type": "integer",
      "description": "Temporary bypass network policy on the user for a specified number of minutes"
    },
    "password_last_set": {
      "type": "string"
    },
    "custom_landing_page_url": {
      "type": "string"
    },
    "custom_landing_page_url_flush_next_ui_load": {
      "type": "boolean",
      "description": "Whether or not to flush the custom landing page of the user on next UI load"
    }
  }
}