1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. SalesforceConnector
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 Salesforce connector and its configuration in a Descope project. Run SQL queries to retrieve user roles, profiles, account status, and more with the Salesforce connector.

    Create SalesforceConnector Resource

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

    Constructor syntax

    new SalesforceConnector(name: string, args: SalesforceConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def SalesforceConnector(resource_name: str,
                            args: SalesforceConnectorArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def SalesforceConnector(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            base_url: Optional[str] = None,
                            client_id: Optional[str] = None,
                            client_secret: Optional[str] = None,
                            project_id: Optional[str] = None,
                            version: Optional[str] = None,
                            description: Optional[str] = None,
                            disabled: Optional[bool] = None,
                            name: Optional[str] = None)
    func NewSalesforceConnector(ctx *Context, name string, args SalesforceConnectorArgs, opts ...ResourceOption) (*SalesforceConnector, error)
    public SalesforceConnector(string name, SalesforceConnectorArgs args, CustomResourceOptions? opts = null)
    public SalesforceConnector(String name, SalesforceConnectorArgs args)
    public SalesforceConnector(String name, SalesforceConnectorArgs args, CustomResourceOptions options)
    
    type: descope:SalesforceConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_salesforce_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SalesforceConnectorArgs
    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 SalesforceConnectorArgs
    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 SalesforceConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SalesforceConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SalesforceConnectorArgs
    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 salesforceConnectorResource = new Descope.SalesforceConnector("salesforceConnectorResource", new()
    {
        BaseUrl = "string",
        ClientId = "string",
        ClientSecret = "string",
        ProjectId = "string",
        Version = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewSalesforceConnector(ctx, "salesforceConnectorResource", &descope.SalesforceConnectorArgs{
    	BaseUrl:      pulumi.String("string"),
    	ClientId:     pulumi.String("string"),
    	ClientSecret: pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	Version:      pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Disabled:     pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    })
    
    resource "descope_salesforce_connector" "salesforceConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      base_url      = "string"
      client_id     = "string"
      client_secret = "string"
      project_id    = "string"
      version       = "string"
      description   = "string"
      disabled      = false
      name          = "string"
    }
    
    var salesforceConnectorResource = new SalesforceConnector("salesforceConnectorResource", SalesforceConnectorArgs.builder()
        .baseUrl("string")
        .clientId("string")
        .clientSecret("string")
        .projectId("string")
        .version("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    salesforce_connector_resource = descope.SalesforceConnector("salesforceConnectorResource",
        base_url="string",
        client_id="string",
        client_secret="string",
        project_id="string",
        version="string",
        description="string",
        disabled=False,
        name="string")
    
    const salesforceConnectorResource = new descope.SalesforceConnector("salesforceConnectorResource", {
        baseUrl: "string",
        clientId: "string",
        clientSecret: "string",
        projectId: "string",
        version: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:SalesforceConnector
    properties:
        baseUrl: string
        clientId: string
        clientSecret: string
        description: string
        disabled: false
        name: string
        projectId: string
        version: string
    

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

    BaseUrl string
    The Salesforce API base URL.
    ClientId string
    The consumer key of the connected app.
    ClientSecret string
    The consumer secret of the connected app.
    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.
    Version string
    REST API Version.
    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.
    BaseUrl string
    The Salesforce API base URL.
    ClientId string
    The consumer key of the connected app.
    ClientSecret string
    The consumer secret of the connected app.
    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.
    Version string
    REST API Version.
    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.
    base_url string
    The Salesforce API base URL.
    client_id string
    The consumer key of the connected app.
    client_secret string
    The consumer secret of the connected app.
    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.
    version string
    REST API Version.
    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.
    baseUrl String
    The Salesforce API base URL.
    clientId String
    The consumer key of the connected app.
    clientSecret String
    The consumer secret of the connected app.
    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.
    version String
    REST API Version.
    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.
    baseUrl string
    The Salesforce API base URL.
    clientId string
    The consumer key of the connected app.
    clientSecret string
    The consumer secret of the connected app.
    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.
    version string
    REST API Version.
    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.
    base_url str
    The Salesforce API base URL.
    client_id str
    The consumer key of the connected app.
    client_secret str
    The consumer secret of the connected app.
    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.
    version str
    REST API Version.
    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.
    baseUrl String
    The Salesforce API base URL.
    clientId String
    The consumer key of the connected app.
    clientSecret String
    The consumer secret of the connected app.
    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.
    version String
    REST API Version.
    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 SalesforceConnector 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 SalesforceConnector Resource

    Get an existing SalesforceConnector 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?: SalesforceConnectorState, opts?: CustomResourceOptions): SalesforceConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            base_url: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            version: Optional[str] = None) -> SalesforceConnector
    func GetSalesforceConnector(ctx *Context, name string, id IDInput, state *SalesforceConnectorState, opts ...ResourceOption) (*SalesforceConnector, error)
    public static SalesforceConnector Get(string name, Input<string> id, SalesforceConnectorState? state, CustomResourceOptions? opts = null)
    public static SalesforceConnector get(String name, Output<String> id, SalesforceConnectorState state, CustomResourceOptions options)
    resources:  existingSalesforceConnector:    type: descope:SalesforceConnector    get:      id: ${id}
    import {
      to = descope_salesforce_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 SalesforceConnectorState
    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 SalesforceConnectorState
    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 SalesforceConnectorState
    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 SalesforceConnectorState
    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:
    BaseUrl string
    The Salesforce API base URL.
    ClientId string
    The consumer key of the connected app.
    ClientSecret string
    The consumer secret of the connected app.
    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.
    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.
    Version string
    REST API Version.
    BaseUrl string
    The Salesforce API base URL.
    ClientId string
    The consumer key of the connected app.
    ClientSecret string
    The consumer secret of the connected app.
    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.
    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.
    Version string
    REST API Version.
    base_url string
    The Salesforce API base URL.
    client_id string
    The consumer key of the connected app.
    client_secret string
    The consumer secret of the connected app.
    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.
    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.
    version string
    REST API Version.
    baseUrl String
    The Salesforce API base URL.
    clientId String
    The consumer key of the connected app.
    clientSecret String
    The consumer secret of the connected app.
    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.
    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.
    version String
    REST API Version.
    baseUrl string
    The Salesforce API base URL.
    clientId string
    The consumer key of the connected app.
    clientSecret string
    The consumer secret of the connected app.
    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.
    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.
    version string
    REST API Version.
    base_url str
    The Salesforce API base URL.
    client_id str
    The consumer key of the connected app.
    client_secret str
    The consumer secret of the connected app.
    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.
    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.
    version str
    REST API Version.
    baseUrl String
    The Salesforce API base URL.
    clientId String
    The consumer key of the connected app.
    clientSecret String
    The consumer secret of the connected app.
    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.
    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.
    version String
    REST API Version.

    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