1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. GenericEmailGatewayConnector
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
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:

    PostUrl string
    The URL of the post email request
    ProjectId 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.GenericEmailGatewayConnectorAuthentication
    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
    HmacSecret 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-s256 header. 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.
    SecretHeaders 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
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    PostUrl string
    The URL of the post email request
    ProjectId 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 GenericEmailGatewayConnectorAuthenticationArgs
    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
    HmacSecret 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-s256 header. 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.
    SecretHeaders 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
    UseStaticIps bool
    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-s256 header. 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_ips bool
    Whether the connector should send all requests from specific static IPs.
    postUrl String
    The URL of the post email request
    projectId 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 GenericEmailGatewayConnectorAuthentication
    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
    hmacSecret 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-s256 header. 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.
    secretHeaders 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
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    postUrl string
    The URL of the post email request
    projectId 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 GenericEmailGatewayConnectorAuthentication
    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
    hmacSecret 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-s256 header. 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.
    secretHeaders {[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
    useStaticIps boolean
    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 GenericEmailGatewayConnectorAuthenticationArgs
    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-s256 header. 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_ips bool
    Whether the connector should send all requests from specific static IPs.
    postUrl String
    The URL of the post email request
    projectId 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
    hmacSecret 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-s256 header. 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.
    secretHeaders 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
    useStaticIps Boolean
    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) -> GenericEmailGatewayConnector
    func 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.
    The following state arguments are supported:
    Authentication Descope.GenericEmailGatewayConnectorAuthentication
    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
    HmacSecret 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-s256 header. 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.
    PostUrl string
    The URL of the post email request
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretHeaders 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
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    Authentication GenericEmailGatewayConnectorAuthenticationArgs
    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
    HmacSecret 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-s256 header. 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.
    PostUrl string
    The URL of the post email request
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SecretHeaders 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
    UseStaticIps bool
    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-s256 header. 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_ips bool
    Whether the connector should send all requests from specific static IPs.
    authentication GenericEmailGatewayConnectorAuthentication
    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
    hmacSecret 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-s256 header. 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.
    postUrl String
    The URL of the post email request
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders 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
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    authentication GenericEmailGatewayConnectorAuthentication
    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
    hmacSecret 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-s256 header. 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.
    postUrl string
    The URL of the post email request
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders {[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
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    authentication GenericEmailGatewayConnectorAuthenticationArgs
    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-s256 header. 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_ips bool
    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
    hmacSecret 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-s256 header. 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.
    postUrl String
    The URL of the post email request
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    secretHeaders 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
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Supporting Types

    GenericEmailGatewayConnectorAuthentication, GenericEmailGatewayConnectorAuthenticationArgs

    ApiKey Descope.GenericEmailGatewayConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic Descope.GenericEmailGatewayConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials Descope.GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    ApiKey GenericEmailGatewayConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic GenericEmailGatewayConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials
    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_credentials object
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey GenericEmailGatewayConnectorAuthenticationApiKey
    API key authentication configuration.
    basic GenericEmailGatewayConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey GenericEmailGatewayConnectorAuthenticationApiKey
    API key authentication configuration.
    basic GenericEmailGatewayConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken string
    Bearer token for HTTP authentication.
    oauth2ClientCredentials GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    api_key GenericEmailGatewayConnectorAuthenticationApiKey
    API key authentication configuration.
    basic GenericEmailGatewayConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearer_token str
    Bearer token for HTTP authentication.
    oauth2_client_credentials GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey Property Map
    API key authentication configuration.
    basic Property Map
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials Property Map
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.

    GenericEmailGatewayConnectorAuthenticationApiKey, GenericEmailGatewayConnectorAuthenticationApiKeyArgs

    Key string
    The API key.
    Token string
    The API secret.
    Key string
    The API key.
    Token string
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key String
    The API key.
    token String
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key str
    The API key.
    token str
    The API secret.
    key String
    The API key.
    token String
    The API secret.

    GenericEmailGatewayConnectorAuthenticationBasic, GenericEmailGatewayConnectorAuthenticationBasicArgs

    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password str
    Password for basic HTTP authentication.
    username str
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.

    GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentials, GenericEmailGatewayConnectorAuthenticationOauth2ClientCredentialsArgs

    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders Dictionary<string, string>
    Additional headers to include in the token request sent to the token endpoint.
    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders map[string]string
    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 header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers map(string)
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String,String>
    Additional headers to include in the token request sent to the token endpoint.
    authUrl string
    The token endpoint URL used to request an access token.
    clientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders {[key: string]: string}
    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 header to send them in the Authorization header, or body to send them in the request body.
    scopes str
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers Mapping[str, str]
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String>
    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 descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial