REST API Reference

Back Next

Connection details

Create or update a Snowflake Data Cloud connection with client credentials authentication using the connection resource.

The following table describes the connection properties for client credentials authentication:

Property	Description
id	Connection ID. This property is required only when you update the connection. To get the connection ID, send the following GET request: GET <serverURL>/api/v2/connection/name/<connection name>
orgId	Organization ID.
name	Name of the connection.
description	Description of the connection.
type	Type of connection. Set to TOOLKIT_CCI .
agentId	ID of the Secure Agent used to access the Snowflake account.
agentGroupId	ID of the Secure Agent group.
authentication	Authentication type. Set to ClientCredentials .
account	Snowflake account name.
warehouse	Snowflake warehouse name.
accessTokenURL	URL of the OAuth authorization server endpoint that provides the access token.
clientID	Client ID from the OAuth provider application.
clientSecret	Client secret from the OAuth provider application.
clientAuthentication	Method used to authenticate the client.
scope	Scope that defines the access privileges. To specify multiple scopes, separate them with a space.
accessToken	OAuth access token used to authenticate with Snowflake.
tokenType	Type of token.
accessTokenExpireIn	Duration in seconds after which the access token expires.
accessTokenUpdatedTime	Timestamp in milliseconds when the access token was last updated.
oAuthRefreshUrl	URL used to refresh the OAuth access token.
oAuthRefreshKey	Refresh key used to get a new access token.
oAuthRefreshText	Refresh token text used to get a new access token.