snowflake.OauthIntegrationForCustomClients
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/oauthIntegrationForCustomClients:OauthIntegrationForCustomClients example '"<integration_name>"'
Create OauthIntegrationForCustomClients Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OauthIntegrationForCustomClients(name: string, args: OauthIntegrationForCustomClientsArgs, opts?: CustomResourceOptions);@overload
def OauthIntegrationForCustomClients(resource_name: str,
                                     args: OauthIntegrationForCustomClientsArgs,
                                     opts: Optional[ResourceOptions] = None)
@overload
def OauthIntegrationForCustomClients(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     oauth_client_type: Optional[str] = None,
                                     oauth_redirect_uri: Optional[str] = None,
                                     oauth_client_rsa_public_key: Optional[str] = None,
                                     name: Optional[str] = None,
                                     network_policy: Optional[str] = None,
                                     oauth_allow_non_tls_redirect_uri: Optional[str] = None,
                                     blocked_roles_lists: Optional[Sequence[str]] = None,
                                     oauth_client_rsa_public_key2: Optional[str] = None,
                                     enabled: Optional[str] = None,
                                     oauth_enforce_pkce: Optional[str] = None,
                                     oauth_issue_refresh_tokens: Optional[str] = None,
                                     comment: Optional[str] = None,
                                     oauth_refresh_token_validity: Optional[int] = None,
                                     oauth_use_secondary_roles: Optional[str] = None,
                                     pre_authorized_roles_lists: Optional[Sequence[str]] = None)func NewOauthIntegrationForCustomClients(ctx *Context, name string, args OauthIntegrationForCustomClientsArgs, opts ...ResourceOption) (*OauthIntegrationForCustomClients, error)public OauthIntegrationForCustomClients(string name, OauthIntegrationForCustomClientsArgs args, CustomResourceOptions? opts = null)
public OauthIntegrationForCustomClients(String name, OauthIntegrationForCustomClientsArgs args)
public OauthIntegrationForCustomClients(String name, OauthIntegrationForCustomClientsArgs args, CustomResourceOptions options)
type: snowflake:OauthIntegrationForCustomClients
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 OauthIntegrationForCustomClientsArgs
- 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 OauthIntegrationForCustomClientsArgs
- 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 OauthIntegrationForCustomClientsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OauthIntegrationForCustomClientsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OauthIntegrationForCustomClientsArgs
- 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 oauthIntegrationForCustomClientsResource = new Snowflake.OauthIntegrationForCustomClients("oauthIntegrationForCustomClientsResource", new()
{
    OauthClientType = "string",
    OauthRedirectUri = "string",
    OauthClientRsaPublicKey = "string",
    Name = "string",
    NetworkPolicy = "string",
    OauthAllowNonTlsRedirectUri = "string",
    BlockedRolesLists = new[]
    {
        "string",
    },
    OauthClientRsaPublicKey2 = "string",
    Enabled = "string",
    OauthEnforcePkce = "string",
    OauthIssueRefreshTokens = "string",
    Comment = "string",
    OauthRefreshTokenValidity = 0,
    OauthUseSecondaryRoles = "string",
    PreAuthorizedRolesLists = new[]
    {
        "string",
    },
});
example, err := snowflake.NewOauthIntegrationForCustomClients(ctx, "oauthIntegrationForCustomClientsResource", &snowflake.OauthIntegrationForCustomClientsArgs{
	OauthClientType:             pulumi.String("string"),
	OauthRedirectUri:            pulumi.String("string"),
	OauthClientRsaPublicKey:     pulumi.String("string"),
	Name:                        pulumi.String("string"),
	NetworkPolicy:               pulumi.String("string"),
	OauthAllowNonTlsRedirectUri: pulumi.String("string"),
	BlockedRolesLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	OauthClientRsaPublicKey2:  pulumi.String("string"),
	Enabled:                   pulumi.String("string"),
	OauthEnforcePkce:          pulumi.String("string"),
	OauthIssueRefreshTokens:   pulumi.String("string"),
	Comment:                   pulumi.String("string"),
	OauthRefreshTokenValidity: pulumi.Int(0),
	OauthUseSecondaryRoles:    pulumi.String("string"),
	PreAuthorizedRolesLists: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var oauthIntegrationForCustomClientsResource = new OauthIntegrationForCustomClients("oauthIntegrationForCustomClientsResource", OauthIntegrationForCustomClientsArgs.builder()
    .oauthClientType("string")
    .oauthRedirectUri("string")
    .oauthClientRsaPublicKey("string")
    .name("string")
    .networkPolicy("string")
    .oauthAllowNonTlsRedirectUri("string")
    .blockedRolesLists("string")
    .oauthClientRsaPublicKey2("string")
    .enabled("string")
    .oauthEnforcePkce("string")
    .oauthIssueRefreshTokens("string")
    .comment("string")
    .oauthRefreshTokenValidity(0)
    .oauthUseSecondaryRoles("string")
    .preAuthorizedRolesLists("string")
    .build());
oauth_integration_for_custom_clients_resource = snowflake.OauthIntegrationForCustomClients("oauthIntegrationForCustomClientsResource",
    oauth_client_type="string",
    oauth_redirect_uri="string",
    oauth_client_rsa_public_key="string",
    name="string",
    network_policy="string",
    oauth_allow_non_tls_redirect_uri="string",
    blocked_roles_lists=["string"],
    oauth_client_rsa_public_key2="string",
    enabled="string",
    oauth_enforce_pkce="string",
    oauth_issue_refresh_tokens="string",
    comment="string",
    oauth_refresh_token_validity=0,
    oauth_use_secondary_roles="string",
    pre_authorized_roles_lists=["string"])
const oauthIntegrationForCustomClientsResource = new snowflake.OauthIntegrationForCustomClients("oauthIntegrationForCustomClientsResource", {
    oauthClientType: "string",
    oauthRedirectUri: "string",
    oauthClientRsaPublicKey: "string",
    name: "string",
    networkPolicy: "string",
    oauthAllowNonTlsRedirectUri: "string",
    blockedRolesLists: ["string"],
    oauthClientRsaPublicKey2: "string",
    enabled: "string",
    oauthEnforcePkce: "string",
    oauthIssueRefreshTokens: "string",
    comment: "string",
    oauthRefreshTokenValidity: 0,
    oauthUseSecondaryRoles: "string",
    preAuthorizedRolesLists: ["string"],
});
type: snowflake:OauthIntegrationForCustomClients
properties:
    blockedRolesLists:
        - string
    comment: string
    enabled: string
    name: string
    networkPolicy: string
    oauthAllowNonTlsRedirectUri: string
    oauthClientRsaPublicKey: string
    oauthClientRsaPublicKey2: string
    oauthClientType: string
    oauthEnforcePkce: string
    oauthIssueRefreshTokens: string
    oauthRedirectUri: string
    oauthRefreshTokenValidity: 0
    oauthUseSecondaryRoles: string
    preAuthorizedRolesLists:
        - string
OauthIntegrationForCustomClients 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 OauthIntegrationForCustomClients resource accepts the following input properties:
- OauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- OauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- BlockedRoles List<string>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- Comment string
- Specifies a comment for the OAuth integration.
- Enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NetworkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- OauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthClient stringRsa Public Key 
- OauthClient stringRsa Public Key2 
- OauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthRefresh intToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- OauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<string>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- OauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- OauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- BlockedRoles []stringLists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- Comment string
- Specifies a comment for the OAuth integration.
- Enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- Name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NetworkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- OauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthClient stringRsa Public Key 
- OauthClient stringRsa Public Key2 
- OauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthRefresh intToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- OauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- []string
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- oauthClient StringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthRedirect StringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- blockedRoles List<String>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment String
- Specifies a comment for the OAuth integration.
- enabled String
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- name String
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy String
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow StringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient StringRsa Public Key 
- oauthClient StringRsa Public Key2 
- oauthEnforce StringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue StringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRefresh IntegerToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse StringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<String>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- oauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- blockedRoles string[]Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment string
- Specifies a comment for the OAuth integration.
- enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient stringRsa Public Key 
- oauthClient stringRsa Public Key2 
- oauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRefresh numberToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- string[]
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- oauth_client_ strtype 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauth_redirect_ struri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- blocked_roles_ Sequence[str]lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment str
- Specifies a comment for the OAuth integration.
- enabled str
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- name str
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- network_policy str
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauth_allow_ strnon_ tls_ redirect_ uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_client_ strrsa_ public_ key 
- oauth_client_ strrsa_ public_ key2 
- oauth_enforce_ strpkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_issue_ strrefresh_ tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_refresh_ inttoken_ validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauth_use_ strsecondary_ roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- Sequence[str]
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- oauthClient StringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthRedirect StringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- blockedRoles List<String>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment String
- Specifies a comment for the OAuth integration.
- enabled String
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- name String
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy String
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow StringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient StringRsa Public Key 
- oauthClient StringRsa Public Key2 
- oauthEnforce StringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue StringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRefresh NumberToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse StringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<String>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the OauthIntegrationForCustomClients resource produces the following output properties:
- DescribeOutputs List<OauthIntegration For Custom Clients Describe Output> 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- 
List<OauthIntegration For Custom Clients Related Parameter> 
- Parameters related to this security integration.
- ShowOutputs List<OauthIntegration For Custom Clients Show Output> 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- DescribeOutputs []OauthIntegration For Custom Clients Describe Output 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- 
[]OauthIntegration For Custom Clients Related Parameter 
- Parameters related to this security integration.
- ShowOutputs []OauthIntegration For Custom Clients Show Output 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- describeOutputs List<OauthIntegration For Custom Clients Describe Output> 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- 
List<OauthIntegration For Custom Clients Related Parameter> 
- Parameters related to this security integration.
- showOutputs List<OauthIntegration For Custom Clients Show Output> 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- describeOutputs OauthIntegration For Custom Clients Describe Output[] 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- fullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- 
OauthIntegration For Custom Clients Related Parameter[] 
- Parameters related to this security integration.
- showOutputs OauthIntegration For Custom Clients Show Output[] 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- describe_outputs Sequence[OauthIntegration For Custom Clients Describe Output] 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- fully_qualified_ strname 
- Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- 
Sequence[OauthIntegration For Custom Clients Related Parameter] 
- Parameters related to this security integration.
- show_outputs Sequence[OauthIntegration For Custom Clients Show Output] 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- describeOutputs List<Property Map>
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- List<Property Map>
- Parameters related to this security integration.
- showOutputs List<Property Map>
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
Look up Existing OauthIntegrationForCustomClients Resource
Get an existing OauthIntegrationForCustomClients 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?: OauthIntegrationForCustomClientsState, opts?: CustomResourceOptions): OauthIntegrationForCustomClients@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blocked_roles_lists: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[OauthIntegrationForCustomClientsDescribeOutputArgs]] = None,
        enabled: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        network_policy: Optional[str] = None,
        oauth_allow_non_tls_redirect_uri: Optional[str] = None,
        oauth_client_rsa_public_key: Optional[str] = None,
        oauth_client_rsa_public_key2: Optional[str] = None,
        oauth_client_type: Optional[str] = None,
        oauth_enforce_pkce: Optional[str] = None,
        oauth_issue_refresh_tokens: Optional[str] = None,
        oauth_redirect_uri: Optional[str] = None,
        oauth_refresh_token_validity: Optional[int] = None,
        oauth_use_secondary_roles: Optional[str] = None,
        pre_authorized_roles_lists: Optional[Sequence[str]] = None,
        related_parameters: Optional[Sequence[OauthIntegrationForCustomClientsRelatedParameterArgs]] = None,
        show_outputs: Optional[Sequence[OauthIntegrationForCustomClientsShowOutputArgs]] = None) -> OauthIntegrationForCustomClientsfunc GetOauthIntegrationForCustomClients(ctx *Context, name string, id IDInput, state *OauthIntegrationForCustomClientsState, opts ...ResourceOption) (*OauthIntegrationForCustomClients, error)public static OauthIntegrationForCustomClients Get(string name, Input<string> id, OauthIntegrationForCustomClientsState? state, CustomResourceOptions? opts = null)public static OauthIntegrationForCustomClients get(String name, Output<String> id, OauthIntegrationForCustomClientsState state, CustomResourceOptions options)resources:  _:    type: snowflake:OauthIntegrationForCustomClients    get:      id: ${id}- 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.
- BlockedRoles List<string>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- Comment string
- Specifies a comment for the OAuth integration.
- DescribeOutputs List<OauthIntegration For Custom Clients Describe Output> 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- Enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NetworkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- OauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthClient stringRsa Public Key 
- OauthClient stringRsa Public Key2 
- OauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- OauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- OauthRefresh intToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- OauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<string>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- 
List<OauthIntegration For Custom Clients Related Parameter> 
- Parameters related to this security integration.
- ShowOutputs List<OauthIntegration For Custom Clients Show Output> 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- BlockedRoles []stringLists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- Comment string
- Specifies a comment for the OAuth integration.
- DescribeOutputs []OauthIntegration For Custom Clients Describe Output Args 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- Enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NetworkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- OauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthClient stringRsa Public Key 
- OauthClient stringRsa Public Key2 
- OauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- OauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- OauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- OauthRefresh intToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- OauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- []string
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- 
[]OauthIntegration For Custom Clients Related Parameter Args 
- Parameters related to this security integration.
- ShowOutputs []OauthIntegration For Custom Clients Show Output Args 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- blockedRoles List<String>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment String
- Specifies a comment for the OAuth integration.
- describeOutputs List<OauthIntegration For Custom Clients Describe Output> 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- enabled String
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy String
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow StringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient StringRsa Public Key 
- oauthClient StringRsa Public Key2 
- oauthClient StringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthEnforce StringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue StringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRedirect StringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- oauthRefresh IntegerToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse StringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<String>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- 
List<OauthIntegration For Custom Clients Related Parameter> 
- Parameters related to this security integration.
- showOutputs List<OauthIntegration For Custom Clients Show Output> 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- blockedRoles string[]Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment string
- Specifies a comment for the OAuth integration.
- describeOutputs OauthIntegration For Custom Clients Describe Output[] 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- enabled string
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- fullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- name string
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy string
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow stringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient stringRsa Public Key 
- oauthClient stringRsa Public Key2 
- oauthClient stringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthEnforce stringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue stringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRedirect stringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- oauthRefresh numberToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse stringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- string[]
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- 
OauthIntegration For Custom Clients Related Parameter[] 
- Parameters related to this security integration.
- showOutputs OauthIntegration For Custom Clients Show Output[] 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- blocked_roles_ Sequence[str]lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment str
- Specifies a comment for the OAuth integration.
- describe_outputs Sequence[OauthIntegration For Custom Clients Describe Output Args] 
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- enabled str
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- fully_qualified_ strname 
- Fully qualified name of the resource. For more information, see object name resolution.
- name str
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- network_policy str
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauth_allow_ strnon_ tls_ redirect_ uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_client_ strrsa_ public_ key 
- oauth_client_ strrsa_ public_ key2 
- oauth_client_ strtype 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauth_enforce_ strpkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_issue_ strrefresh_ tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauth_redirect_ struri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- oauth_refresh_ inttoken_ validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauth_use_ strsecondary_ roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- Sequence[str]
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- 
Sequence[OauthIntegration For Custom Clients Related Parameter Args] 
- Parameters related to this security integration.
- show_outputs Sequence[OauthIntegration For Custom Clients Show Output Args] 
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
- blockedRoles List<String>Lists 
- A set of Snowflake roles that a user cannot explicitly consent to using after authenticating. By default, this list includes the ACCOUNTADMIN, ORGADMIN and SECURITYADMIN roles. To remove these privileged roles from the list, use the ALTER ACCOUNT command to set the OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST account parameter to FALSE. For more information about this resource, see docs.
- comment String
- Specifies a comment for the OAuth integration.
- describeOutputs List<Property Map>
- Outputs the result of DESCRIBE SECURITY INTEGRATIONfor the given integration.
- enabled String
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this OAuth integration is enabled or disabled. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- name String
- Specifies the name of the OAuth integration. This name follows the rules for Object Identifiers. The name should be unique among security integrations in your account. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- networkPolicy String
- Specifies an existing network policy. This network policy controls network traffic that is attempting to exchange an authorization code for an access or refresh token or to use a refresh token to obtain a new access token. For more information about this resource, see docs.
- oauthAllow StringNon Tls Redirect Uri 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) If true, allows setting oauthredirecturi to a URI not protected by TLS. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthClient StringRsa Public Key 
- oauthClient StringRsa Public Key2 
- oauthClient StringType 
- Specifies the type of client being registered. Snowflake supports both confidential and public clients. Valid options are: PUBLIC|CONFIDENTIAL.
- oauthEnforce StringPkce 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether Proof Key for Code Exchange (PKCE) should be required for the integration. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthIssue StringRefresh Tokens 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to allow the client to exchange a refresh token for an access token when the current access token has expired. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- oauthRedirect StringUri 
- Specifies the client URI. After a user is authenticated, the web browser is redirected to this URI.
- oauthRefresh NumberToken Validity 
- (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (-1)) Specifies how long refresh tokens should be valid (in seconds). OAUTHISSUEREFRESH_TOKENS must be set to TRUE.
- oauthUse StringSecondary Roles 
- Specifies whether default secondary roles set in the user properties are activated by default in the session being opened. Valid options are: IMPLICIT|NONE.
- List<String>
- A set of Snowflake roles that a user does not need to explicitly consent to using after authenticating. For more information about this resource, see docs.
- List<Property Map>
- Parameters related to this security integration.
- showOutputs List<Property Map>
- Outputs the result of SHOW SECURITY INTEGRATIONfor the given integration.
Supporting Types
OauthIntegrationForCustomClientsDescribeOutput, OauthIntegrationForCustomClientsDescribeOutputArgs              
- BlockedRoles List<OauthLists Integration For Custom Clients Describe Output Blocked Roles List> 
- Comments
List<OauthIntegration For Custom Clients Describe Output Comment> 
- Enableds
List<OauthIntegration For Custom Clients Describe Output Enabled> 
- NetworkPolicies List<OauthIntegration For Custom Clients Describe Output Network Policy> 
- OauthAllow List<OauthNon Tls Redirect Uris Integration For Custom Clients Describe Output Oauth Allow Non Tls Redirect Uri> 
- 
List<OauthIntegration For Custom Clients Describe Output Oauth Allowed Authorization Endpoint> 
- OauthAllowed List<OauthToken Endpoints Integration For Custom Clients Describe Output Oauth Allowed Token Endpoint> 
- 
List<OauthIntegration For Custom Clients Describe Output Oauth Authorization Endpoint> 
- OauthClient List<OauthIds Integration For Custom Clients Describe Output Oauth Client Id> 
- OauthClient List<OauthRsa Public Key2Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key2Fp> 
- OauthClient List<OauthRsa Public Key Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key Fp> 
- OauthClient List<OauthTypes Integration For Custom Clients Describe Output Oauth Client Type> 
- OauthEnforce List<OauthPkces Integration For Custom Clients Describe Output Oauth Enforce Pkce> 
- OauthIssue List<OauthRefresh Tokens Integration For Custom Clients Describe Output Oauth Issue Refresh Token> 
- OauthRedirect List<OauthUris Integration For Custom Clients Describe Output Oauth Redirect Uri> 
- OauthRefresh List<OauthToken Validities Integration For Custom Clients Describe Output Oauth Refresh Token Validity> 
- OauthToken List<OauthEndpoints Integration For Custom Clients Describe Output Oauth Token Endpoint> 
- OauthUse List<OauthSecondary Roles Integration For Custom Clients Describe Output Oauth Use Secondary Role> 
- 
List<OauthIntegration For Custom Clients Describe Output Pre Authorized Roles List> 
- BlockedRoles []OauthLists Integration For Custom Clients Describe Output Blocked Roles List 
- Comments
[]OauthIntegration For Custom Clients Describe Output Comment 
- Enableds
[]OauthIntegration For Custom Clients Describe Output Enabled 
- NetworkPolicies []OauthIntegration For Custom Clients Describe Output Network Policy 
- OauthAllow []OauthNon Tls Redirect Uris Integration For Custom Clients Describe Output Oauth Allow Non Tls Redirect Uri 
- 
[]OauthIntegration For Custom Clients Describe Output Oauth Allowed Authorization Endpoint 
- OauthAllowed []OauthToken Endpoints Integration For Custom Clients Describe Output Oauth Allowed Token Endpoint 
- 
[]OauthIntegration For Custom Clients Describe Output Oauth Authorization Endpoint 
- OauthClient []OauthIds Integration For Custom Clients Describe Output Oauth Client Id 
- OauthClient []OauthRsa Public Key2Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key2Fp 
- OauthClient []OauthRsa Public Key Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key Fp 
- OauthClient []OauthTypes Integration For Custom Clients Describe Output Oauth Client Type 
- OauthEnforce []OauthPkces Integration For Custom Clients Describe Output Oauth Enforce Pkce 
- OauthIssue []OauthRefresh Tokens Integration For Custom Clients Describe Output Oauth Issue Refresh Token 
- OauthRedirect []OauthUris Integration For Custom Clients Describe Output Oauth Redirect Uri 
- OauthRefresh []OauthToken Validities Integration For Custom Clients Describe Output Oauth Refresh Token Validity 
- OauthToken []OauthEndpoints Integration For Custom Clients Describe Output Oauth Token Endpoint 
- OauthUse []OauthSecondary Roles Integration For Custom Clients Describe Output Oauth Use Secondary Role 
- 
[]OauthIntegration For Custom Clients Describe Output Pre Authorized Roles List 
- blockedRoles List<OauthLists Integration For Custom Clients Describe Output Blocked Roles List> 
- comments
List<OauthIntegration For Custom Clients Describe Output Comment> 
- enableds
List<OauthIntegration For Custom Clients Describe Output Enabled> 
- networkPolicies List<OauthIntegration For Custom Clients Describe Output Network Policy> 
- oauthAllow List<OauthNon Tls Redirect Uris Integration For Custom Clients Describe Output Oauth Allow Non Tls Redirect Uri> 
- 
List<OauthIntegration For Custom Clients Describe Output Oauth Allowed Authorization Endpoint> 
- oauthAllowed List<OauthToken Endpoints Integration For Custom Clients Describe Output Oauth Allowed Token Endpoint> 
- 
List<OauthIntegration For Custom Clients Describe Output Oauth Authorization Endpoint> 
- oauthClient List<OauthIds Integration For Custom Clients Describe Output Oauth Client Id> 
- oauthClient List<OauthRsa Public Key2Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key2Fp> 
- oauthClient List<OauthRsa Public Key Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key Fp> 
- oauthClient List<OauthTypes Integration For Custom Clients Describe Output Oauth Client Type> 
- oauthEnforce List<OauthPkces Integration For Custom Clients Describe Output Oauth Enforce Pkce> 
- oauthIssue List<OauthRefresh Tokens Integration For Custom Clients Describe Output Oauth Issue Refresh Token> 
- oauthRedirect List<OauthUris Integration For Custom Clients Describe Output Oauth Redirect Uri> 
- oauthRefresh List<OauthToken Validities Integration For Custom Clients Describe Output Oauth Refresh Token Validity> 
- oauthToken List<OauthEndpoints Integration For Custom Clients Describe Output Oauth Token Endpoint> 
- oauthUse List<OauthSecondary Roles Integration For Custom Clients Describe Output Oauth Use Secondary Role> 
- 
List<OauthIntegration For Custom Clients Describe Output Pre Authorized Roles List> 
- blockedRoles OauthLists Integration For Custom Clients Describe Output Blocked Roles List[] 
- comments
OauthIntegration For Custom Clients Describe Output Comment[] 
- enableds
OauthIntegration For Custom Clients Describe Output Enabled[] 
- networkPolicies OauthIntegration For Custom Clients Describe Output Network Policy[] 
- oauthAllow OauthNon Tls Redirect Uris Integration For Custom Clients Describe Output Oauth Allow Non Tls Redirect Uri[] 
- 
OauthIntegration For Custom Clients Describe Output Oauth Allowed Authorization Endpoint[] 
- oauthAllowed OauthToken Endpoints Integration For Custom Clients Describe Output Oauth Allowed Token Endpoint[] 
- 
OauthIntegration For Custom Clients Describe Output Oauth Authorization Endpoint[] 
- oauthClient OauthIds Integration For Custom Clients Describe Output Oauth Client Id[] 
- oauthClient OauthRsa Public Key2Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key2Fp[] 
- oauthClient OauthRsa Public Key Fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key Fp[] 
- oauthClient OauthTypes Integration For Custom Clients Describe Output Oauth Client Type[] 
- oauthEnforce OauthPkces Integration For Custom Clients Describe Output Oauth Enforce Pkce[] 
- oauthIssue OauthRefresh Tokens Integration For Custom Clients Describe Output Oauth Issue Refresh Token[] 
- oauthRedirect OauthUris Integration For Custom Clients Describe Output Oauth Redirect Uri[] 
- oauthRefresh OauthToken Validities Integration For Custom Clients Describe Output Oauth Refresh Token Validity[] 
- oauthToken OauthEndpoints Integration For Custom Clients Describe Output Oauth Token Endpoint[] 
- oauthUse OauthSecondary Roles Integration For Custom Clients Describe Output Oauth Use Secondary Role[] 
- 
OauthIntegration For Custom Clients Describe Output Pre Authorized Roles List[] 
- blocked_roles_ Sequence[Oauthlists Integration For Custom Clients Describe Output Blocked Roles List] 
- comments
Sequence[OauthIntegration For Custom Clients Describe Output Comment] 
- enableds
Sequence[OauthIntegration For Custom Clients Describe Output Enabled] 
- network_policies Sequence[OauthIntegration For Custom Clients Describe Output Network Policy] 
- oauth_allow_ Sequence[Oauthnon_ tls_ redirect_ uris Integration For Custom Clients Describe Output Oauth Allow Non Tls Redirect Uri] 
- 
Sequence[OauthIntegration For Custom Clients Describe Output Oauth Allowed Authorization Endpoint] 
- oauth_allowed_ Sequence[Oauthtoken_ endpoints Integration For Custom Clients Describe Output Oauth Allowed Token Endpoint] 
- 
Sequence[OauthIntegration For Custom Clients Describe Output Oauth Authorization Endpoint] 
- oauth_client_ Sequence[Oauthids Integration For Custom Clients Describe Output Oauth Client Id] 
- oauth_client_ Sequence[Oauthrsa_ public_ key2_ fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key2Fp] 
- oauth_client_ Sequence[Oauthrsa_ public_ key_ fps Integration For Custom Clients Describe Output Oauth Client Rsa Public Key Fp] 
- oauth_client_ Sequence[Oauthtypes Integration For Custom Clients Describe Output Oauth Client Type] 
- oauth_enforce_ Sequence[Oauthpkces Integration For Custom Clients Describe Output Oauth Enforce Pkce] 
- oauth_issue_ Sequence[Oauthrefresh_ tokens Integration For Custom Clients Describe Output Oauth Issue Refresh Token] 
- oauth_redirect_ Sequence[Oauthuris Integration For Custom Clients Describe Output Oauth Redirect Uri] 
- oauth_refresh_ Sequence[Oauthtoken_ validities Integration For Custom Clients Describe Output Oauth Refresh Token Validity] 
- oauth_token_ Sequence[Oauthendpoints Integration For Custom Clients Describe Output Oauth Token Endpoint] 
- oauth_use_ Sequence[Oauthsecondary_ roles Integration For Custom Clients Describe Output Oauth Use Secondary Role] 
- 
Sequence[OauthIntegration For Custom Clients Describe Output Pre Authorized Roles List] 
- blockedRoles List<Property Map>Lists 
- comments List<Property Map>
- enableds List<Property Map>
- networkPolicies List<Property Map>
- oauthAllow List<Property Map>Non Tls Redirect Uris 
- List<Property Map>
- oauthAllowed List<Property Map>Token Endpoints 
- List<Property Map>
- oauthClient List<Property Map>Ids 
- oauthClient List<Property Map>Rsa Public Key2Fps 
- oauthClient List<Property Map>Rsa Public Key Fps 
- oauthClient List<Property Map>Types 
- oauthEnforce List<Property Map>Pkces 
- oauthIssue List<Property Map>Refresh Tokens 
- oauthRedirect List<Property Map>Uris 
- oauthRefresh List<Property Map>Token Validities 
- oauthToken List<Property Map>Endpoints 
- oauthUse List<Property Map>Secondary Roles 
- List<Property Map>
OauthIntegrationForCustomClientsDescribeOutputBlockedRolesList, OauthIntegrationForCustomClientsDescribeOutputBlockedRolesListArgs                    
OauthIntegrationForCustomClientsDescribeOutputComment, OauthIntegrationForCustomClientsDescribeOutputCommentArgs                
OauthIntegrationForCustomClientsDescribeOutputEnabled, OauthIntegrationForCustomClientsDescribeOutputEnabledArgs                
OauthIntegrationForCustomClientsDescribeOutputNetworkPolicy, OauthIntegrationForCustomClientsDescribeOutputNetworkPolicyArgs                  
OauthIntegrationForCustomClientsDescribeOutputOauthAllowNonTlsRedirectUri, OauthIntegrationForCustomClientsDescribeOutputOauthAllowNonTlsRedirectUriArgs                          
OauthIntegrationForCustomClientsDescribeOutputOauthAllowedAuthorizationEndpoint, OauthIntegrationForCustomClientsDescribeOutputOauthAllowedAuthorizationEndpointArgs                      
OauthIntegrationForCustomClientsDescribeOutputOauthAllowedTokenEndpoint, OauthIntegrationForCustomClientsDescribeOutputOauthAllowedTokenEndpointArgs                      
OauthIntegrationForCustomClientsDescribeOutputOauthAuthorizationEndpoint, OauthIntegrationForCustomClientsDescribeOutputOauthAuthorizationEndpointArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthClientId, OauthIntegrationForCustomClientsDescribeOutputOauthClientIdArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthClientRsaPublicKey2Fp, OauthIntegrationForCustomClientsDescribeOutputOauthClientRsaPublicKey2FpArgs                        
OauthIntegrationForCustomClientsDescribeOutputOauthClientRsaPublicKeyFp, OauthIntegrationForCustomClientsDescribeOutputOauthClientRsaPublicKeyFpArgs                          
OauthIntegrationForCustomClientsDescribeOutputOauthClientType, OauthIntegrationForCustomClientsDescribeOutputOauthClientTypeArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthEnforcePkce, OauthIntegrationForCustomClientsDescribeOutputOauthEnforcePkceArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthIssueRefreshToken, OauthIntegrationForCustomClientsDescribeOutputOauthIssueRefreshTokenArgs                      
OauthIntegrationForCustomClientsDescribeOutputOauthRedirectUri, OauthIntegrationForCustomClientsDescribeOutputOauthRedirectUriArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthRefreshTokenValidity, OauthIntegrationForCustomClientsDescribeOutputOauthRefreshTokenValidityArgs                      
OauthIntegrationForCustomClientsDescribeOutputOauthTokenEndpoint, OauthIntegrationForCustomClientsDescribeOutputOauthTokenEndpointArgs                    
OauthIntegrationForCustomClientsDescribeOutputOauthUseSecondaryRole, OauthIntegrationForCustomClientsDescribeOutputOauthUseSecondaryRoleArgs                      
OauthIntegrationForCustomClientsDescribeOutputPreAuthorizedRolesList, OauthIntegrationForCustomClientsDescribeOutputPreAuthorizedRolesListArgs                      
OauthIntegrationForCustomClientsRelatedParameter, OauthIntegrationForCustomClientsRelatedParameterArgs              
OauthIntegrationForCustomClientsRelatedParameterOauthAddPrivilegedRolesToBlockedList, OauthIntegrationForCustomClientsRelatedParameterOauthAddPrivilegedRolesToBlockedListArgs                            
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
OauthIntegrationForCustomClientsShowOutput, OauthIntegrationForCustomClientsShowOutputArgs              
- category str
- comment str
- created_on str
- enabled bool
- integration_type str
- name str
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the snowflakeTerraform Provider.