published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Generic Email gateway connector and its configuration in a Descope project. Send emails using a generic Email gateway.
Create GenericEmailGatewayConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GenericEmailGatewayConnector(name: string, args: GenericEmailGatewayConnectorArgs, opts?: CustomResourceOptions);@overload
def GenericEmailGatewayConnector(resource_name: str,
args: GenericEmailGatewayConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GenericEmailGatewayConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
post_url: Optional[str] = None,
project_id: Optional[str] = None,
authentication: Optional[GenericEmailGatewayConnectorAuthenticationArgs] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
headers: Optional[Mapping[str, str]] = None,
hmac_secret: Optional[str] = None,
insecure: Optional[bool] = None,
name: Optional[str] = None,
secret_headers: Optional[Mapping[str, str]] = None,
sender: Optional[str] = None,
use_static_ips: Optional[bool] = None)func NewGenericEmailGatewayConnector(ctx *Context, name string, args GenericEmailGatewayConnectorArgs, opts ...ResourceOption) (*GenericEmailGatewayConnector, error)public GenericEmailGatewayConnector(string name, GenericEmailGatewayConnectorArgs args, CustomResourceOptions? opts = null)
public GenericEmailGatewayConnector(String name, GenericEmailGatewayConnectorArgs args)
public GenericEmailGatewayConnector(String name, GenericEmailGatewayConnectorArgs args, CustomResourceOptions options)
type: descope:GenericEmailGatewayConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_generic_email_gateway_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GenericEmailGatewayConnectorArgs
- 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 GenericEmailGatewayConnectorArgs
- 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 GenericEmailGatewayConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GenericEmailGatewayConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GenericEmailGatewayConnectorArgs
- 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 genericEmailGatewayConnectorResource = new Descope.GenericEmailGatewayConnector("genericEmailGatewayConnectorResource", new()
{
PostUrl = "string",
ProjectId = "string",
Authentication = new Descope.Inputs.GenericEmailGatewayConnectorAuthenticationArgs
{
ApiKey = new Descope.Inputs.GenericEmailGatewayConnectorAuthenticationApiKeyArgs
{
Key = "string",
Token = "string",
},
Basic = new Descope.Inputs.GenericEmailGatewayConnectorAuthenticationBasicArgs
{
Password = "string",
Username = "string",
},
BearerToken = "string",
Oauth2ClientCredentials = new Descope.Inputs.GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentialsArgs
{
AuthUrl = "string",
ClientId = "string",
ClientSecret = "string",
AuthStyle = "string",
Scopes = "string",
TokenRequestHeaders =
{
{ "string", "string" },
},
},
},
Description = "string",
Disabled = false,
Headers =
{
{ "string", "string" },
},
HmacSecret = "string",
Insecure = false,
Name = "string",
SecretHeaders =
{
{ "string", "string" },
},
Sender = "string",
UseStaticIps = false,
});
example, err := descope.NewGenericEmailGatewayConnector(ctx, "genericEmailGatewayConnectorResource", &descope.GenericEmailGatewayConnectorArgs{
PostUrl: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Authentication: &descope.GenericEmailGatewayConnectorAuthenticationArgs{
ApiKey: &descope.GenericEmailGatewayConnectorAuthenticationApiKeyArgs{
Key: pulumi.String("string"),
Token: pulumi.String("string"),
},
Basic: &descope.GenericEmailGatewayConnectorAuthenticationBasicArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
BearerToken: pulumi.String("string"),
Oauth2ClientCredentials: &descope.GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentialsArgs{
AuthUrl: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
AuthStyle: pulumi.String("string"),
Scopes: pulumi.String("string"),
TokenRequestHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
HmacSecret: pulumi.String("string"),
Insecure: pulumi.Bool(false),
Name: pulumi.String("string"),
SecretHeaders: pulumi.StringMap{
"string": pulumi.String("string"),
},
Sender: pulumi.String("string"),
UseStaticIps: pulumi.Bool(false),
})
resource "descope_generic_email_gateway_connector" "genericEmailGatewayConnectorResource" {
lifecycle {
create_before_destroy = true
}
post_url = "string"
project_id = "string"
authentication = {
api_key = {
key = "string"
token = "string"
}
basic = {
password = "string"
username = "string"
}
bearer_token = "string"
oauth2_client_credentials = {
auth_url = "string"
client_id = "string"
client_secret = "string"
auth_style = "string"
scopes = "string"
token_request_headers = {
"string" = "string"
}
}
}
description = "string"
disabled = false
headers = {
"string" = "string"
}
hmac_secret = "string"
insecure = false
name = "string"
secret_headers = {
"string" = "string"
}
sender = "string"
use_static_ips = false
}
var genericEmailGatewayConnectorResource = new GenericEmailGatewayConnector("genericEmailGatewayConnectorResource", GenericEmailGatewayConnectorArgs.builder()
.postUrl("string")
.projectId("string")
.authentication(GenericEmailGatewayConnectorAuthenticationArgs.builder()
.apiKey(GenericEmailGatewayConnectorAuthenticationApiKeyArgs.builder()
.key("string")
.token("string")
.build())
.basic(GenericEmailGatewayConnectorAuthenticationBasicArgs.builder()
.password("string")
.username("string")
.build())
.bearerToken("string")
.oauth2ClientCredentials(GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentialsArgs.builder()
.authUrl("string")
.clientId("string")
.clientSecret("string")
.authStyle("string")
.scopes("string")
.tokenRequestHeaders(Map.of("string", "string"))
.build())
.build())
.description("string")
.disabled(false)
.headers(Map.of("string", "string"))
.hmacSecret("string")
.insecure(false)
.name("string")
.secretHeaders(Map.of("string", "string"))
.sender("string")
.useStaticIps(false)
.build());
generic_email_gateway_connector_resource = descope.GenericEmailGatewayConnector("genericEmailGatewayConnectorResource",
post_url="string",
project_id="string",
authentication={
"api_key": {
"key": "string",
"token": "string",
},
"basic": {
"password": "string",
"username": "string",
},
"bearer_token": "string",
"oauth2_client_credentials": {
"auth_url": "string",
"client_id": "string",
"client_secret": "string",
"auth_style": "string",
"scopes": "string",
"token_request_headers": {
"string": "string",
},
},
},
description="string",
disabled=False,
headers={
"string": "string",
},
hmac_secret="string",
insecure=False,
name="string",
secret_headers={
"string": "string",
},
sender="string",
use_static_ips=False)
const genericEmailGatewayConnectorResource = new descope.GenericEmailGatewayConnector("genericEmailGatewayConnectorResource", {
postUrl: "string",
projectId: "string",
authentication: {
apiKey: {
key: "string",
token: "string",
},
basic: {
password: "string",
username: "string",
},
bearerToken: "string",
oauth2ClientCredentials: {
authUrl: "string",
clientId: "string",
clientSecret: "string",
authStyle: "string",
scopes: "string",
tokenRequestHeaders: {
string: "string",
},
},
},
description: "string",
disabled: false,
headers: {
string: "string",
},
hmacSecret: "string",
insecure: false,
name: "string",
secretHeaders: {
string: "string",
},
sender: "string",
useStaticIps: false,
});
type: descope:GenericEmailGatewayConnector
properties:
authentication:
apiKey:
key: string
token: string
basic:
password: string
username: string
bearerToken: string
oauth2ClientCredentials:
authStyle: string
authUrl: string
clientId: string
clientSecret: string
scopes: string
tokenRequestHeaders:
string: string
description: string
disabled: false
headers:
string: string
hmacSecret: string
insecure: false
name: string
postUrl: string
projectId: string
secretHeaders:
string: string
sender: string
useStaticIps: false
GenericEmailGatewayConnector 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 GenericEmailGatewayConnector resource accepts the following input properties:
- Post
Url string - The URL of the post email request
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Authentication
Descope.
Generic Email Gateway Connector Authentication - Authentication Information
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Headers Dictionary<string, string>
- The headers to send with the request
- Hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Insecure bool
- Will ignore certificate errors raised by the client
- Name string
- A custom name for your connector.
- Secret
Headers Dictionary<string, string> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- Sender string
- The sender address
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- Post
Url string - The URL of the post email request
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Authentication
Generic
Email Gateway Connector Authentication Args - Authentication Information
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Headers map[string]string
- The headers to send with the request
- Hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Insecure bool
- Will ignore certificate errors raised by the client
- Name string
- A custom name for your connector.
- Secret
Headers map[string]string - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- Sender string
- The sender address
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- post_
url string - The URL of the post email request
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- authentication object
- Authentication Information
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers map(string)
- The headers to send with the request
- hmac_
secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure bool
- Will ignore certificate errors raised by the client
- name string
- A custom name for your connector.
- secret_
headers map(string) - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender string
- The sender address
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- post
Url String - The URL of the post email request
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- authentication
Generic
Email Gateway Connector Authentication - Authentication Information
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Map<String,String>
- The headers to send with the request
- hmac
Secret String - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure Boolean
- Will ignore certificate errors raised by the client
- name String
- A custom name for your connector.
- secret
Headers Map<String,String> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender String
- The sender address
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- post
Url string - The URL of the post email request
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- authentication
Generic
Email Gateway Connector Authentication - Authentication Information
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers {[key: string]: string}
- The headers to send with the request
- hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure boolean
- Will ignore certificate errors raised by the client
- name string
- A custom name for your connector.
- secret
Headers {[key: string]: string} - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender string
- The sender address
- use
Static booleanIps - Whether the connector should send all requests from specific static IPs.
- post_
url str - The URL of the post email request
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- authentication
Generic
Email Gateway Connector Authentication Args - Authentication Information
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Mapping[str, str]
- The headers to send with the request
- hmac_
secret str - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure bool
- Will ignore certificate errors raised by the client
- name str
- A custom name for your connector.
- secret_
headers Mapping[str, str] - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender str
- The sender address
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- post
Url String - The URL of the post email request
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- authentication Property Map
- Authentication Information
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Map<String>
- The headers to send with the request
- hmac
Secret String - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure Boolean
- Will ignore certificate errors raised by the client
- name String
- A custom name for your connector.
- secret
Headers Map<String> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender String
- The sender address
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
Outputs
All input properties are implicitly available as output properties. Additionally, the GenericEmailGatewayConnector resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GenericEmailGatewayConnector Resource
Get an existing GenericEmailGatewayConnector 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?: GenericEmailGatewayConnectorState, opts?: CustomResourceOptions): GenericEmailGatewayConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication: Optional[GenericEmailGatewayConnectorAuthenticationArgs] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
headers: Optional[Mapping[str, str]] = None,
hmac_secret: Optional[str] = None,
insecure: Optional[bool] = None,
name: Optional[str] = None,
post_url: Optional[str] = None,
project_id: Optional[str] = None,
secret_headers: Optional[Mapping[str, str]] = None,
sender: Optional[str] = None,
use_static_ips: Optional[bool] = None) -> GenericEmailGatewayConnectorfunc GetGenericEmailGatewayConnector(ctx *Context, name string, id IDInput, state *GenericEmailGatewayConnectorState, opts ...ResourceOption) (*GenericEmailGatewayConnector, error)public static GenericEmailGatewayConnector Get(string name, Input<string> id, GenericEmailGatewayConnectorState? state, CustomResourceOptions? opts = null)public static GenericEmailGatewayConnector get(String name, Output<String> id, GenericEmailGatewayConnectorState state, CustomResourceOptions options)resources: existingGenericEmailGatewayConnector: type: descope:GenericEmailGatewayConnector get: id: ${id}import {
to = descope_generic_email_gateway_connector.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state GenericEmailGatewayConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GenericEmailGatewayConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state GenericEmailGatewayConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state GenericEmailGatewayConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Authentication
Descope.
Generic Email Gateway Connector Authentication - Authentication Information
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Headers Dictionary<string, string>
- The headers to send with the request
- Hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Insecure bool
- Will ignore certificate errors raised by the client
- Name string
- A custom name for your connector.
- Post
Url string - The URL of the post email request
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Secret
Headers Dictionary<string, string> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- Sender string
- The sender address
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- Authentication
Generic
Email Gateway Connector Authentication Args - Authentication Information
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Headers map[string]string
- The headers to send with the request
- Hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Insecure bool
- Will ignore certificate errors raised by the client
- Name string
- A custom name for your connector.
- Post
Url string - The URL of the post email request
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Secret
Headers map[string]string - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- Sender string
- The sender address
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- authentication object
- Authentication Information
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers map(string)
- The headers to send with the request
- hmac_
secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure bool
- Will ignore certificate errors raised by the client
- name string
- A custom name for your connector.
- post_
url string - The URL of the post email request
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- secret_
headers map(string) - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender string
- The sender address
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- authentication
Generic
Email Gateway Connector Authentication - Authentication Information
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Map<String,String>
- The headers to send with the request
- hmac
Secret String - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure Boolean
- Will ignore certificate errors raised by the client
- name String
- A custom name for your connector.
- post
Url String - The URL of the post email request
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- secret
Headers Map<String,String> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender String
- The sender address
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- authentication
Generic
Email Gateway Connector Authentication - Authentication Information
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers {[key: string]: string}
- The headers to send with the request
- hmac
Secret string - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure boolean
- Will ignore certificate errors raised by the client
- name string
- A custom name for your connector.
- post
Url string - The URL of the post email request
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- secret
Headers {[key: string]: string} - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender string
- The sender address
- use
Static booleanIps - Whether the connector should send all requests from specific static IPs.
- authentication
Generic
Email Gateway Connector Authentication Args - Authentication Information
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Mapping[str, str]
- The headers to send with the request
- hmac_
secret str - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure bool
- Will ignore certificate errors raised by the client
- name str
- A custom name for your connector.
- post_
url str - The URL of the post email request
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- secret_
headers Mapping[str, str] - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender str
- The sender address
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- authentication Property Map
- Authentication Information
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- headers Map<String>
- The headers to send with the request
- hmac
Secret String - HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the
x-descope-webhook-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - insecure Boolean
- Will ignore certificate errors raised by the client
- name String
- A custom name for your connector.
- post
Url String - The URL of the post email request
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- secret
Headers Map<String> - The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
- sender String
- The sender address
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
Supporting Types
GenericEmailGatewayConnectorAuthentication, GenericEmailGatewayConnectorAuthenticationArgs
- Api
Key Descope.Generic Email Gateway Connector Authentication Api Key - API key authentication configuration.
- Basic
Descope.
Generic Email Gateway Connector Authentication Basic - Basic authentication credentials (username and password).
- Bearer
Token string - Bearer token for HTTP authentication.
- Oauth2Client
Credentials Descope.Generic Email Gateway Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- Api
Key GenericEmail Gateway Connector Authentication Api Key - API key authentication configuration.
- Basic
Generic
Email Gateway Connector Authentication Basic - Basic authentication credentials (username and password).
- Bearer
Token string - Bearer token for HTTP authentication.
- Oauth2Client
Credentials GenericEmail Gateway Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api_
key object - API key authentication configuration.
- basic object
- Basic authentication credentials (username and password).
- bearer_
token string - Bearer token for HTTP authentication.
- oauth2_
client_ objectcredentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key GenericEmail Gateway Connector Authentication Api Key - API key authentication configuration.
- basic
Generic
Email Gateway Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer
Token String - Bearer token for HTTP authentication.
- oauth2Client
Credentials GenericEmail Gateway Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key GenericEmail Gateway Connector Authentication Api Key - API key authentication configuration.
- basic
Generic
Email Gateway Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer
Token string - Bearer token for HTTP authentication.
- oauth2Client
Credentials GenericEmail Gateway Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api_
key GenericEmail Gateway Connector Authentication Api Key - API key authentication configuration.
- basic
Generic
Email Gateway Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer_
token str - Bearer token for HTTP authentication.
- oauth2_
client_ Genericcredentials Email Gateway Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key Property Map - API key authentication configuration.
- basic Property Map
- Basic authentication credentials (username and password).
- bearer
Token String - Bearer token for HTTP authentication.
- oauth2Client
Credentials Property Map - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
GenericEmailGatewayConnectorAuthenticationApiKey, GenericEmailGatewayConnectorAuthenticationApiKeyArgs
GenericEmailGatewayConnectorAuthenticationBasic, GenericEmailGatewayConnectorAuthenticationBasicArgs
GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials, GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentialsArgs
- Auth
Url string - The token endpoint URL used to request an access token.
- Client
Id string - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- Client
Secret string - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- Auth
Style string - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - Scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- Token
Request Dictionary<string, string>Headers - Additional headers to include in the token request sent to the token endpoint.
- Auth
Url string - The token endpoint URL used to request an access token.
- Client
Id string - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- Client
Secret string - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- Auth
Style string - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - Scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- Token
Request map[string]stringHeaders - Additional headers to include in the token request sent to the token endpoint.
- auth_
url string - The token endpoint URL used to request an access token.
- client_
id string - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- client_
secret string - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- auth_
style string - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- token_
request_ map(string)headers - Additional headers to include in the token request sent to the token endpoint.
- auth
Url String - The token endpoint URL used to request an access token.
- client
Id String - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- client
Secret String - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- auth
Style String - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes String
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request Map<String,String>Headers - Additional headers to include in the token request sent to the token endpoint.
- auth
Url string - The token endpoint URL used to request an access token.
- client
Id string - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- client
Secret string - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- auth
Style string - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request {[key: string]: string}Headers - Additional headers to include in the token request sent to the token endpoint.
- auth_
url str - The token endpoint URL used to request an access token.
- client_
id str - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- client_
secret str - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- auth_
style str - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes str
- A space-separated list of OAuth scopes to request when fetching the access token.
- token_
request_ Mapping[str, str]headers - Additional headers to include in the token request sent to the token endpoint.
- auth
Url String - The token endpoint URL used to request an access token.
- client
Id String - The OAuth 2.0 client ID used to authenticate against the token endpoint.
- client
Secret String - The OAuth 2.0 client secret used to authenticate against the token endpoint.
- auth
Style String - How the client credentials are sent to the token endpoint. Either
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes String
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request Map<String>Headers - Additional headers to include in the token request sent to the token endpoint.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope