published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a Incode connector and its configuration in a Descope project. Use the Incode connection to run identity verification processes like document checks or facial recognition.
Create IncodeConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IncodeConnector(name: string, args: IncodeConnectorArgs, opts?: CustomResourceOptions);@overload
def IncodeConnector(resource_name: str,
args: IncodeConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IncodeConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
api_url: Optional[str] = None,
flow_id: Optional[str] = None,
project_id: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
name: Optional[str] = None)func NewIncodeConnector(ctx *Context, name string, args IncodeConnectorArgs, opts ...ResourceOption) (*IncodeConnector, error)public IncodeConnector(string name, IncodeConnectorArgs args, CustomResourceOptions? opts = null)
public IncodeConnector(String name, IncodeConnectorArgs args)
public IncodeConnector(String name, IncodeConnectorArgs args, CustomResourceOptions options)
type: descope:IncodeConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_incode_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args IncodeConnectorArgs
- 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 IncodeConnectorArgs
- 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 IncodeConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IncodeConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IncodeConnectorArgs
- 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 incodeConnectorResource = new Descope.IncodeConnector("incodeConnectorResource", new()
{
ApiKey = "string",
ApiUrl = "string",
FlowId = "string",
ProjectId = "string",
Description = "string",
Disabled = false,
Name = "string",
});
example, err := descope.NewIncodeConnector(ctx, "incodeConnectorResource", &descope.IncodeConnectorArgs{
ApiKey: pulumi.String("string"),
ApiUrl: pulumi.String("string"),
FlowId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
})
resource "descope_incode_connector" "incodeConnectorResource" {
lifecycle {
create_before_destroy = true
}
api_key = "string"
api_url = "string"
flow_id = "string"
project_id = "string"
description = "string"
disabled = false
name = "string"
}
var incodeConnectorResource = new IncodeConnector("incodeConnectorResource", IncodeConnectorArgs.builder()
.apiKey("string")
.apiUrl("string")
.flowId("string")
.projectId("string")
.description("string")
.disabled(false)
.name("string")
.build());
incode_connector_resource = descope.IncodeConnector("incodeConnectorResource",
api_key="string",
api_url="string",
flow_id="string",
project_id="string",
description="string",
disabled=False,
name="string")
const incodeConnectorResource = new descope.IncodeConnector("incodeConnectorResource", {
apiKey: "string",
apiUrl: "string",
flowId: "string",
projectId: "string",
description: "string",
disabled: false,
name: "string",
});
type: descope:IncodeConnector
properties:
apiKey: string
apiUrl: string
description: string
disabled: false
flowId: string
name: string
projectId: string
IncodeConnector 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 IncodeConnector resource accepts the following input properties:
- Api
Key string - Your InCode API key.
- Api
Url string - The base URL of the Incode API
- Flow
Id string - Your wanted InCode's flow 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.
- Api
Key string - Your InCode API key.
- Api
Url string - The base URL of the Incode API
- Flow
Id string - Your wanted InCode's flow 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.
- api_
key string - Your InCode API key.
- api_
url string - The base URL of the Incode API
- flow_
id string - Your wanted InCode's flow 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.
- api
Key String - Your InCode API key.
- api
Url String - The base URL of the Incode API
- flow
Id String - Your wanted InCode's flow 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 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
Key string - Your InCode API key.
- api
Url string - The base URL of the Incode API
- flow
Id string - Your wanted InCode's flow 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 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_
key str - Your InCode API key.
- api_
url str - The base URL of the Incode API
- flow_
id str - Your wanted InCode's flow 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.
- api
Key String - Your InCode API key.
- api
Url String - The base URL of the Incode API
- flow
Id String - Your wanted InCode's flow 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 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 IncodeConnector 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 IncodeConnector Resource
Get an existing IncodeConnector 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?: IncodeConnectorState, opts?: CustomResourceOptions): IncodeConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
api_url: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
flow_id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None) -> IncodeConnectorfunc GetIncodeConnector(ctx *Context, name string, id IDInput, state *IncodeConnectorState, opts ...ResourceOption) (*IncodeConnector, error)public static IncodeConnector Get(string name, Input<string> id, IncodeConnectorState? state, CustomResourceOptions? opts = null)public static IncodeConnector get(String name, Output<String> id, IncodeConnectorState state, CustomResourceOptions options)resources: existingIncodeConnector: type: descope:IncodeConnector get: id: ${id}import {
to = descope_incode_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 IncodeConnectorState
- 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 IncodeConnectorState
- 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 IncodeConnectorState
- 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 IncodeConnectorState
- 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.
- Api
Key string - Your InCode API key.
- Api
Url string - The base URL of the Incode API
- 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.
- Flow
Id string - Your wanted InCode's flow ID.
- 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.
- Api
Key string - Your InCode API key.
- Api
Url string - The base URL of the Incode API
- 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.
- Flow
Id string - Your wanted InCode's flow ID.
- 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.
- api_
key string - Your InCode API key.
- api_
url string - The base URL of the Incode API
- 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.
- flow_
id string - Your wanted InCode's flow ID.
- 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.
- api
Key String - Your InCode API key.
- api
Url String - The base URL of the Incode API
- 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.
- flow
Id String - Your wanted InCode's flow ID.
- 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.
- api
Key string - Your InCode API key.
- api
Url string - The base URL of the Incode API
- 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.
- flow
Id string - Your wanted InCode's flow ID.
- 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.
- api_
key str - Your InCode API key.
- api_
url str - The base URL of the Incode API
- 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.
- flow_
id str - Your wanted InCode's flow ID.
- 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.
- api
Key String - Your InCode API key.
- api
Url String - The base URL of the Incode API
- 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.
- flow
Id String - Your wanted InCode's flow ID.
- 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.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope