1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. PostmarkConnector
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 Postmark connector and its configuration in a Descope project. Send emails using Postmark.

    Create PostmarkConnector Resource

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

    Constructor syntax

    new PostmarkConnector(name: string, args: PostmarkConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def PostmarkConnector(resource_name: str,
                          args: PostmarkConnectorArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def PostmarkConnector(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          email_from: Optional[str] = None,
                          message_stream_id: Optional[str] = None,
                          project_id: Optional[str] = None,
                          server_api_token: Optional[str] = None,
                          description: Optional[str] = None,
                          disabled: Optional[bool] = None,
                          name: Optional[str] = None)
    func NewPostmarkConnector(ctx *Context, name string, args PostmarkConnectorArgs, opts ...ResourceOption) (*PostmarkConnector, error)
    public PostmarkConnector(string name, PostmarkConnectorArgs args, CustomResourceOptions? opts = null)
    public PostmarkConnector(String name, PostmarkConnectorArgs args)
    public PostmarkConnector(String name, PostmarkConnectorArgs args, CustomResourceOptions options)
    
    type: descope:PostmarkConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_postmark_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PostmarkConnectorArgs
    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 PostmarkConnectorArgs
    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 PostmarkConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostmarkConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostmarkConnectorArgs
    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 postmarkConnectorResource = new Descope.PostmarkConnector("postmarkConnectorResource", new()
    {
        EmailFrom = "string",
        MessageStreamId = "string",
        ProjectId = "string",
        ServerApiToken = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewPostmarkConnector(ctx, "postmarkConnectorResource", &descope.PostmarkConnectorArgs{
    	EmailFrom:       pulumi.String("string"),
    	MessageStreamId: pulumi.String("string"),
    	ProjectId:       pulumi.String("string"),
    	ServerApiToken:  pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Disabled:        pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    })
    
    resource "descope_postmark_connector" "postmarkConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      email_from        = "string"
      message_stream_id = "string"
      project_id        = "string"
      server_api_token  = "string"
      description       = "string"
      disabled          = false
      name              = "string"
    }
    
    var postmarkConnectorResource = new PostmarkConnector("postmarkConnectorResource", PostmarkConnectorArgs.builder()
        .emailFrom("string")
        .messageStreamId("string")
        .projectId("string")
        .serverApiToken("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    postmark_connector_resource = descope.PostmarkConnector("postmarkConnectorResource",
        email_from="string",
        message_stream_id="string",
        project_id="string",
        server_api_token="string",
        description="string",
        disabled=False,
        name="string")
    
    const postmarkConnectorResource = new descope.PostmarkConnector("postmarkConnectorResource", {
        emailFrom: "string",
        messageStreamId: "string",
        projectId: "string",
        serverApiToken: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:PostmarkConnector
    properties:
        description: string
        disabled: false
        emailFrom: string
        messageStreamId: string
        name: string
        projectId: string
        serverApiToken: string
    

    PostmarkConnector 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 PostmarkConnector resource accepts the following input properties:

    EmailFrom string
    The email address that will appear in the 'From' field of the sent email
    MessageStreamId string
    The ID of the message stream to use for the email
    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.
    ServerApiToken string
    The API token for authenticating with the Postmark server
    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.
    Name string
    A custom name for your connector.
    EmailFrom string
    The email address that will appear in the 'From' field of the sent email
    MessageStreamId string
    The ID of the message stream to use for the email
    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.
    ServerApiToken string
    The API token for authenticating with the Postmark server
    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.
    Name string
    A custom name for your connector.
    email_from string
    The email address that will appear in the 'From' field of the sent email
    message_stream_id string
    The ID of the message stream to use for the email
    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.
    server_api_token string
    The API token for authenticating with the Postmark server
    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.
    name string
    A custom name for your connector.
    emailFrom String
    The email address that will appear in the 'From' field of the sent email
    messageStreamId String
    The ID of the message stream to use for the email
    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.
    serverApiToken String
    The API token for authenticating with the Postmark server
    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.
    name String
    A custom name for your connector.
    emailFrom string
    The email address that will appear in the 'From' field of the sent email
    messageStreamId string
    The ID of the message stream to use for the email
    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.
    serverApiToken string
    The API token for authenticating with the Postmark server
    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.
    name string
    A custom name for your connector.
    email_from str
    The email address that will appear in the 'From' field of the sent email
    message_stream_id str
    The ID of the message stream to use for the email
    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.
    server_api_token str
    The API token for authenticating with the Postmark server
    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.
    name str
    A custom name for your connector.
    emailFrom String
    The email address that will appear in the 'From' field of the sent email
    messageStreamId String
    The ID of the message stream to use for the email
    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.
    serverApiToken String
    The API token for authenticating with the Postmark server
    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.
    name String
    A custom name for your connector.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PostmarkConnector 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 PostmarkConnector Resource

    Get an existing PostmarkConnector 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?: PostmarkConnectorState, opts?: CustomResourceOptions): PostmarkConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            email_from: Optional[str] = None,
            message_stream_id: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            server_api_token: Optional[str] = None) -> PostmarkConnector
    func GetPostmarkConnector(ctx *Context, name string, id IDInput, state *PostmarkConnectorState, opts ...ResourceOption) (*PostmarkConnector, error)
    public static PostmarkConnector Get(string name, Input<string> id, PostmarkConnectorState? state, CustomResourceOptions? opts = null)
    public static PostmarkConnector get(String name, Output<String> id, PostmarkConnectorState state, CustomResourceOptions options)
    resources:  existingPostmarkConnector:    type: descope:PostmarkConnector    get:      id: ${id}
    import {
      to = descope_postmark_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 PostmarkConnectorState
    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 PostmarkConnectorState
    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 PostmarkConnectorState
    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 PostmarkConnectorState
    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:
    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.
    EmailFrom string
    The email address that will appear in the 'From' field of the sent email
    MessageStreamId string
    The ID of the message stream to use for the email
    Name string
    A custom name for your connector.
    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.
    ServerApiToken string
    The API token for authenticating with the Postmark server
    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.
    EmailFrom string
    The email address that will appear in the 'From' field of the sent email
    MessageStreamId string
    The ID of the message stream to use for the email
    Name string
    A custom name for your connector.
    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.
    ServerApiToken string
    The API token for authenticating with the Postmark server
    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.
    email_from string
    The email address that will appear in the 'From' field of the sent email
    message_stream_id string
    The ID of the message stream to use for the email
    name string
    A custom name for your connector.
    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.
    server_api_token string
    The API token for authenticating with the Postmark server
    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.
    emailFrom String
    The email address that will appear in the 'From' field of the sent email
    messageStreamId String
    The ID of the message stream to use for the email
    name String
    A custom name for your connector.
    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.
    serverApiToken String
    The API token for authenticating with the Postmark server
    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.
    emailFrom string
    The email address that will appear in the 'From' field of the sent email
    messageStreamId string
    The ID of the message stream to use for the email
    name string
    A custom name for your connector.
    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.
    serverApiToken string
    The API token for authenticating with the Postmark server
    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.
    email_from str
    The email address that will appear in the 'From' field of the sent email
    message_stream_id str
    The ID of the message stream to use for the email
    name str
    A custom name for your connector.
    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.
    server_api_token str
    The API token for authenticating with the Postmark server
    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.
    emailFrom String
    The email address that will appear in the 'From' field of the sent email
    messageStreamId String
    The ID of the message stream to use for the email
    name String
    A custom name for your connector.
    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.
    serverApiToken String
    The API token for authenticating with the Postmark server

    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