1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. LokaliseConnector
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 Lokalise connector and its configuration in a Descope project. Localize the language of your login and user journey screens with the Lokalise connector. Screen texts are pushed to your Lokalise project as keys, translated inside Lokalise by your team, and pulled back once ready.

    Create LokaliseConnector Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args LokaliseConnectorArgs
    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 LokaliseConnectorArgs
    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 LokaliseConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LokaliseConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LokaliseConnectorArgs
    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 lokaliseConnectorResource = new Descope.LokaliseConnector("lokaliseConnectorResource", new()
    {
        ApiToken = "string",
        ConfigProjectId = "string",
        ProjectId = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewLokaliseConnector(ctx, "lokaliseConnectorResource", &descope.LokaliseConnectorArgs{
    	ApiToken:        pulumi.String("string"),
    	ConfigProjectId: pulumi.String("string"),
    	ProjectId:       pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Disabled:        pulumi.Bool(false),
    	Name:            pulumi.String("string"),
    })
    
    resource "descope_lokalise_connector" "lokaliseConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_token         = "string"
      config_project_id = "string"
      project_id        = "string"
      description       = "string"
      disabled          = false
      name              = "string"
    }
    
    var lokaliseConnectorResource = new LokaliseConnector("lokaliseConnectorResource", LokaliseConnectorArgs.builder()
        .apiToken("string")
        .configProjectId("string")
        .projectId("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    lokalise_connector_resource = descope.LokaliseConnector("lokaliseConnectorResource",
        api_token="string",
        config_project_id="string",
        project_id="string",
        description="string",
        disabled=False,
        name="string")
    
    const lokaliseConnectorResource = new descope.LokaliseConnector("lokaliseConnectorResource", {
        apiToken: "string",
        configProjectId: "string",
        projectId: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:LokaliseConnector
    properties:
        apiToken: string
        configProjectId: string
        description: string
        disabled: false
        name: string
        projectId: string
    

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

    ApiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    ConfigProjectId string
    Lokalise project ID.
    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.
    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.
    ApiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    ConfigProjectId string
    Lokalise project ID.
    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.
    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.
    api_token string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    config_project_id string
    Lokalise project ID.
    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.
    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.
    apiToken String
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId String
    Lokalise project ID.
    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.
    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.
    apiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId string
    Lokalise project ID.
    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.
    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.
    api_token str
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    config_project_id str
    Lokalise project ID.
    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.
    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.
    apiToken String
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId String
    Lokalise project ID.
    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.
    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 LokaliseConnector 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 LokaliseConnector Resource

    Get an existing LokaliseConnector 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?: LokaliseConnectorState, opts?: CustomResourceOptions): LokaliseConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_token: Optional[str] = None,
            config_project_id: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> LokaliseConnector
    func GetLokaliseConnector(ctx *Context, name string, id IDInput, state *LokaliseConnectorState, opts ...ResourceOption) (*LokaliseConnector, error)
    public static LokaliseConnector Get(string name, Input<string> id, LokaliseConnectorState? state, CustomResourceOptions? opts = null)
    public static LokaliseConnector get(String name, Output<String> id, LokaliseConnectorState state, CustomResourceOptions options)
    resources:  existingLokaliseConnector:    type: descope:LokaliseConnector    get:      id: ${id}
    import {
      to = descope_lokalise_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 LokaliseConnectorState
    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 LokaliseConnectorState
    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 LokaliseConnectorState
    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 LokaliseConnectorState
    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:
    ApiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    ConfigProjectId string
    Lokalise project ID.
    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.
    ApiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    ConfigProjectId string
    Lokalise project ID.
    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.
    api_token string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    config_project_id string
    Lokalise project ID.
    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.
    apiToken String
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId String
    Lokalise project ID.
    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.
    apiToken string
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId string
    Lokalise project ID.
    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.
    api_token str
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    config_project_id str
    Lokalise project ID.
    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.
    apiToken String
    Lokalise API token. The token must belong to a user that can manage keys in the project (Owner/Admin recommended).
    configProjectId String
    Lokalise project ID.
    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.

    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