1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. HibpConnector
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 Have I Been Pwned connector and its configuration in a Descope project. Check if passwords have been previously exposed in data breaches with the Have I Been Pwned connector.

    Create HibpConnector Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args HibpConnectorArgs
    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 HibpConnectorArgs
    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 HibpConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HibpConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HibpConnectorArgs
    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 hibpConnectorResource = new Descope.HibpConnector("hibpConnectorResource", new()
    {
        ProjectId = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewHibpConnector(ctx, "hibpConnectorResource", &descope.HibpConnectorArgs{
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    })
    
    resource "descope_hibp_connector" "hibpConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id  = "string"
      description = "string"
      disabled    = false
      name        = "string"
    }
    
    var hibpConnectorResource = new HibpConnector("hibpConnectorResource", HibpConnectorArgs.builder()
        .projectId("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    hibp_connector_resource = descope.HibpConnector("hibpConnectorResource",
        project_id="string",
        description="string",
        disabled=False,
        name="string")
    
    const hibpConnectorResource = new descope.HibpConnector("hibpConnectorResource", {
        projectId: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:HibpConnector
    properties:
        description: string
        disabled: false
        name: string
        projectId: string
    

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

    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.
    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.
    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.
    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.
    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.
    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.
    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 HibpConnector 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 HibpConnector Resource

    Get an existing HibpConnector 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?: HibpConnectorState, opts?: CustomResourceOptions): HibpConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> HibpConnector
    func GetHibpConnector(ctx *Context, name string, id IDInput, state *HibpConnectorState, opts ...ResourceOption) (*HibpConnector, error)
    public static HibpConnector Get(string name, Input<string> id, HibpConnectorState? state, CustomResourceOptions? opts = null)
    public static HibpConnector get(String name, Output<String> id, HibpConnectorState state, CustomResourceOptions options)
    resources:  existingHibpConnector:    type: descope:HibpConnector    get:      id: ${id}
    import {
      to = descope_hibp_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 HibpConnectorState
    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 HibpConnectorState
    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 HibpConnectorState
    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 HibpConnectorState
    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:
    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.
    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.
    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.
    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.
    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.
    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.
    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