1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. AlloyConnector
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 Alloy connector and its configuration in a Descope project. Streamline identity verification and fraud monitoring with the Alloy connector.

    Create AlloyConnector Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args AlloyConnectorArgs
    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 AlloyConnectorArgs
    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 AlloyConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlloyConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlloyConnectorArgs
    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 alloyConnectorResource = new Descope.AlloyConnector("alloyConnectorResource", new()
    {
        ApiSecret = "string",
        ApiToken = "string",
        BaseUrl = "string",
        ProjectId = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewAlloyConnector(ctx, "alloyConnectorResource", &descope.AlloyConnectorArgs{
    	ApiSecret:   pulumi.String("string"),
    	ApiToken:    pulumi.String("string"),
    	BaseUrl:     pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    })
    
    resource "descope_alloy_connector" "alloyConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_secret  = "string"
      api_token   = "string"
      base_url    = "string"
      project_id  = "string"
      description = "string"
      disabled    = false
      name        = "string"
    }
    
    var alloyConnectorResource = new AlloyConnector("alloyConnectorResource", AlloyConnectorArgs.builder()
        .apiSecret("string")
        .apiToken("string")
        .baseUrl("string")
        .projectId("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    alloy_connector_resource = descope.AlloyConnector("alloyConnectorResource",
        api_secret="string",
        api_token="string",
        base_url="string",
        project_id="string",
        description="string",
        disabled=False,
        name="string")
    
    const alloyConnectorResource = new descope.AlloyConnector("alloyConnectorResource", {
        apiSecret: "string",
        apiToken: "string",
        baseUrl: "string",
        projectId: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:AlloyConnector
    properties:
        apiSecret: string
        apiToken: string
        baseUrl: string
        description: string
        disabled: false
        name: string
        projectId: string
    

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

    ApiSecret string
    The Alloy API secret.
    ApiToken string
    The Alloy API token.
    BaseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    ApiSecret string
    The Alloy API secret.
    ApiToken string
    The Alloy API token.
    BaseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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_secret string
    The Alloy API secret.
    api_token string
    The Alloy API token.
    base_url string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret String
    The Alloy API secret.
    apiToken String
    The Alloy API token.
    baseUrl String
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret string
    The Alloy API secret.
    apiToken string
    The Alloy API token.
    baseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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_secret str
    The Alloy API secret.
    api_token str
    The Alloy API token.
    base_url str
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret String
    The Alloy API secret.
    apiToken String
    The Alloy API token.
    baseUrl String
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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 AlloyConnector 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 AlloyConnector Resource

    Get an existing AlloyConnector 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?: AlloyConnectorState, opts?: CustomResourceOptions): AlloyConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_secret: Optional[str] = None,
            api_token: Optional[str] = None,
            base_url: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> AlloyConnector
    func GetAlloyConnector(ctx *Context, name string, id IDInput, state *AlloyConnectorState, opts ...ResourceOption) (*AlloyConnector, error)
    public static AlloyConnector Get(string name, Input<string> id, AlloyConnectorState? state, CustomResourceOptions? opts = null)
    public static AlloyConnector get(String name, Output<String> id, AlloyConnectorState state, CustomResourceOptions options)
    resources:  existingAlloyConnector:    type: descope:AlloyConnector    get:      id: ${id}
    import {
      to = descope_alloy_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 AlloyConnectorState
    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 AlloyConnectorState
    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 AlloyConnectorState
    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 AlloyConnectorState
    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:
    ApiSecret string
    The Alloy API secret.
    ApiToken string
    The Alloy API token.
    BaseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    ApiSecret string
    The Alloy API secret.
    ApiToken string
    The Alloy API token.
    BaseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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_secret string
    The Alloy API secret.
    api_token string
    The Alloy API token.
    base_url string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret String
    The Alloy API secret.
    apiToken String
    The Alloy API token.
    baseUrl String
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret string
    The Alloy API secret.
    apiToken string
    The Alloy API token.
    baseUrl string
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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_secret str
    The Alloy API secret.
    api_token str
    The Alloy API token.
    base_url str
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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.
    apiSecret String
    The Alloy API secret.
    apiToken String
    The Alloy API token.
    baseUrl String
    The base URL for the Alloy API, e.g.: https://sandbox.alloy.co/v1, https://api.alloy.co/v1.
    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