Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ApiAuthenticationIntegrationWithAuthorizationCodeGrant
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/apiAuthenticationIntegrationWithAuthorizationCodeGrant:ApiAuthenticationIntegrationWithAuthorizationCodeGrant example '"<integration_name>"'
Copy

Create ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiAuthenticationIntegrationWithAuthorizationCodeGrant(name: string, args: ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs, opts?: CustomResourceOptions);
@overload
def ApiAuthenticationIntegrationWithAuthorizationCodeGrant(resource_name: str,
                                                           args: ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs,
                                                           opts: Optional[ResourceOptions] = None)

@overload
def ApiAuthenticationIntegrationWithAuthorizationCodeGrant(resource_name: str,
                                                           opts: Optional[ResourceOptions] = None,
                                                           enabled: Optional[bool] = None,
                                                           oauth_client_id: Optional[str] = None,
                                                           oauth_client_secret: Optional[str] = None,
                                                           comment: Optional[str] = None,
                                                           name: Optional[str] = None,
                                                           oauth_access_token_validity: Optional[int] = None,
                                                           oauth_allowed_scopes: Optional[Sequence[str]] = None,
                                                           oauth_authorization_endpoint: Optional[str] = None,
                                                           oauth_client_auth_method: Optional[str] = None,
                                                           oauth_refresh_token_validity: Optional[int] = None,
                                                           oauth_token_endpoint: Optional[str] = None)
func NewApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx *Context, name string, args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithAuthorizationCodeGrant, error)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(string name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args, CustomResourceOptions? opts = null)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(String name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(String name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args, CustomResourceOptions options)

type: snowflake:ApiAuthenticationIntegrationWithAuthorizationCodeGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new Snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", new()
{
    Enabled = false,
    OauthClientId = "string",
    OauthClientSecret = "string",
    Comment = "string",
    Name = "string",
    OauthAccessTokenValidity = 0,
    OauthAllowedScopes = new[]
    {
        "string",
    },
    OauthAuthorizationEndpoint = "string",
    OauthClientAuthMethod = "string",
    OauthRefreshTokenValidity = 0,
    OauthTokenEndpoint = "string",
});
Copy
example, err := snowflake.NewApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx, "apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", &snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs{
	Enabled:                  pulumi.Bool(false),
	OauthClientId:            pulumi.String("string"),
	OauthClientSecret:        pulumi.String("string"),
	Comment:                  pulumi.String("string"),
	Name:                     pulumi.String("string"),
	OauthAccessTokenValidity: pulumi.Int(0),
	OauthAllowedScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	OauthAuthorizationEndpoint: pulumi.String("string"),
	OauthClientAuthMethod:      pulumi.String("string"),
	OauthRefreshTokenValidity:  pulumi.Int(0),
	OauthTokenEndpoint:         pulumi.String("string"),
})
Copy
var apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs.builder()
    .enabled(false)
    .oauthClientId("string")
    .oauthClientSecret("string")
    .comment("string")
    .name("string")
    .oauthAccessTokenValidity(0)
    .oauthAllowedScopes("string")
    .oauthAuthorizationEndpoint("string")
    .oauthClientAuthMethod("string")
    .oauthRefreshTokenValidity(0)
    .oauthTokenEndpoint("string")
    .build());
Copy
api_authentication_integration_with_authorization_code_grant_resource = snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource",
    enabled=False,
    oauth_client_id="string",
    oauth_client_secret="string",
    comment="string",
    name="string",
    oauth_access_token_validity=0,
    oauth_allowed_scopes=["string"],
    oauth_authorization_endpoint="string",
    oauth_client_auth_method="string",
    oauth_refresh_token_validity=0,
    oauth_token_endpoint="string")
Copy
const apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", {
    enabled: false,
    oauthClientId: "string",
    oauthClientSecret: "string",
    comment: "string",
    name: "string",
    oauthAccessTokenValidity: 0,
    oauthAllowedScopes: ["string"],
    oauthAuthorizationEndpoint: "string",
    oauthClientAuthMethod: "string",
    oauthRefreshTokenValidity: 0,
    oauthTokenEndpoint: "string",
});
Copy
type: snowflake:ApiAuthenticationIntegrationWithAuthorizationCodeGrant
properties:
    comment: string
    enabled: false
    name: string
    oauthAccessTokenValidity: 0
    oauthAllowedScopes:
        - string
    oauthAuthorizationEndpoint: string
    oauthClientAuthMethod: string
    oauthClientId: string
    oauthClientSecret: string
    oauthRefreshTokenValidity: 0
    oauthTokenEndpoint: string
Copy

ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource accepts the following input properties:

Enabled This property is required. bool
Specifies whether this security integration is enabled or disabled.
OauthClientId This property is required. string
Specifies the client ID for the OAuth application in the external service.
OauthClientSecret This property is required. string
Comment string
Specifies a comment for the integration.
Name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
OauthAccessTokenValidity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
OauthAllowedScopes List<string>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
OauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
OauthRefreshTokenValidity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
OauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
Enabled This property is required. bool
Specifies whether this security integration is enabled or disabled.
OauthClientId This property is required. string
Specifies the client ID for the OAuth application in the external service.
OauthClientSecret This property is required. string
Comment string
Specifies a comment for the integration.
Name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
OauthAccessTokenValidity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
OauthAllowedScopes []string
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
OauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
OauthRefreshTokenValidity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
OauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
enabled This property is required. Boolean
Specifies whether this security integration is enabled or disabled.
oauthClientId This property is required. String
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret This property is required. String
comment String
Specifies a comment for the integration.
name Changes to this property will trigger replacement. String
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity Integer
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes List<String>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod String
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthRefreshTokenValidity Integer
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint String
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
enabled This property is required. boolean
Specifies whether this security integration is enabled or disabled.
oauthClientId This property is required. string
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret This property is required. string
comment string
Specifies a comment for the integration.
name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity number
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes string[]
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthRefreshTokenValidity number
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
enabled This property is required. bool
Specifies whether this security integration is enabled or disabled.
oauth_client_id This property is required. str
Specifies the client ID for the OAuth application in the external service.
oauth_client_secret This property is required. str
comment str
Specifies a comment for the integration.
name Changes to this property will trigger replacement. str
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauth_access_token_validity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauth_allowed_scopes Sequence[str]
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauth_authorization_endpoint str
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauth_client_auth_method str
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauth_refresh_token_validity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauth_token_endpoint str
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
enabled This property is required. Boolean
Specifies whether this security integration is enabled or disabled.
oauthClientId This property is required. String
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret This property is required. String
comment String
Specifies a comment for the integration.
name Changes to this property will trigger replacement. String
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity Number
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes List<String>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod String
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthRefreshTokenValidity Number
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint String
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource produces the following output properties:

DescribeOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
ShowOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
DescribeOutputs []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
ShowOutputs []ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describeOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
showOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describeOutputs ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput[]
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
id string
The provider-assigned unique ID for this managed resource.
showOutputs ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput[]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describe_outputs Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput]
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
id str
The provider-assigned unique ID for this managed resource.
show_outputs Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describeOutputs List<Property Map>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.

Look up Existing ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource

Get an existing ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiAuthenticationIntegrationWithAuthorizationCodeGrantState, opts?: CustomResourceOptions): ApiAuthenticationIntegrationWithAuthorizationCodeGrant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs]] = None,
        enabled: Optional[bool] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        oauth_access_token_validity: Optional[int] = None,
        oauth_allowed_scopes: Optional[Sequence[str]] = None,
        oauth_authorization_endpoint: Optional[str] = None,
        oauth_client_auth_method: Optional[str] = None,
        oauth_client_id: Optional[str] = None,
        oauth_client_secret: Optional[str] = None,
        oauth_refresh_token_validity: Optional[int] = None,
        oauth_token_endpoint: Optional[str] = None,
        show_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs]] = None) -> ApiAuthenticationIntegrationWithAuthorizationCodeGrant
func GetApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx *Context, name string, id IDInput, state *ApiAuthenticationIntegrationWithAuthorizationCodeGrantState, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithAuthorizationCodeGrant, error)
public static ApiAuthenticationIntegrationWithAuthorizationCodeGrant Get(string name, Input<string> id, ApiAuthenticationIntegrationWithAuthorizationCodeGrantState? state, CustomResourceOptions? opts = null)
public static ApiAuthenticationIntegrationWithAuthorizationCodeGrant get(String name, Output<String> id, ApiAuthenticationIntegrationWithAuthorizationCodeGrantState state, CustomResourceOptions options)
resources:  _:    type: snowflake:ApiAuthenticationIntegrationWithAuthorizationCodeGrant    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Comment string
Specifies a comment for the integration.
DescribeOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
Enabled bool
Specifies whether this security integration is enabled or disabled.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
OauthAccessTokenValidity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
OauthAllowedScopes List<string>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
OauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
OauthClientId string
Specifies the client ID for the OAuth application in the external service.
OauthClientSecret string
OauthRefreshTokenValidity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
OauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
ShowOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
Comment string
Specifies a comment for the integration.
DescribeOutputs []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
Enabled bool
Specifies whether this security integration is enabled or disabled.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
OauthAccessTokenValidity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
OauthAllowedScopes []string
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
OauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
OauthClientId string
Specifies the client ID for the OAuth application in the external service.
OauthClientSecret string
OauthRefreshTokenValidity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
OauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
ShowOutputs []ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment String
Specifies a comment for the integration.
describeOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
enabled Boolean
Specifies whether this security integration is enabled or disabled.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity Integer
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes List<String>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod String
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthClientId String
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret String
oauthRefreshTokenValidity Integer
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint String
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
showOutputs List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment string
Specifies a comment for the integration.
describeOutputs ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput[]
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
enabled boolean
Specifies whether this security integration is enabled or disabled.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. string
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity number
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes string[]
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod string
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthClientId string
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret string
oauthRefreshTokenValidity number
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint string
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
showOutputs ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput[]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment str
Specifies a comment for the integration.
describe_outputs Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs]
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
enabled bool
Specifies whether this security integration is enabled or disabled.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. str
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauth_access_token_validity int
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauth_allowed_scopes Sequence[str]
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauth_authorization_endpoint str
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauth_client_auth_method str
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauth_client_id str
Specifies the client ID for the OAuth application in the external service.
oauth_client_secret str
oauth_refresh_token_validity int
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauth_token_endpoint str
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
show_outputs Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment String
Specifies a comment for the integration.
describeOutputs List<Property Map>
Outputs the result of DESCRIBE SECURITY INTEGRATIONS for the given security integration.
enabled Boolean
Specifies whether this security integration is enabled or disabled.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
oauthAccessTokenValidity Number
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
oauthAllowedScopes List<String>
Specifies a list of scopes to use when making a request from the OAuth by a role with USAGE on the integration during the OAuth client credentials flow.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
oauthClientAuthMethod String
Specifies that POST is used as the authentication method to the external service. If removed from the config, the resource is recreated. Valid values are (case-insensitive): CLIENT_SECRET_POST.
oauthClientId String
Specifies the client ID for the OAuth application in the external service.
oauthClientSecret String
oauthRefreshTokenValidity Number
Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
oauthTokenEndpoint String
Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
showOutputs List<Property Map>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.

Supporting Types

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs

AuthTypes List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType>
Comments List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment>
Enableds List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled>
OauthAccessTokenValidities List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity>
OauthAllowedScopes List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope>
OauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint>
OauthClientAuthMethods List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod>
OauthClientIds List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId>
OauthGrants List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant>
OauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity>
OauthTokenEndpoints List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint>
ParentIntegrations List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration>
AuthTypes []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType
Comments []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment
Enableds []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled
OauthAccessTokenValidities []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity
OauthAllowedScopes []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope
OauthAuthorizationEndpoints []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint
OauthClientAuthMethods []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod
OauthClientIds []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId
OauthGrants []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant
OauthRefreshTokenValidities []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity
OauthTokenEndpoints []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint
ParentIntegrations []ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration
authTypes List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType>
comments List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment>
enableds List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled>
oauthAccessTokenValidities List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity>
oauthAllowedScopes List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope>
oauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint>
oauthClientAuthMethods List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod>
oauthClientIds List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId>
oauthGrants List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant>
oauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity>
oauthTokenEndpoints List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint>
parentIntegrations List<ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration>
authTypes ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType[]
comments ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment[]
enableds ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled[]
oauthAccessTokenValidities ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity[]
oauthAllowedScopes ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope[]
oauthAuthorizationEndpoints ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint[]
oauthClientAuthMethods ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod[]
oauthClientIds ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId[]
oauthGrants ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant[]
oauthRefreshTokenValidities ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity[]
oauthTokenEndpoints ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint[]
parentIntegrations ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration[]
auth_types Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType]
comments Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment]
enableds Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled]
oauth_access_token_validities Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity]
oauth_allowed_scopes Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope]
oauth_authorization_endpoints Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint]
oauth_client_auth_methods Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod]
oauth_client_ids Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId]
oauth_grants Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant]
oauth_refresh_token_validities Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity]
oauth_token_endpoints Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint]
parent_integrations Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration]

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthTypeArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputCommentArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabledArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidityArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScopeArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpointArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethodArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientIdArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrantArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidityArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpointArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegrationArgs

Default string
Name string
Type string
Value string
Default string
Name string
Type string
Value string
default_ String
name String
type String
value String
default string
name string
type string
value string
default str
name str
type str
value str
default String
name String
type String
value String

ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput
, ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs

Category string
Comment string
CreatedOn string
Enabled bool
IntegrationType string
Name string
Category string
Comment string
CreatedOn string
Enabled bool
IntegrationType string
Name string
category String
comment String
createdOn String
enabled Boolean
integrationType String
name String
category string
comment string
createdOn string
enabled boolean
integrationType string
name string
category String
comment String
createdOn String
enabled Boolean
integrationType String
name String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake