DESCRIBE SECRET

Describes the properties of a secret.

DESCRIBE can be abbreviated to DESC.

See also:

ALTER SECRET , CREATE SECRET , DROP SECRET , SHOW SECRETS

Syntax

DESC[RIBE] SECRET <name>
Copy

Parameters

name

Specifies the identifier for the secret to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

Access Control Requirements

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

Privilege

Object

Notes

USAGE

Secret

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.

Usage Notes

  • Snowflake returns the following secret property values as columns in the query result: COMMENT, SECRET_TYPE, USERNAME.

  • Snowflake never returns the PASSWORD property value.

  • 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.

Examples

Describe the secret:

DESC SECRET service_now_creds_pw;
Copy