Categories:

User & Security DDL

ALTER SESSION POLICY

Modifies the properties for an existing session policy.

Any changes made to the session policy properties go into effect when the next SQL query that uses the session policy runs.

See also:

Session policy DDL and privileges

Syntax

ALTER SESSION POLICY [ IF EXISTS ] <name> [UN]SET [ SESSION_IDLE_TIMEOUT_MINS = <integer> ]
                                                  [ SESSION_UI_IDLE_TIMEOUT_MINS = <integer> ]
                                                  [ COMMENT = '{string_literal}' ]

ALTER SESSION POLICY [ IF EXISTS ] <name> RENAME TO <new_name>

Parameters

name

Identifier for the session policy; must be unique for your account.

The identifier value must start with an alphabetic character and cannot contain spaces or special characters unless the entire identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.

For more details, see Identifier Requirements.

SESSION_IDLE_TIMEOUT_MINS = <integer>

For Snowflake clients and programmatic clients, the number of minutes in which a session can be idle before users must authenticate to Snowflake again. The number of minutes can be any integer between 5 and 240, inclusive. If a value is not specified, Snowflake uses the default value.

Default: 240 (i.e. 4 hours).

SESSION_UI_IDLE_TIMEOUT_MINS = <integer>

For the Snowflake web interface, the number of minutes in which a session can be idle before users must authenticate to Snowflake again. The number of minutes can be any integer between 5 and 240, inclusive. If a value is not specified, Snowflake uses the default value.

Default: 240 (i.e. 4 hours).

COMMENT = 'string_literal'

Adds a comment or overwrites an existing comment for the session policy.

RENAME TO new_name

Specifies the new identifier for the session policy; must be unique for your account.

For more details, see Identifier Requirements.

Access Control Requirements

A role used to execute this SQL command must have the following privileges at a minimum:

Privilege

Object

Notes

OWNERSHIP

Session policy

OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

Note that operating on any object in a schema also requires the USAGE privilege on the parent database and schema.

For instructions on creating a custom role with a specified set of privileges, see Creating Custom Roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Access Control in Snowflake.

For additional details on session policy DDL and privileges, see Managing Session Policies.

Usage Notes

  • If you want to update an existing session policy and need to see the current definition of the policy, call the GET_DDL function or run the DESCRIBE SESSION POLICY command.

  • Before executing an ALTER statement, you can execute a DESCRIBE SESSION POLICY statement to determine the attribute values of the policy.

  • Moving a session policy to a managed access schema (using the ALTER SESSION POLICY … RENAME TO syntax) is prohibited unless the session policy owner (i.e. the role that has the OWNERSHIP privilege on the session policy) also owns the target schema. For more information, see Overview of Access Control Privileges.

Examples

The following example updates the session policy to have a web interface session timeout value of 60 minutes.

DESC SESSION POLICY session_policy_prod_1;

+---------------------------------+-----------------------+------------------------+--------------------------+--------------------------------------------------+
| createdOn                       | name                  | sessionIdleTimeoutMins | sessionUIIdleTimeoutMins | comment                                          |
+---------------------------------+-----------------------+------------------------+--------------------------+--------------------------------------------------+
| Mon, 11 Jan 2021 00:00:00 -0700 | session_policy_prod_1 | 60                     | 30                       | session policy for use in the prod_1 environment |
+---------------------------------+-----------------------+------------------------+--------------------------+--------------------------------------------------+

ALTER SESSION POLICY session_policy_prod_1 set session_ui_idle_timeout_mins = 60;
Back to top