Describes the properties of an integration.
DESCRIBE can be abbreviated to DESC.
CREATE INTEGRATION , DROP INTEGRATION , ALTER INTEGRATION , SHOW INTEGRATIONS
ALTER EXTERNAL ACCESS INTEGRATION , CREATE EXTERNAL ACCESS INTEGRATION
ALTER NOTIFICATION INTEGRATION , CREATE NOTIFICATION INTEGRATION
{ DESC | DESCRIBE } [ { API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATION <name>
Copy
Parameters¶{ API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE }
Describes an integration of the specified type.
For more information about some of these types, see the following topics:
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.
For more information, see Identifier requirements.
To post-process the output of this command, you can use the pipe operator (->>
) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.
The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type
, then specify "type"
for the identifier.
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.
Describe the properties of an integration named my_int
:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4