1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. SendgridConnector
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 SendGrid connector and its configuration in a Descope project. Send emails through the SendGrid email delivery service.

    Create SendgridConnector Resource

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

    Constructor syntax

    new SendgridConnector(name: string, args: SendgridConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def SendgridConnector(resource_name: str,
                          args: SendgridConnectorArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SendgridConnector(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          api_key: Optional[str] = None,
                          project_id: Optional[str] = None,
                          sender_email: Optional[str] = None,
                          description: Optional[str] = None,
                          name: Optional[str] = None,
                          sender_name: Optional[str] = None)
    func NewSendgridConnector(ctx *Context, name string, args SendgridConnectorArgs, opts ...ResourceOption) (*SendgridConnector, error)
    public SendgridConnector(string name, SendgridConnectorArgs args, CustomResourceOptions? opts = null)
    public SendgridConnector(String name, SendgridConnectorArgs args)
    public SendgridConnector(String name, SendgridConnectorArgs args, CustomResourceOptions options)
    
    type: descope:SendgridConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_sendgrid_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SendgridConnectorArgs
    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 SendgridConnectorArgs
    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 SendgridConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SendgridConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SendgridConnectorArgs
    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 sendgridConnectorResource = new Descope.SendgridConnector("sendgridConnectorResource", new()
    {
        ApiKey = "string",
        ProjectId = "string",
        SenderEmail = "string",
        Description = "string",
        Name = "string",
        SenderName = "string",
    });
    
    example, err := descope.NewSendgridConnector(ctx, "sendgridConnectorResource", &descope.SendgridConnectorArgs{
    	ApiKey:      pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	SenderEmail: pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	SenderName:  pulumi.String("string"),
    })
    
    resource "descope_sendgrid_connector" "sendgridConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_key      = "string"
      project_id   = "string"
      sender_email = "string"
      description  = "string"
      name         = "string"
      sender_name  = "string"
    }
    
    var sendgridConnectorResource = new SendgridConnector("sendgridConnectorResource", SendgridConnectorArgs.builder()
        .apiKey("string")
        .projectId("string")
        .senderEmail("string")
        .description("string")
        .name("string")
        .senderName("string")
        .build());
    
    sendgrid_connector_resource = descope.SendgridConnector("sendgridConnectorResource",
        api_key="string",
        project_id="string",
        sender_email="string",
        description="string",
        name="string",
        sender_name="string")
    
    const sendgridConnectorResource = new descope.SendgridConnector("sendgridConnectorResource", {
        apiKey: "string",
        projectId: "string",
        senderEmail: "string",
        description: "string",
        name: "string",
        senderName: "string",
    });
    
    type: descope:SendgridConnector
    properties:
        apiKey: string
        description: string
        name: string
        projectId: string
        senderEmail: string
        senderName: string
    

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

    ApiKey string
    The SendGrid API key used to authenticate requests.
    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.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    Description string
    A description of what your connector is used for.
    Name string
    A custom name for your connector.
    SenderName string
    The name shown as the sender of the emails.
    ApiKey string
    The SendGrid API key used to authenticate requests.
    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.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    Description string
    A description of what your connector is used for.
    Name string
    A custom name for your connector.
    SenderName string
    The name shown as the sender of the emails.
    api_key string
    The SendGrid API key used to authenticate requests.
    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.
    sender_email string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    description string
    A description of what your connector is used for.
    name string
    A custom name for your connector.
    sender_name string
    The name shown as the sender of the emails.
    apiKey String
    The SendGrid API key used to authenticate requests.
    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.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    description String
    A description of what your connector is used for.
    name String
    A custom name for your connector.
    senderName String
    The name shown as the sender of the emails.
    apiKey string
    The SendGrid API key used to authenticate requests.
    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.
    senderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    description string
    A description of what your connector is used for.
    name string
    A custom name for your connector.
    senderName string
    The name shown as the sender of the emails.
    api_key str
    The SendGrid API key used to authenticate requests.
    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.
    sender_email str
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    description str
    A description of what your connector is used for.
    name str
    A custom name for your connector.
    sender_name str
    The name shown as the sender of the emails.
    apiKey String
    The SendGrid API key used to authenticate requests.
    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.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    description String
    A description of what your connector is used for.
    name String
    A custom name for your connector.
    senderName String
    The name shown as the sender of the emails.

    Outputs

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

    Get an existing SendgridConnector 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?: SendgridConnectorState, opts?: CustomResourceOptions): SendgridConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            sender_email: Optional[str] = None,
            sender_name: Optional[str] = None) -> SendgridConnector
    func GetSendgridConnector(ctx *Context, name string, id IDInput, state *SendgridConnectorState, opts ...ResourceOption) (*SendgridConnector, error)
    public static SendgridConnector Get(string name, Input<string> id, SendgridConnectorState? state, CustomResourceOptions? opts = null)
    public static SendgridConnector get(String name, Output<String> id, SendgridConnectorState state, CustomResourceOptions options)
    resources:  existingSendgridConnector:    type: descope:SendgridConnector    get:      id: ${id}
    import {
      to = descope_sendgrid_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 SendgridConnectorState
    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 SendgridConnectorState
    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 SendgridConnectorState
    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 SendgridConnectorState
    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:
    ApiKey string
    The SendGrid API key used to authenticate requests.
    Description string
    A description of what your connector is used for.
    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.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    SenderName string
    The name shown as the sender of the emails.
    ApiKey string
    The SendGrid API key used to authenticate requests.
    Description string
    A description of what your connector is used for.
    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.
    SenderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    SenderName string
    The name shown as the sender of the emails.
    api_key string
    The SendGrid API key used to authenticate requests.
    description string
    A description of what your connector is used for.
    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.
    sender_email string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    sender_name string
    The name shown as the sender of the emails.
    apiKey String
    The SendGrid API key used to authenticate requests.
    description String
    A description of what your connector is used for.
    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.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    senderName String
    The name shown as the sender of the emails.
    apiKey string
    The SendGrid API key used to authenticate requests.
    description string
    A description of what your connector is used for.
    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.
    senderEmail string
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    senderName string
    The name shown as the sender of the emails.
    api_key str
    The SendGrid API key used to authenticate requests.
    description str
    A description of what your connector is used for.
    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.
    sender_email str
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    sender_name str
    The name shown as the sender of the emails.
    apiKey String
    The SendGrid API key used to authenticate requests.
    description String
    A description of what your connector is used for.
    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.
    senderEmail String
    The email address that emails are sent from. Make sure it is a verified sender in SendGrid.
    senderName String
    The name shown as the sender of the emails.

    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