DESCRIBE INTEGRATION¶

Describes the properties of an integration.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE INTEGRATION , DROP INTEGRATION , ALTER INTEGRATION , SHOW INTEGRATIONS

API integrations:

ALTER API INTEGRATION , CREATE API INTEGRATION

Catalog integrations:

CREATE CATALOG INTEGRATION

External access integrations:

ALTER EXTERNAL ACCESS INTEGRATION , CREATE EXTERNAL ACCESS INTEGRATION

Notification integrations:

ALTER NOTIFICATION INTEGRATION , CREATE NOTIFICATION INTEGRATION

Security integrations:

ALTER SECURITY INTEGRATION , CREATE SECURITY INTEGRATION

Storage integrations:

ALTER STORAGE INTEGRATION , CREATE STORAGE INTEGRATION

Syntax¶

DESC[RIBE] [ { API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATION <name>
Copy

Parameters¶

name

Specifies the identifier for the integration 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.

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.

  • If the integration is an API integration, then the output includes the API_KEY column. The API_KEY displays a masked value if an API key was entered. (This does not display either the original unencrypted key or the encrypted version of the key.)

  • If the security integration has the TYPE property set to OAUTH (i.e. Snowflake OAuth), Snowflake returns two additional security integration properties in the query result that cannot be set with either a CREATE SECURITY INTEGRATION or an ALTER SECURITY INTEGRATION command:

    OAUTH_ALLOWED_AUTHORIZATION_ENDPOINTS

    A list of all supported endpoints for a client application to receive an authorization code from Snowflake.

    OAUTH_ALLOWED_TOKEN_ENDPOINTS

    A list of all supported endpoints for a client application to exchange an authorization code for an access token or to obtain a refresh token.

Examples¶

Create a notification integration:

CREATE NOTIFICATION INTEGRATION myint ( ... );
Copy

Describe the columns in the integration:

DESC INTEGRATION myint;
Copy
Language: English