DESCRIBE SESSION POLICY¶

Describes the details about a session policy.

DESCRIBE can be abbreviated to DESC.

See also:

Session Policy DDL Reference

Syntax¶

{ DESCRIBE | DESC } SESSION POLICY <name>
Copy

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.

Access control requirements¶

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

Privilege

Object

Notes

APPLY SESSION POLICY

Account

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 Overview of Access Control.

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

Usage notes¶

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Output¶

The output of the command includes the following columns, which describe the properties and metadata of the object:

Column

Description

created_on

The timestamp when the session policy was created.

name

Identifier for the session policy.

session_idle_timeout_mins

For Snowflake Clients and programmatic clients, the number of minutes in which a session can be idle before users must authenticate to Snowflake again.

session_ui_idle_timeout_mins

For Snowsight, the number of minutes in which a session can be idle before users must authenticate to Snowflake again.

allowed_secondary_roles

The secondary roles for a session policy, if any.

comment

Comment for the session policy.

Example¶

DESC SESSION POLICY session_policy_prod_1;
Copy
+---------------------------------+-----------------------+---------------------------+------------------------------+-------------------------+--------------------------------------------------+
| created_on                       | name                 | session_idle_timeout_mins | session_ui_idle_timeout_mins | allowed_secondary_roles |  comment                                         |
+---------------------------------+-----------------------+---------------------------+------------------------------+-------------------------+--------------------------------------------------+
| Mon, 11 Jan 2021 00:00:00 -0700 | session_policy_prod_1 | 60                        | 30                           |           []            | session policy for use in the prod_1 environment |
+---------------------------------+-----------------------+---------------------------+------------------------------+-------------------------+--------------------------------------------------+
Language: English