1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. PingDirectoryConnector
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 PingDirectory connector and its configuration in a Descope project. Authenticate against PingDirectory.

    Create PingDirectoryConnector Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args PingDirectoryConnectorArgs
    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 PingDirectoryConnectorArgs
    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 PingDirectoryConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PingDirectoryConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PingDirectoryConnectorArgs
    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 pingDirectoryConnectorResource = new Descope.PingDirectoryConnector("pingDirectoryConnectorResource", new()
    {
        Host = "string",
        Port = 0.0,
        ProjectId = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
    });
    
    example, err := descope.NewPingDirectoryConnector(ctx, "pingDirectoryConnectorResource", &descope.PingDirectoryConnectorArgs{
    	Host:        pulumi.String("string"),
    	Port:        pulumi.Float64(0),
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Disabled:    pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    })
    
    resource "descope_ping_directory_connector" "pingDirectoryConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      host        = "string"
      port        = 0
      project_id  = "string"
      description = "string"
      disabled    = false
      name        = "string"
    }
    
    var pingDirectoryConnectorResource = new PingDirectoryConnector("pingDirectoryConnectorResource", PingDirectoryConnectorArgs.builder()
        .host("string")
        .port(0.0)
        .projectId("string")
        .description("string")
        .disabled(false)
        .name("string")
        .build());
    
    ping_directory_connector_resource = descope.PingDirectoryConnector("pingDirectoryConnectorResource",
        host="string",
        port=float(0),
        project_id="string",
        description="string",
        disabled=False,
        name="string")
    
    const pingDirectoryConnectorResource = new descope.PingDirectoryConnector("pingDirectoryConnectorResource", {
        host: "string",
        port: 0,
        projectId: "string",
        description: "string",
        disabled: false,
        name: "string",
    });
    
    type: descope:PingDirectoryConnector
    properties:
        description: string
        disabled: false
        host: string
        name: string
        port: 0
        projectId: string
    

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

    Host string
    PingDirectory's REST API host.
    Port double
    PingDirectory's REST API port.
    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.
    Host string
    PingDirectory's REST API host.
    Port float64
    PingDirectory's REST API port.
    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.
    host string
    PingDirectory's REST API host.
    port number
    PingDirectory's REST API port.
    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.
    host String
    PingDirectory's REST API host.
    port Double
    PingDirectory's REST API port.
    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.
    host string
    PingDirectory's REST API host.
    port number
    PingDirectory's REST API port.
    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.
    host str
    PingDirectory's REST API host.
    port float
    PingDirectory's REST API port.
    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.
    host String
    PingDirectory's REST API host.
    port Number
    PingDirectory's REST API port.
    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 PingDirectoryConnector 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 PingDirectoryConnector Resource

    Get an existing PingDirectoryConnector 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?: PingDirectoryConnectorState, opts?: CustomResourceOptions): PingDirectoryConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            host: Optional[str] = None,
            name: Optional[str] = None,
            port: Optional[float] = None,
            project_id: Optional[str] = None) -> PingDirectoryConnector
    func GetPingDirectoryConnector(ctx *Context, name string, id IDInput, state *PingDirectoryConnectorState, opts ...ResourceOption) (*PingDirectoryConnector, error)
    public static PingDirectoryConnector Get(string name, Input<string> id, PingDirectoryConnectorState? state, CustomResourceOptions? opts = null)
    public static PingDirectoryConnector get(String name, Output<String> id, PingDirectoryConnectorState state, CustomResourceOptions options)
    resources:  existingPingDirectoryConnector:    type: descope:PingDirectoryConnector    get:      id: ${id}
    import {
      to = descope_ping_directory_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 PingDirectoryConnectorState
    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 PingDirectoryConnectorState
    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 PingDirectoryConnectorState
    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 PingDirectoryConnectorState
    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.
    Host string
    PingDirectory's REST API host.
    Name string
    A custom name for your connector.
    Port double
    PingDirectory's REST API port.
    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.
    Host string
    PingDirectory's REST API host.
    Name string
    A custom name for your connector.
    Port float64
    PingDirectory's REST API port.
    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.
    host string
    PingDirectory's REST API host.
    name string
    A custom name for your connector.
    port number
    PingDirectory's REST API port.
    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.
    host String
    PingDirectory's REST API host.
    name String
    A custom name for your connector.
    port Double
    PingDirectory's REST API port.
    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.
    host string
    PingDirectory's REST API host.
    name string
    A custom name for your connector.
    port number
    PingDirectory's REST API port.
    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.
    host str
    PingDirectory's REST API host.
    name str
    A custom name for your connector.
    port float
    PingDirectory's REST API port.
    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.
    host String
    PingDirectory's REST API host.
    name String
    A custom name for your connector.
    port Number
    PingDirectory's REST API port.
    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