Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake
  3. API Docs
  4. ApiAuthenticationIntegrationWithClientCredentials
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.ApiAuthenticationIntegrationWithClientCredentials

Explore with Pulumi AI

snowflake logo
Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/apiAuthenticationIntegrationWithClientCredentials:ApiAuthenticationIntegrationWithClientCredentials example "name"

    Create ApiAuthenticationIntegrationWithClientCredentials Resource

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

    Constructor syntax

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

@overload
def ApiAuthenticationIntegrationWithClientCredentials(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_client_auth_method: Optional[str] = None,
                                                      oauth_refresh_token_validity: Optional[int] = None,
                                                      oauth_token_endpoint: Optional[str] = None)
    func NewApiAuthenticationIntegrationWithClientCredentials(ctx *Context, name string, args ApiAuthenticationIntegrationWithClientCredentialsArgs, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithClientCredentials, error)
    public ApiAuthenticationIntegrationWithClientCredentials(string name, ApiAuthenticationIntegrationWithClientCredentialsArgs args, CustomResourceOptions? opts = null)
    public ApiAuthenticationIntegrationWithClientCredentials(String name, ApiAuthenticationIntegrationWithClientCredentialsArgs args)
public ApiAuthenticationIntegrationWithClientCredentials(String name, ApiAuthenticationIntegrationWithClientCredentialsArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ApiAuthenticationIntegrationWithClientCredentialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiAuthenticationIntegrationWithClientCredentialsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiAuthenticationIntegrationWithClientCredentialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiAuthenticationIntegrationWithClientCredentialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiAuthenticationIntegrationWithClientCredentialsArgs
    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 apiAuthenticationIntegrationWithClientCredentialsResource = new Snowflake.ApiAuthenticationIntegrationWithClientCredentials("apiAuthenticationIntegrationWithClientCredentialsResource", new()
{
    Enabled = false,
    OauthClientId = "string",
    OauthClientSecret = "string",
    Comment = "string",
    Name = "string",
    OauthAccessTokenValidity = 0,
    OauthAllowedScopes = new[]
    {
        "string",
    },
    OauthClientAuthMethod = "string",
    OauthRefreshTokenValidity = 0,
    OauthTokenEndpoint = "string",
});

    example, err := snowflake.NewApiAuthenticationIntegrationWithClientCredentials(ctx, "apiAuthenticationIntegrationWithClientCredentialsResource", &snowflake.ApiAuthenticationIntegrationWithClientCredentialsArgs{
	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"),
	},
	OauthClientAuthMethod:     pulumi.String("string"),
	OauthRefreshTokenValidity: pulumi.Int(0),
	OauthTokenEndpoint:        pulumi.String("string"),
})

    var apiAuthenticationIntegrationWithClientCredentialsResource = new ApiAuthenticationIntegrationWithClientCredentials("apiAuthenticationIntegrationWithClientCredentialsResource", ApiAuthenticationIntegrationWithClientCredentialsArgs.builder()
    .enabled(false)
    .oauthClientId("string")
    .oauthClientSecret("string")
    .comment("string")
    .name("string")
    .oauthAccessTokenValidity(0)
    .oauthAllowedScopes("string")
    .oauthClientAuthMethod("string")
    .oauthRefreshTokenValidity(0)
    .oauthTokenEndpoint("string")
    .build());

    api_authentication_integration_with_client_credentials_resource = snowflake.ApiAuthenticationIntegrationWithClientCredentials("apiAuthenticationIntegrationWithClientCredentialsResource",
    enabled=False,
    oauth_client_id="string",
    oauth_client_secret="string",
    comment="string",
    name="string",
    oauth_access_token_validity=0,
    oauth_allowed_scopes=["string"],
    oauth_client_auth_method="string",
    oauth_refresh_token_validity=0,
    oauth_token_endpoint="string")

    const apiAuthenticationIntegrationWithClientCredentialsResource = new snowflake.ApiAuthenticationIntegrationWithClientCredentials("apiAuthenticationIntegrationWithClientCredentialsResource", {
    enabled: false,
    oauthClientId: "string",
    oauthClientSecret: "string",
    comment: "string",
    name: "string",
    oauthAccessTokenValidity: 0,
    oauthAllowedScopes: ["string"],
    oauthClientAuthMethod: "string",
    oauthRefreshTokenValidity: 0,
    oauthTokenEndpoint: "string",
});

    type: snowflake:ApiAuthenticationIntegrationWithClientCredentials
properties:
    comment: string
    enabled: false
    name: string
    oauthAccessTokenValidity: 0
    oauthAllowedScopes:
        - string
    oauthClientAuthMethod: string
    oauthClientId: string
    oauthClientSecret: string
    oauthRefreshTokenValidity: 0
    oauthTokenEndpoint: string

    ApiAuthenticationIntegrationWithClientCredentials Resource Properties

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

    Inputs

    The ApiAuthenticationIntegrationWithClientCredentials resource accepts the following input properties:

    Enabled bool
    Specifies whether this security integration is enabled or disabled.
    OauthClientId string
    Specifies the client ID for the OAuth application in the external service.
    OauthClientSecret string
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    Comment string
    Specifies a comment for the integration.
    Name 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
    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.
    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 bool
    Specifies whether this security integration is enabled or disabled.
    OauthClientId string
    Specifies the client ID for the OAuth application in the external service.
    OauthClientSecret string
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    Comment string
    Specifies a comment for the integration.
    Name 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
    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.
    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 Boolean
    Specifies whether this security integration is enabled or disabled.
    oauthClientId String
    Specifies the client ID for the OAuth application in the external service.
    oauthClientSecret String
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    comment String
    Specifies a comment for the integration.
    name 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
    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.
    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 boolean
    Specifies whether this security integration is enabled or disabled.
    oauthClientId string
    Specifies the client ID for the OAuth application in the external service.
    oauthClientSecret string
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    comment string
    Specifies a comment for the integration.
    name 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
    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.
    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 bool
    Specifies whether this security integration is enabled or disabled.
    oauth_client_id str
    Specifies the client ID for the OAuth application in the external service.
    oauth_client_secret str
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    comment str
    Specifies a comment for the integration.
    name 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
    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_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 Boolean
    Specifies whether this security integration is enabled or disabled.
    oauthClientId String
    Specifies the client ID for the OAuth application in the external service.
    oauthClientSecret String
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    comment String
    Specifies a comment for the integration.
    name 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
    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.
    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 ApiAuthenticationIntegrationWithClientCredentials resource produces the following output properties:

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

    Get an existing ApiAuthenticationIntegrationWithClientCredentials 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?: ApiAuthenticationIntegrationWithClientCredentialsState, opts?: CustomResourceOptions): ApiAuthenticationIntegrationWithClientCredentials
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputArgs]] = 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_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[ApiAuthenticationIntegrationWithClientCredentialsShowOutputArgs]] = None) -> ApiAuthenticationIntegrationWithClientCredentials
    func GetApiAuthenticationIntegrationWithClientCredentials(ctx *Context, name string, id IDInput, state *ApiAuthenticationIntegrationWithClientCredentialsState, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithClientCredentials, error)
    public static ApiAuthenticationIntegrationWithClientCredentials Get(string name, Input<string> id, ApiAuthenticationIntegrationWithClientCredentialsState? state, CustomResourceOptions? opts = null)
    public static ApiAuthenticationIntegrationWithClientCredentials get(String name, Output<String> id, ApiAuthenticationIntegrationWithClientCredentialsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutput>
    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 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
    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.
    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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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<ApiAuthenticationIntegrationWithClientCredentialsShowOutput>
    Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
    Comment string
    Specifies a comment for the integration.
    DescribeOutputs []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputArgs
    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 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
    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.
    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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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 []ApiAuthenticationIntegrationWithClientCredentialsShowOutputArgs
    Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
    comment String
    Specifies a comment for the integration.
    describeOutputs List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutput>
    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 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
    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.
    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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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<ApiAuthenticationIntegrationWithClientCredentialsShowOutput>
    Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
    comment string
    Specifies a comment for the integration.
    describeOutputs ApiAuthenticationIntegrationWithClientCredentialsDescribeOutput[]
    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 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
    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.
    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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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 ApiAuthenticationIntegrationWithClientCredentialsShowOutput[]
    Outputs the result of SHOW SECURITY INTEGRATIONS for the given security integration.
    comment str
    Specifies a comment for the integration.
    describe_outputs Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputArgs]
    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 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
    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_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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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[ApiAuthenticationIntegrationWithClientCredentialsShowOutputArgs]
    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 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
    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.
    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
    Specifies the client secret for the OAuth application in the ServiceNow instance from the previous step. The connector uses this to request an access token from the ServiceNow instance.
    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutput, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputArgs

    AuthTypes List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType>
    Comments List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment>
    Enableds List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled>
    OauthAccessTokenValidities List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity>
    OauthAllowedScopes List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope>
    OauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint>
    OauthClientAuthMethods List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod>
    OauthClientIds List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId>
    OauthGrants List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant>
    OauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity>
    OauthTokenEndpoints List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint>
    ParentIntegrations List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration>
    AuthTypes []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType
    Comments []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment
    Enableds []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled
    OauthAccessTokenValidities []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity
    OauthAllowedScopes []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope
    OauthAuthorizationEndpoints []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint
    OauthClientAuthMethods []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod
    OauthClientIds []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId
    OauthGrants []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant
    OauthRefreshTokenValidities []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity
    OauthTokenEndpoints []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint
    ParentIntegrations []ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration
    authTypes List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType>
    comments List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment>
    enableds List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled>
    oauthAccessTokenValidities List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity>
    oauthAllowedScopes List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope>
    oauthAuthorizationEndpoints List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint>
    oauthClientAuthMethods List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod>
    oauthClientIds List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId>
    oauthGrants List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant>
    oauthRefreshTokenValidities List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity>
    oauthTokenEndpoints List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint>
    parentIntegrations List<ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration>
    authTypes ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType[]
    comments ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment[]
    enableds ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled[]
    oauthAccessTokenValidities ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity[]
    oauthAllowedScopes ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope[]
    oauthAuthorizationEndpoints ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint[]
    oauthClientAuthMethods ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod[]
    oauthClientIds ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId[]
    oauthGrants ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant[]
    oauthRefreshTokenValidities ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity[]
    oauthTokenEndpoints ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint[]
    parentIntegrations ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration[]
    auth_types Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType]
    comments Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment]
    enableds Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled]
    oauth_access_token_validities Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity]
    oauth_allowed_scopes Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope]
    oauth_authorization_endpoints Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint]
    oauth_client_auth_methods Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod]
    oauth_client_ids Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId]
    oauth_grants Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant]
    oauth_refresh_token_validities Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity]
    oauth_token_endpoints Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint]
    parent_integrations Sequence[ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration]

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthType, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputAuthTypeArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputComment, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputCommentArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabled, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputEnabledArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidity, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAccessTokenValidityArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScope, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAllowedScopeArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpoint, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthAuthorizationEndpointArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethod, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientAuthMethodArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientId, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthClientIdArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrant, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthGrantArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidity, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthRefreshTokenValidityArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpoint, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputOauthTokenEndpointArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegration, ApiAuthenticationIntegrationWithClientCredentialsDescribeOutputParentIntegrationArgs

    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

    ApiAuthenticationIntegrationWithClientCredentialsShowOutput, ApiAuthenticationIntegrationWithClientCredentialsShowOutputArgs

    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 logo
    Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-snowflake