snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/apiAuthenticationIntegrationWithAuthorizationCodeGrant:ApiAuthenticationIntegrationWithAuthorizationCodeGrant example "name"
Create ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiAuthenticationIntegrationWithAuthorizationCodeGrant(name: string, args: ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs, opts?: CustomResourceOptions);
@overload
def ApiAuthenticationIntegrationWithAuthorizationCodeGrant(resource_name: str,
args: ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiAuthenticationIntegrationWithAuthorizationCodeGrant(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
oauth_client_id: Optional[str] = None,
oauth_client_secret: Optional[str] = None,
comment: Optional[str] = None,
name: Optional[str] = None,
oauth_access_token_validity: Optional[int] = None,
oauth_allowed_scopes: Optional[Sequence[str]] = None,
oauth_authorization_endpoint: Optional[str] = None,
oauth_client_auth_method: Optional[str] = None,
oauth_refresh_token_validity: Optional[int] = None,
oauth_token_endpoint: Optional[str] = None)
func NewApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx *Context, name string, args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithAuthorizationCodeGrant, error)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(string name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args, CustomResourceOptions? opts = null)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(String name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args)
public ApiAuthenticationIntegrationWithAuthorizationCodeGrant(String name, ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs args, CustomResourceOptions options)
type: snowflake:ApiAuthenticationIntegrationWithAuthorizationCodeGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
- 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 ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new Snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", new()
{
Enabled = false,
OauthClientId = "string",
OauthClientSecret = "string",
Comment = "string",
Name = "string",
OauthAccessTokenValidity = 0,
OauthAllowedScopes = new[]
{
"string",
},
OauthAuthorizationEndpoint = "string",
OauthClientAuthMethod = "string",
OauthRefreshTokenValidity = 0,
OauthTokenEndpoint = "string",
});
example, err := snowflake.NewApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx, "apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", &snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs{
Enabled: pulumi.Bool(false),
OauthClientId: pulumi.String("string"),
OauthClientSecret: pulumi.String("string"),
Comment: pulumi.String("string"),
Name: pulumi.String("string"),
OauthAccessTokenValidity: pulumi.Int(0),
OauthAllowedScopes: pulumi.StringArray{
pulumi.String("string"),
},
OauthAuthorizationEndpoint: pulumi.String("string"),
OauthClientAuthMethod: pulumi.String("string"),
OauthRefreshTokenValidity: pulumi.Int(0),
OauthTokenEndpoint: pulumi.String("string"),
})
var apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", ApiAuthenticationIntegrationWithAuthorizationCodeGrantArgs.builder()
.enabled(false)
.oauthClientId("string")
.oauthClientSecret("string")
.comment("string")
.name("string")
.oauthAccessTokenValidity(0)
.oauthAllowedScopes("string")
.oauthAuthorizationEndpoint("string")
.oauthClientAuthMethod("string")
.oauthRefreshTokenValidity(0)
.oauthTokenEndpoint("string")
.build());
api_authentication_integration_with_authorization_code_grant_resource = snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource",
enabled=False,
oauth_client_id="string",
oauth_client_secret="string",
comment="string",
name="string",
oauth_access_token_validity=0,
oauth_allowed_scopes=["string"],
oauth_authorization_endpoint="string",
oauth_client_auth_method="string",
oauth_refresh_token_validity=0,
oauth_token_endpoint="string")
const apiAuthenticationIntegrationWithAuthorizationCodeGrantResource = new snowflake.ApiAuthenticationIntegrationWithAuthorizationCodeGrant("apiAuthenticationIntegrationWithAuthorizationCodeGrantResource", {
enabled: false,
oauthClientId: "string",
oauthClientSecret: "string",
comment: "string",
name: "string",
oauthAccessTokenValidity: 0,
oauthAllowedScopes: ["string"],
oauthAuthorizationEndpoint: "string",
oauthClientAuthMethod: "string",
oauthRefreshTokenValidity: 0,
oauthTokenEndpoint: "string",
});
type: snowflake:ApiAuthenticationIntegrationWithAuthorizationCodeGrant
properties:
comment: string
enabled: false
name: string
oauthAccessTokenValidity: 0
oauthAllowedScopes:
- string
oauthAuthorizationEndpoint: string
oauthClientAuthMethod: string
oauthClientId: string
oauthClientSecret: string
oauthRefreshTokenValidity: 0
oauthTokenEndpoint: string
ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource accepts the following input properties:
- Enabled bool
- Specifies whether this security integration is enabled or disabled.
- Oauth
Client stringId - Specifies the client ID for the OAuth application in the external service.
- Oauth
Client stringSecret - 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:
|
,.
,(
,)
,"
- Oauth
Access intToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- Oauth
Allowed List<string>Scopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- Oauth
Client stringAuth Method - 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 intToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- Oauth
Token stringEndpoint - 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 stringId - Specifies the client ID for the OAuth application in the external service.
- Oauth
Client stringSecret - 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:
|
,.
,(
,)
,"
- Oauth
Access intToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- Oauth
Allowed []stringScopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- Oauth
Client stringAuth Method - 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 intToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- Oauth
Token stringEndpoint - 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.
- oauth
Client StringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client StringSecret - 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:
|
,.
,(
,)
,"
- oauth
Access IntegerToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed List<String>Scopes - 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.
- String
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client StringAuth Method - 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 IntegerToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token StringEndpoint - 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.
- oauth
Client stringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client stringSecret - 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:
|
,.
,(
,)
,"
- oauth
Access numberToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed string[]Scopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client stringAuth Method - 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 numberToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token stringEndpoint - 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_ strid - Specifies the client ID for the OAuth application in the external service.
- oauth_
client_ strsecret - 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_ inttoken_ validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth_
allowed_ Sequence[str]scopes - 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.
- str
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth_
client_ strauth_ method - 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_ inttoken_ validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth_
token_ strendpoint - 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.
- oauth
Client StringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client StringSecret - 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:
|
,.
,(
,)
,"
- oauth
Access NumberToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed List<String>Scopes - 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.
- String
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client StringAuth Method - 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 NumberToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token StringEndpoint - Specifies the token endpoint used by the client to obtain an access token by presenting its authorization grant or refresh token. The token endpoint is used with every authorization grant except for the implicit grant type (since an access token is issued directly). If removed from the config, the resource is recreated.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource produces the following output properties:
- Describe
Outputs List<ApiAuthentication Integration With Authorization Code Grant Describe Output> - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - Fully
Qualified 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.
- Show
Outputs List<ApiAuthentication Integration With Authorization Code Grant Show Output> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- Describe
Outputs []ApiAuthentication Integration With Authorization Code Grant Describe Output - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - Fully
Qualified 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.
- Show
Outputs []ApiAuthentication Integration With Authorization Code Grant Show Output - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- describe
Outputs List<ApiAuthentication Integration With Authorization Code Grant Describe Output> - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - fully
Qualified 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.
- show
Outputs List<ApiAuthentication Integration With Authorization Code Grant Show Output> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- describe
Outputs ApiAuthentication Integration With Authorization Code Grant Describe Output[] - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - fully
Qualified 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.
- show
Outputs ApiAuthentication Integration With Authorization Code Grant Show Output[] - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- describe_
outputs Sequence[ApiAuthentication Integration With Authorization Code Grant Describe Output] - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security 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.
- show_
outputs Sequence[ApiAuthentication Integration With Authorization Code Grant Show Output] - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - fully
Qualified 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.
- show
Outputs List<Property Map> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
Look up Existing ApiAuthenticationIntegrationWithAuthorizationCodeGrant Resource
Get an existing ApiAuthenticationIntegrationWithAuthorizationCodeGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApiAuthenticationIntegrationWithAuthorizationCodeGrantState, opts?: CustomResourceOptions): ApiAuthenticationIntegrationWithAuthorizationCodeGrant
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
describe_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs]] = None,
enabled: Optional[bool] = None,
fully_qualified_name: Optional[str] = None,
name: Optional[str] = None,
oauth_access_token_validity: Optional[int] = None,
oauth_allowed_scopes: Optional[Sequence[str]] = None,
oauth_authorization_endpoint: Optional[str] = None,
oauth_client_auth_method: Optional[str] = None,
oauth_client_id: Optional[str] = None,
oauth_client_secret: Optional[str] = None,
oauth_refresh_token_validity: Optional[int] = None,
oauth_token_endpoint: Optional[str] = None,
show_outputs: Optional[Sequence[ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs]] = None) -> ApiAuthenticationIntegrationWithAuthorizationCodeGrant
func GetApiAuthenticationIntegrationWithAuthorizationCodeGrant(ctx *Context, name string, id IDInput, state *ApiAuthenticationIntegrationWithAuthorizationCodeGrantState, opts ...ResourceOption) (*ApiAuthenticationIntegrationWithAuthorizationCodeGrant, error)
public static ApiAuthenticationIntegrationWithAuthorizationCodeGrant Get(string name, Input<string> id, ApiAuthenticationIntegrationWithAuthorizationCodeGrantState? state, CustomResourceOptions? opts = null)
public static ApiAuthenticationIntegrationWithAuthorizationCodeGrant get(String name, Output<String> id, ApiAuthenticationIntegrationWithAuthorizationCodeGrantState state, CustomResourceOptions options)
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.
- Comment string
- Specifies a comment for the integration.
- Describe
Outputs List<ApiAuthentication Integration With Authorization Code Grant Describe Output> - 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 stringName - 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:
|
,.
,(
,)
,"
- Oauth
Access intToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- Oauth
Allowed List<string>Scopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- Oauth
Client stringAuth Method - 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 stringId - Specifies the client ID for the OAuth application in the external service.
- Oauth
Client stringSecret - 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 intToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- Oauth
Token stringEndpoint - 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 List<ApiAuthentication Integration With Authorization Code Grant Show Output> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- Comment string
- Specifies a comment for the integration.
- Describe
Outputs []ApiAuthentication Integration With Authorization Code Grant Describe Output Args - 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 stringName - 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:
|
,.
,(
,)
,"
- Oauth
Access intToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- Oauth
Allowed []stringScopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- Oauth
Client stringAuth Method - 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 stringId - Specifies the client ID for the OAuth application in the external service.
- Oauth
Client stringSecret - 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 intToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- Oauth
Token stringEndpoint - 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 []ApiAuthentication Integration With Authorization Code Grant Show Output Args - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- comment String
- Specifies a comment for the integration.
- describe
Outputs List<ApiAuthentication Integration With Authorization Code Grant Describe Output> - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - enabled Boolean
- Specifies whether this security integration is enabled or disabled.
- fully
Qualified StringName - 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:
|
,.
,(
,)
,"
- oauth
Access IntegerToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed List<String>Scopes - 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.
- String
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client StringAuth Method - 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 StringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client StringSecret - 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 IntegerToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token StringEndpoint - 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 List<ApiAuthentication Integration With Authorization Code Grant Show Output> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- comment string
- Specifies a comment for the integration.
- describe
Outputs ApiAuthentication Integration With Authorization Code Grant Describe Output[] - Outputs the result of
DESCRIBE SECURITY INTEGRATIONS
for the given security integration. - enabled boolean
- Specifies whether this security integration is enabled or disabled.
- fully
Qualified stringName - 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:
|
,.
,(
,)
,"
- oauth
Access numberToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed string[]Scopes - 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.
- string
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client stringAuth Method - 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 stringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client stringSecret - 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 numberToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token stringEndpoint - 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 ApiAuthentication Integration With Authorization Code Grant Show Output[] - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- comment str
- Specifies a comment for the integration.
- describe_
outputs Sequence[ApiAuthentication Integration With Authorization Code Grant Describe Output Args] - 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_ strname - 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_ inttoken_ validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth_
allowed_ Sequence[str]scopes - 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.
- str
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth_
client_ strauth_ method - 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_ strid - Specifies the client ID for the OAuth application in the external service.
- oauth_
client_ strsecret - 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_ inttoken_ validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth_
token_ strendpoint - 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[ApiAuthentication Integration With Authorization Code Grant Show Output Args] - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
- comment String
- Specifies a comment for the integration.
- describe
Outputs 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.
- fully
Qualified StringName - 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:
|
,.
,(
,)
,"
- oauth
Access NumberToken Validity - Specifies the default lifetime of the OAuth access token (in seconds) issued by an OAuth server.
- oauth
Allowed List<String>Scopes - 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.
- String
- Specifies the URL for authenticating to the external service. If removed from the config, the resource is recreated.
- oauth
Client StringAuth Method - 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 StringId - Specifies the client ID for the OAuth application in the external service.
- oauth
Client StringSecret - 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 NumberToken Validity - Specifies the value to determine the validity of the refresh token obtained from the OAuth server.
- oauth
Token StringEndpoint - 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 List<Property Map> - Outputs the result of
SHOW SECURITY INTEGRATIONS
for the given security integration.
Supporting Types
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutput, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputArgs
- Auth
Types List<ApiAuthentication Integration With Authorization Code Grant Describe Output Auth Type> - Comments
List<Api
Authentication Integration With Authorization Code Grant Describe Output Comment> - Enableds
List<Api
Authentication Integration With Authorization Code Grant Describe Output Enabled> - Oauth
Access List<ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Access Token Validity> - Oauth
Allowed List<ApiScopes Authentication Integration With Authorization Code Grant Describe Output Oauth Allowed Scope> - List<Api
Authentication Integration With Authorization Code Grant Describe Output Oauth Authorization Endpoint> - Oauth
Client List<ApiAuth Methods Authentication Integration With Authorization Code Grant Describe Output Oauth Client Auth Method> - Oauth
Client List<ApiIds Authentication Integration With Authorization Code Grant Describe Output Oauth Client Id> - Oauth
Grants List<ApiAuthentication Integration With Authorization Code Grant Describe Output Oauth Grant> - Oauth
Refresh List<ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Refresh Token Validity> - Oauth
Token List<ApiEndpoints Authentication Integration With Authorization Code Grant Describe Output Oauth Token Endpoint> - Parent
Integrations List<ApiAuthentication Integration With Authorization Code Grant Describe Output Parent Integration>
- Auth
Types []ApiAuthentication Integration With Authorization Code Grant Describe Output Auth Type - Comments
[]Api
Authentication Integration With Authorization Code Grant Describe Output Comment - Enableds
[]Api
Authentication Integration With Authorization Code Grant Describe Output Enabled - Oauth
Access []ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Access Token Validity - Oauth
Allowed []ApiScopes Authentication Integration With Authorization Code Grant Describe Output Oauth Allowed Scope - []Api
Authentication Integration With Authorization Code Grant Describe Output Oauth Authorization Endpoint - Oauth
Client []ApiAuth Methods Authentication Integration With Authorization Code Grant Describe Output Oauth Client Auth Method - Oauth
Client []ApiIds Authentication Integration With Authorization Code Grant Describe Output Oauth Client Id - Oauth
Grants []ApiAuthentication Integration With Authorization Code Grant Describe Output Oauth Grant - Oauth
Refresh []ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Refresh Token Validity - Oauth
Token []ApiEndpoints Authentication Integration With Authorization Code Grant Describe Output Oauth Token Endpoint - Parent
Integrations []ApiAuthentication Integration With Authorization Code Grant Describe Output Parent Integration
- auth
Types List<ApiAuthentication Integration With Authorization Code Grant Describe Output Auth Type> - comments
List<Api
Authentication Integration With Authorization Code Grant Describe Output Comment> - enableds
List<Api
Authentication Integration With Authorization Code Grant Describe Output Enabled> - oauth
Access List<ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Access Token Validity> - oauth
Allowed List<ApiScopes Authentication Integration With Authorization Code Grant Describe Output Oauth Allowed Scope> - List<Api
Authentication Integration With Authorization Code Grant Describe Output Oauth Authorization Endpoint> - oauth
Client List<ApiAuth Methods Authentication Integration With Authorization Code Grant Describe Output Oauth Client Auth Method> - oauth
Client List<ApiIds Authentication Integration With Authorization Code Grant Describe Output Oauth Client Id> - oauth
Grants List<ApiAuthentication Integration With Authorization Code Grant Describe Output Oauth Grant> - oauth
Refresh List<ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Refresh Token Validity> - oauth
Token List<ApiEndpoints Authentication Integration With Authorization Code Grant Describe Output Oauth Token Endpoint> - parent
Integrations List<ApiAuthentication Integration With Authorization Code Grant Describe Output Parent Integration>
- auth
Types ApiAuthentication Integration With Authorization Code Grant Describe Output Auth Type[] - comments
Api
Authentication Integration With Authorization Code Grant Describe Output Comment[] - enableds
Api
Authentication Integration With Authorization Code Grant Describe Output Enabled[] - oauth
Access ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Access Token Validity[] - oauth
Allowed ApiScopes Authentication Integration With Authorization Code Grant Describe Output Oauth Allowed Scope[] - Api
Authentication Integration With Authorization Code Grant Describe Output Oauth Authorization Endpoint[] - oauth
Client ApiAuth Methods Authentication Integration With Authorization Code Grant Describe Output Oauth Client Auth Method[] - oauth
Client ApiIds Authentication Integration With Authorization Code Grant Describe Output Oauth Client Id[] - oauth
Grants ApiAuthentication Integration With Authorization Code Grant Describe Output Oauth Grant[] - oauth
Refresh ApiToken Validities Authentication Integration With Authorization Code Grant Describe Output Oauth Refresh Token Validity[] - oauth
Token ApiEndpoints Authentication Integration With Authorization Code Grant Describe Output Oauth Token Endpoint[] - parent
Integrations ApiAuthentication Integration With Authorization Code Grant Describe Output Parent Integration[]
- auth_
types Sequence[ApiAuthentication Integration With Authorization Code Grant Describe Output Auth Type] - comments
Sequence[Api
Authentication Integration With Authorization Code Grant Describe Output Comment] - enableds
Sequence[Api
Authentication Integration With Authorization Code Grant Describe Output Enabled] - oauth_
access_ Sequence[Apitoken_ validities Authentication Integration With Authorization Code Grant Describe Output Oauth Access Token Validity] - oauth_
allowed_ Sequence[Apiscopes Authentication Integration With Authorization Code Grant Describe Output Oauth Allowed Scope] - Sequence[Api
Authentication Integration With Authorization Code Grant Describe Output Oauth Authorization Endpoint] - oauth_
client_ Sequence[Apiauth_ methods Authentication Integration With Authorization Code Grant Describe Output Oauth Client Auth Method] - oauth_
client_ Sequence[Apiids Authentication Integration With Authorization Code Grant Describe Output Oauth Client Id] - oauth_
grants Sequence[ApiAuthentication Integration With Authorization Code Grant Describe Output Oauth Grant] - oauth_
refresh_ Sequence[Apitoken_ validities Authentication Integration With Authorization Code Grant Describe Output Oauth Refresh Token Validity] - oauth_
token_ Sequence[Apiendpoints Authentication Integration With Authorization Code Grant Describe Output Oauth Token Endpoint] - parent_
integrations Sequence[ApiAuthentication Integration With Authorization Code Grant Describe Output Parent Integration]
- auth
Types List<Property Map> - comments List<Property Map>
- enableds List<Property Map>
- oauth
Access List<Property Map>Token Validities - oauth
Allowed List<Property Map>Scopes - List<Property Map>
- oauth
Client List<Property Map>Auth Methods - oauth
Client List<Property Map>Ids - oauth
Grants List<Property Map> - oauth
Refresh List<Property Map>Token Validities - oauth
Token List<Property Map>Endpoints - parent
Integrations List<Property Map>
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthType, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputAuthTypeArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputComment, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputCommentArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabled, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputEnabledArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidity, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAccessTokenValidityArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScope, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAllowedScopeArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpoint, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthAuthorizationEndpointArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethod, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientAuthMethodArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientId, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthClientIdArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrant, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthGrantArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidity, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthRefreshTokenValidityArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpoint, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputOauthTokenEndpointArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegration, ApiAuthenticationIntegrationWithAuthorizationCodeGrantDescribeOutputParentIntegrationArgs
ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutput, ApiAuthenticationIntegrationWithAuthorizationCodeGrantShowOutputArgs
- 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
snowflake
Terraform Provider.