1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ApiAuthenticationIntegrationWithJwtBearer
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi

snowflake.ApiAuthenticationIntegrationWithJwtBearer

Explore with Pulumi AI

Import

$ pulumi import snowflake:index/apiAuthenticationIntegrationWithJwtBearer:ApiAuthenticationIntegrationWithJwtBearer example '"<integration_name>"'
Copy

Create ApiAuthenticationIntegrationWithJwtBearer Resource

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

Constructor syntax

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

@overload
def ApiAuthenticationIntegrationWithJwtBearer(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              enabled: Optional[bool] = None,
                                              oauth_assertion_issuer: Optional[str] = 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_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 NewApiAuthenticationIntegrationWithJwtBearer(ctx *Context, name string, args ApiAuthenticationIntegrationWithJwtBearerArgs, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithJwtBearer, error)
public ApiAuthenticationIntegrationWithJwtBearer(string name, ApiAuthenticationIntegrationWithJwtBearerArgs args, CustomResourceOptions? opts = null)
public ApiAuthenticationIntegrationWithJwtBearer(String name, ApiAuthenticationIntegrationWithJwtBearerArgs args)
public ApiAuthenticationIntegrationWithJwtBearer(String name, ApiAuthenticationIntegrationWithJwtBearerArgs args, CustomResourceOptions options)
type: snowflake:ApiAuthenticationIntegrationWithJwtBearer
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. ApiAuthenticationIntegrationWithJwtBearerArgs
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. ApiAuthenticationIntegrationWithJwtBearerArgs
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. ApiAuthenticationIntegrationWithJwtBearerArgs
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. ApiAuthenticationIntegrationWithJwtBearerArgs
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. ApiAuthenticationIntegrationWithJwtBearerArgs
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 apiAuthenticationIntegrationWithJwtBearerResource = new Snowflake.ApiAuthenticationIntegrationWithJwtBearer("apiAuthenticationIntegrationWithJwtBearerResource", new()
{
    Enabled = false,
    OauthAssertionIssuer = "string",
    OauthClientId = "string",
    OauthClientSecret = "string",
    Comment = "string",
    Name = "string",
    OauthAccessTokenValidity = 0,
    OauthAuthorizationEndpoint = "string",
    OauthClientAuthMethod = "string",
    OauthRefreshTokenValidity = 0,
    OauthTokenEndpoint = "string",
});
Copy
example, err := snowflake.NewApiAuthenticationIntegrationWithJwtBearer(ctx, "apiAuthenticationIntegrationWithJwtBearerResource", &snowflake.ApiAuthenticationIntegrationWithJwtBearerArgs{
	Enabled:                    pulumi.Bool(false),
	OauthAssertionIssuer:       pulumi.String("string"),
	OauthClientId:              pulumi.String("string"),
	OauthClientSecret:          pulumi.String("string"),
	Comment:                    pulumi.String("string"),
	Name:                       pulumi.String("string"),
	OauthAccessTokenValidity:   pulumi.Int(0),
	OauthAuthorizationEndpoint: pulumi.String("string"),
	OauthClientAuthMethod:      pulumi.String("string"),
	OauthRefreshTokenValidity:  pulumi.Int(0),
	OauthTokenEndpoint:         pulumi.String("string"),
})
Copy
var apiAuthenticationIntegrationWithJwtBearerResource = new ApiAuthenticationIntegrationWithJwtBearer("apiAuthenticationIntegrationWithJwtBearerResource", ApiAuthenticationIntegrationWithJwtBearerArgs.builder()
    .enabled(false)
    .oauthAssertionIssuer("string")
    .oauthClientId("string")
    .oauthClientSecret("string")
    .comment("string")
    .name("string")
    .oauthAccessTokenValidity(0)
    .oauthAuthorizationEndpoint("string")
    .oauthClientAuthMethod("string")
    .oauthRefreshTokenValidity(0)
    .oauthTokenEndpoint("string")
    .build());
Copy
api_authentication_integration_with_jwt_bearer_resource = snowflake.ApiAuthenticationIntegrationWithJwtBearer("apiAuthenticationIntegrationWithJwtBearerResource",
    enabled=False,
    oauth_assertion_issuer="string",
    oauth_client_id="string",
    oauth_client_secret="string",
    comment="string",
    name="string",
    oauth_access_token_validity=0,
    oauth_authorization_endpoint="string",
    oauth_client_auth_method="string",
    oauth_refresh_token_validity=0,
    oauth_token_endpoint="string")
Copy
const apiAuthenticationIntegrationWithJwtBearerResource = new snowflake.ApiAuthenticationIntegrationWithJwtBearer("apiAuthenticationIntegrationWithJwtBearerResource", {
    enabled: false,
    oauthAssertionIssuer: "string",
    oauthClientId: "string",
    oauthClientSecret: "string",
    comment: "string",
    name: "string",
    oauthAccessTokenValidity: 0,
    oauthAuthorizationEndpoint: "string",
    oauthClientAuthMethod: "string",
    oauthRefreshTokenValidity: 0,
    oauthTokenEndpoint: "string",
});
Copy
type: snowflake:ApiAuthenticationIntegrationWithJwtBearer
properties:
    comment: string
    enabled: false
    name: string
    oauthAccessTokenValidity: 0
    oauthAssertionIssuer: string
    oauthAuthorizationEndpoint: string
    oauthClientAuthMethod: string
    oauthClientId: string
    oauthClientSecret: string
    oauthRefreshTokenValidity: 0
    oauthTokenEndpoint: string
Copy

ApiAuthenticationIntegrationWithJwtBearer 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 ApiAuthenticationIntegrationWithJwtBearer resource accepts the following input properties:

Enabled This property is required. bool
Specifies whether this security integration is enabled or disabled.
OauthAssertionIssuer This property is required. string
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.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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.
OauthAssertionIssuer This property is required. string
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.
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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.
oauthAssertionIssuer This property is required. String
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.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service.
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.
oauthAssertionIssuer This property is required. string
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.
oauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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_assertion_issuer This property is required. str
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_authorization_endpoint str
Specifies the URL for authenticating to the external service.
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.
oauthAssertionIssuer This property is required. String
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.
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service.
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 ApiAuthenticationIntegrationWithJwtBearer resource produces the following output properties:

DescribeOutputs List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutput>
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<ApiAuthenticationIntegrationWithJwtBearerShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
DescribeOutputs []ApiAuthenticationIntegrationWithJwtBearerDescribeOutput
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 []ApiAuthenticationIntegrationWithJwtBearerShowOutput
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describeOutputs List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutput>
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<ApiAuthenticationIntegrationWithJwtBearerShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describeOutputs ApiAuthenticationIntegrationWithJwtBearerDescribeOutput[]
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 ApiAuthenticationIntegrationWithJwtBearerShowOutput[]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
describe_outputs Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutput]
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[ApiAuthenticationIntegrationWithJwtBearerShowOutput]
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 ApiAuthenticationIntegrationWithJwtBearer Resource

Get an existing ApiAuthenticationIntegrationWithJwtBearer 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?: ApiAuthenticationIntegrationWithJwtBearerState, opts?: CustomResourceOptions): ApiAuthenticationIntegrationWithJwtBearer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputArgs]] = None,
        enabled: Optional[bool] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        oauth_access_token_validity: Optional[int] = None,
        oauth_assertion_issuer: Optional[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[ApiAuthenticationIntegrationWithJwtBearerShowOutputArgs]] = None) -> ApiAuthenticationIntegrationWithJwtBearer
func GetApiAuthenticationIntegrationWithJwtBearer(ctx *Context, name string, id IDInput, state *ApiAuthenticationIntegrationWithJwtBearerState, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithJwtBearer, error)
public static ApiAuthenticationIntegrationWithJwtBearer Get(string name, Input<string> id, ApiAuthenticationIntegrationWithJwtBearerState? state, CustomResourceOptions? opts = null)
public static ApiAuthenticationIntegrationWithJwtBearer get(String name, Output<String> id, ApiAuthenticationIntegrationWithJwtBearerState state, CustomResourceOptions options)
resources:  _:    type: snowflake:ApiAuthenticationIntegrationWithJwtBearer    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<ApiAuthenticationIntegrationWithJwtBearerDescribeOutput>
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.
OauthAssertionIssuer string
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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<ApiAuthenticationIntegrationWithJwtBearerShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
Comment string
Specifies a comment for the integration.
DescribeOutputs []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputArgs
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.
OauthAssertionIssuer string
OauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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 []ApiAuthenticationIntegrationWithJwtBearerShowOutputArgs
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment String
Specifies a comment for the integration.
describeOutputs List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutput>
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.
oauthAssertionIssuer String
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service.
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<ApiAuthenticationIntegrationWithJwtBearerShowOutput>
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment string
Specifies a comment for the integration.
describeOutputs ApiAuthenticationIntegrationWithJwtBearerDescribeOutput[]
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.
oauthAssertionIssuer string
oauthAuthorizationEndpoint string
Specifies the URL for authenticating to the external service.
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 ApiAuthenticationIntegrationWithJwtBearerShowOutput[]
Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
comment str
Specifies a comment for the integration.
describe_outputs Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputArgs]
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_assertion_issuer str
oauth_authorization_endpoint str
Specifies the URL for authenticating to the external service.
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[ApiAuthenticationIntegrationWithJwtBearerShowOutputArgs]
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.
oauthAssertionIssuer String
oauthAuthorizationEndpoint String
Specifies the URL for authenticating to the external service.
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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutput
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputArgs

AuthTypes List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthType>
Comments List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputComment>
Enableds List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabled>
OauthAccessTokenValidities List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidity>
OauthAllowedScopes List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScope>
OauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpoint>
OauthClientAuthMethods List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethod>
OauthClientIds List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientId>
OauthGrants List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrant>
OauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidity>
OauthTokenEndpoints List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpoint>
ParentIntegrations List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegration>
AuthTypes []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthType
Comments []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputComment
Enableds []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabled
OauthAccessTokenValidities []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidity
OauthAllowedScopes []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScope
OauthAuthorizationEndpoints []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpoint
OauthClientAuthMethods []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethod
OauthClientIds []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientId
OauthGrants []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrant
OauthRefreshTokenValidities []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidity
OauthTokenEndpoints []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpoint
ParentIntegrations []ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegration
authTypes List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthType>
comments List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputComment>
enableds List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabled>
oauthAccessTokenValidities List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidity>
oauthAllowedScopes List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScope>
oauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpoint>
oauthClientAuthMethods List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethod>
oauthClientIds List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientId>
oauthGrants List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrant>
oauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidity>
oauthTokenEndpoints List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpoint>
parentIntegrations List<ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegration>
auth_types Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthType]
comments Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputComment]
enableds Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabled]
oauth_access_token_validities Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidity]
oauth_allowed_scopes Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScope]
oauth_authorization_endpoints Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpoint]
oauth_client_auth_methods Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethod]
oauth_client_ids Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientId]
oauth_grants Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrant]
oauth_refresh_token_validities Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidity]
oauth_token_endpoints Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpoint]
parent_integrations Sequence[ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegration]

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthType
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputAuthTypeArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputComment
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputCommentArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabled
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputEnabledArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidity
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAccessTokenValidityArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScope
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAllowedScopeArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpoint
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthAuthorizationEndpointArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethod
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientAuthMethodArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientId
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthClientIdArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrant
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthGrantArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidity
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthRefreshTokenValidityArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpoint
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputOauthTokenEndpointArgs

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

ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegration
, ApiAuthenticationIntegrationWithJwtBearerDescribeOutputParentIntegrationArgs

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

ApiAuthenticationIntegrationWithJwtBearerShowOutput
, ApiAuthenticationIntegrationWithJwtBearerShowOutputArgs

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.