1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. HttpConnector
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 Generic HTTP connector and its configuration in a Descope project. A general purpose HTTP client.

    Create HttpConnector Resource

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

    Constructor syntax

    new HttpConnector(name: string, args: HttpConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def HttpConnector(resource_name: str,
                      args: HttpConnectorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def HttpConnector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      base_url: Optional[str] = None,
                      project_id: Optional[str] = None,
                      headers: Optional[Mapping[str, str]] = None,
                      rfc9421_signing_enabled: Optional[bool] = None,
                      aws_region: Optional[str] = None,
                      aws_role_arn: Optional[str] = None,
                      aws_secret_access_key: Optional[str] = None,
                      aws_service: Optional[str] = None,
                      aws_auth_type: Optional[str] = None,
                      ca_certificate: Optional[str] = None,
                      client_certificate: Optional[str] = None,
                      client_key: Optional[str] = None,
                      description: Optional[str] = None,
                      disabled: Optional[bool] = None,
                      aws_external_id: Optional[str] = None,
                      authentication: Optional[HttpConnectorAuthenticationArgs] = None,
                      rfc9421_components: Optional[str] = None,
                      insecure: Optional[bool] = None,
                      name: Optional[str] = None,
                      aws_access_key_id: Optional[str] = None,
                      include_headers_in_context: Optional[bool] = None,
                      rfc9421_key_id: Optional[str] = None,
                      rfc9421_private_key: Optional[str] = None,
                      rfc9421_signature_ttl: Optional[float] = None,
                      hmac_secret: Optional[str] = None,
                      secret_headers: Optional[Mapping[str, str]] = None,
                      use_mtls: Optional[bool] = None,
                      use_static_ips: Optional[bool] = None)
    func NewHttpConnector(ctx *Context, name string, args HttpConnectorArgs, opts ...ResourceOption) (*HttpConnector, error)
    public HttpConnector(string name, HttpConnectorArgs args, CustomResourceOptions? opts = null)
    public HttpConnector(String name, HttpConnectorArgs args)
    public HttpConnector(String name, HttpConnectorArgs args, CustomResourceOptions options)
    
    type: descope:HttpConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_http_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args HttpConnectorArgs
    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 HttpConnectorArgs
    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 HttpConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HttpConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HttpConnectorArgs
    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 httpConnectorResource = new Descope.HttpConnector("httpConnectorResource", new()
    {
        BaseUrl = "string",
        ProjectId = "string",
        Headers = 
        {
            { "string", "string" },
        },
        Rfc9421SigningEnabled = false,
        AwsRegion = "string",
        AwsRoleArn = "string",
        AwsSecretAccessKey = "string",
        AwsService = "string",
        AwsAuthType = "string",
        CaCertificate = "string",
        ClientCertificate = "string",
        ClientKey = "string",
        Description = "string",
        Disabled = false,
        AwsExternalId = "string",
        Authentication = new Descope.Inputs.HttpConnectorAuthenticationArgs
        {
            ApiKey = new Descope.Inputs.HttpConnectorAuthenticationApiKeyArgs
            {
                Key = "string",
                Token = "string",
            },
            Basic = new Descope.Inputs.HttpConnectorAuthenticationBasicArgs
            {
                Password = "string",
                Username = "string",
            },
            BearerToken = "string",
            Oauth2ClientCredentials = new Descope.Inputs.HttpConnectorAuthenticationOauth2ClientCredentialsArgs
            {
                AuthUrl = "string",
                ClientId = "string",
                ClientSecret = "string",
                AuthStyle = "string",
                Scopes = "string",
                TokenRequestHeaders = 
                {
                    { "string", "string" },
                },
            },
        },
        Rfc9421Components = "string",
        Insecure = false,
        Name = "string",
        AwsAccessKeyId = "string",
        IncludeHeadersInContext = false,
        Rfc9421KeyId = "string",
        Rfc9421PrivateKey = "string",
        Rfc9421SignatureTtl = 0.0,
        HmacSecret = "string",
        SecretHeaders = 
        {
            { "string", "string" },
        },
        UseMtls = false,
        UseStaticIps = false,
    });
    
    example, err := descope.NewHttpConnector(ctx, "httpConnectorResource", &descope.HttpConnectorArgs{
    	BaseUrl:   pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    	Headers: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Rfc9421SigningEnabled: pulumi.Bool(false),
    	AwsRegion:             pulumi.String("string"),
    	AwsRoleArn:            pulumi.String("string"),
    	AwsSecretAccessKey:    pulumi.String("string"),
    	AwsService:            pulumi.String("string"),
    	AwsAuthType:           pulumi.String("string"),
    	CaCertificate:         pulumi.String("string"),
    	ClientCertificate:     pulumi.String("string"),
    	ClientKey:             pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	Disabled:              pulumi.Bool(false),
    	AwsExternalId:         pulumi.String("string"),
    	Authentication: &descope.HttpConnectorAuthenticationArgs{
    		ApiKey: &descope.HttpConnectorAuthenticationApiKeyArgs{
    			Key:   pulumi.String("string"),
    			Token: pulumi.String("string"),
    		},
    		Basic: &descope.HttpConnectorAuthenticationBasicArgs{
    			Password: pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    		BearerToken: pulumi.String("string"),
    		Oauth2ClientCredentials: &descope.HttpConnectorAuthenticationOauth2ClientCredentialsArgs{
    			AuthUrl:      pulumi.String("string"),
    			ClientId:     pulumi.String("string"),
    			ClientSecret: pulumi.String("string"),
    			AuthStyle:    pulumi.String("string"),
    			Scopes:       pulumi.String("string"),
    			TokenRequestHeaders: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    		},
    	},
    	Rfc9421Components:       pulumi.String("string"),
    	Insecure:                pulumi.Bool(false),
    	Name:                    pulumi.String("string"),
    	AwsAccessKeyId:          pulumi.String("string"),
    	IncludeHeadersInContext: pulumi.Bool(false),
    	Rfc9421KeyId:            pulumi.String("string"),
    	Rfc9421PrivateKey:       pulumi.String("string"),
    	Rfc9421SignatureTtl:     pulumi.Float64(0),
    	HmacSecret:              pulumi.String("string"),
    	SecretHeaders: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	UseMtls:      pulumi.Bool(false),
    	UseStaticIps: pulumi.Bool(false),
    })
    
    resource "descope_http_connector" "httpConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      base_url   = "string"
      project_id = "string"
      headers = {
        "string" = "string"
      }
      rfc9421_signing_enabled = false
      aws_region              = "string"
      aws_role_arn            = "string"
      aws_secret_access_key   = "string"
      aws_service             = "string"
      aws_auth_type           = "string"
      ca_certificate          = "string"
      client_certificate      = "string"
      client_key              = "string"
      description             = "string"
      disabled                = false
      aws_external_id         = "string"
      authentication = {
        api_key = {
          key   = "string"
          token = "string"
        }
        basic = {
          password = "string"
          username = "string"
        }
        bearer_token = "string"
        oauth2_client_credentials = {
          auth_url      = "string"
          client_id     = "string"
          client_secret = "string"
          auth_style    = "string"
          scopes        = "string"
          token_request_headers = {
            "string" = "string"
          }
        }
      }
      rfc9421_components         = "string"
      insecure                   = false
      name                       = "string"
      aws_access_key_id          = "string"
      include_headers_in_context = false
      rfc9421_key_id             = "string"
      rfc9421_private_key        = "string"
      rfc9421_signature_ttl      = 0
      hmac_secret                = "string"
      secret_headers = {
        "string" = "string"
      }
      use_mtls       = false
      use_static_ips = false
    }
    
    var httpConnectorResource = new HttpConnector("httpConnectorResource", HttpConnectorArgs.builder()
        .baseUrl("string")
        .projectId("string")
        .headers(Map.of("string", "string"))
        .rfc9421SigningEnabled(false)
        .awsRegion("string")
        .awsRoleArn("string")
        .awsSecretAccessKey("string")
        .awsService("string")
        .awsAuthType("string")
        .caCertificate("string")
        .clientCertificate("string")
        .clientKey("string")
        .description("string")
        .disabled(false)
        .awsExternalId("string")
        .authentication(HttpConnectorAuthenticationArgs.builder()
            .apiKey(HttpConnectorAuthenticationApiKeyArgs.builder()
                .key("string")
                .token("string")
                .build())
            .basic(HttpConnectorAuthenticationBasicArgs.builder()
                .password("string")
                .username("string")
                .build())
            .bearerToken("string")
            .oauth2ClientCredentials(HttpConnectorAuthenticationOauth2ClientCredentialsArgs.builder()
                .authUrl("string")
                .clientId("string")
                .clientSecret("string")
                .authStyle("string")
                .scopes("string")
                .tokenRequestHeaders(Map.of("string", "string"))
                .build())
            .build())
        .rfc9421Components("string")
        .insecure(false)
        .name("string")
        .awsAccessKeyId("string")
        .includeHeadersInContext(false)
        .rfc9421KeyId("string")
        .rfc9421PrivateKey("string")
        .rfc9421SignatureTtl(0.0)
        .hmacSecret("string")
        .secretHeaders(Map.of("string", "string"))
        .useMtls(false)
        .useStaticIps(false)
        .build());
    
    http_connector_resource = descope.HttpConnector("httpConnectorResource",
        base_url="string",
        project_id="string",
        headers={
            "string": "string",
        },
        rfc9421_signing_enabled=False,
        aws_region="string",
        aws_role_arn="string",
        aws_secret_access_key="string",
        aws_service="string",
        aws_auth_type="string",
        ca_certificate="string",
        client_certificate="string",
        client_key="string",
        description="string",
        disabled=False,
        aws_external_id="string",
        authentication={
            "api_key": {
                "key": "string",
                "token": "string",
            },
            "basic": {
                "password": "string",
                "username": "string",
            },
            "bearer_token": "string",
            "oauth2_client_credentials": {
                "auth_url": "string",
                "client_id": "string",
                "client_secret": "string",
                "auth_style": "string",
                "scopes": "string",
                "token_request_headers": {
                    "string": "string",
                },
            },
        },
        rfc9421_components="string",
        insecure=False,
        name="string",
        aws_access_key_id="string",
        include_headers_in_context=False,
        rfc9421_key_id="string",
        rfc9421_private_key="string",
        rfc9421_signature_ttl=float(0),
        hmac_secret="string",
        secret_headers={
            "string": "string",
        },
        use_mtls=False,
        use_static_ips=False)
    
    const httpConnectorResource = new descope.HttpConnector("httpConnectorResource", {
        baseUrl: "string",
        projectId: "string",
        headers: {
            string: "string",
        },
        rfc9421SigningEnabled: false,
        awsRegion: "string",
        awsRoleArn: "string",
        awsSecretAccessKey: "string",
        awsService: "string",
        awsAuthType: "string",
        caCertificate: "string",
        clientCertificate: "string",
        clientKey: "string",
        description: "string",
        disabled: false,
        awsExternalId: "string",
        authentication: {
            apiKey: {
                key: "string",
                token: "string",
            },
            basic: {
                password: "string",
                username: "string",
            },
            bearerToken: "string",
            oauth2ClientCredentials: {
                authUrl: "string",
                clientId: "string",
                clientSecret: "string",
                authStyle: "string",
                scopes: "string",
                tokenRequestHeaders: {
                    string: "string",
                },
            },
        },
        rfc9421Components: "string",
        insecure: false,
        name: "string",
        awsAccessKeyId: "string",
        includeHeadersInContext: false,
        rfc9421KeyId: "string",
        rfc9421PrivateKey: "string",
        rfc9421SignatureTtl: 0,
        hmacSecret: "string",
        secretHeaders: {
            string: "string",
        },
        useMtls: false,
        useStaticIps: false,
    });
    
    type: descope:HttpConnector
    properties:
        authentication:
            apiKey:
                key: string
                token: string
            basic:
                password: string
                username: string
            bearerToken: string
            oauth2ClientCredentials:
                authStyle: string
                authUrl: string
                clientId: string
                clientSecret: string
                scopes: string
                tokenRequestHeaders:
                    string: string
        awsAccessKeyId: string
        awsAuthType: string
        awsExternalId: string
        awsRegion: string
        awsRoleArn: string
        awsSecretAccessKey: string
        awsService: string
        baseUrl: string
        caCertificate: string
        clientCertificate: string
        clientKey: string
        description: string
        disabled: false
        headers:
            string: string
        hmacSecret: string
        includeHeadersInContext: false
        insecure: false
        name: string
        projectId: string
        rfc9421Components: string
        rfc9421KeyId: string
        rfc9421PrivateKey: string
        rfc9421SignatureTtl: 0
        rfc9421SigningEnabled: false
        secretHeaders:
            string: string
        useMtls: false
        useStaticIps: false
    

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

    BaseUrl string
    The base URL to fetch
    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.
    Authentication Descope.HttpConnectorAuthentication
    Authentication Information
    AwsAccessKeyId string
    The unique AWS access key ID.
    AwsAuthType string
    Apply AWS signature version 4 authentication to the request.
    AwsExternalId string
    The external ID to use when assuming the role.
    AwsRegion string
    The AWS region, e.g. us-east-1.
    AwsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    AwsSecretAccessKey string
    The secret AWS access key.
    AwsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    CaCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    ClientCertificate string
    The client certificate in PEM format for mTLS authentication.
    ClientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    Headers Dictionary<string, string>
    The headers to send with the request
    HmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    IncludeHeadersInContext bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    Insecure bool
    Will ignore certificate errors raised by the client
    Name string
    A custom name for your connector.
    Rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    Rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    Rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    Rfc9421SignatureTtl double
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    Rfc9421SigningEnabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    SecretHeaders Dictionary<string, string>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    UseMtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    BaseUrl string
    The base URL to fetch
    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.
    Authentication HttpConnectorAuthenticationArgs
    Authentication Information
    AwsAccessKeyId string
    The unique AWS access key ID.
    AwsAuthType string
    Apply AWS signature version 4 authentication to the request.
    AwsExternalId string
    The external ID to use when assuming the role.
    AwsRegion string
    The AWS region, e.g. us-east-1.
    AwsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    AwsSecretAccessKey string
    The secret AWS access key.
    AwsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    CaCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    ClientCertificate string
    The client certificate in PEM format for mTLS authentication.
    ClientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    Headers map[string]string
    The headers to send with the request
    HmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    IncludeHeadersInContext bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    Insecure bool
    Will ignore certificate errors raised by the client
    Name string
    A custom name for your connector.
    Rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    Rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    Rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    Rfc9421SignatureTtl float64
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    Rfc9421SigningEnabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    SecretHeaders map[string]string
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    UseMtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    base_url string
    The base URL to fetch
    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.
    authentication object
    Authentication Information
    aws_access_key_id string
    The unique AWS access key ID.
    aws_auth_type string
    Apply AWS signature version 4 authentication to the request.
    aws_external_id string
    The external ID to use when assuming the role.
    aws_region string
    The AWS region, e.g. us-east-1.
    aws_role_arn string
    The Amazon Resource Name (ARN) of the role to assume.
    aws_secret_access_key string
    The secret AWS access key.
    aws_service string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    ca_certificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    client_certificate string
    The client certificate in PEM format for mTLS authentication.
    client_key string
    The client private key in PEM format for mTLS authentication.
    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.
    headers map(string)
    The headers to send with the request
    hmac_secret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    include_headers_in_context bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure bool
    Will ignore certificate errors raised by the client
    name string
    A custom name for your connector.
    rfc9421_components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421_key_id string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421_private_key string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421_signature_ttl number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421_signing_enabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secret_headers map(string)
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    use_mtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    baseUrl String
    The base URL to fetch
    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.
    authentication HttpConnectorAuthentication
    Authentication Information
    awsAccessKeyId String
    The unique AWS access key ID.
    awsAuthType String
    Apply AWS signature version 4 authentication to the request.
    awsExternalId String
    The external ID to use when assuming the role.
    awsRegion String
    The AWS region, e.g. us-east-1.
    awsRoleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey String
    The secret AWS access key.
    awsService String
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    caCertificate String
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate String
    The client certificate in PEM format for mTLS authentication.
    clientKey String
    The client private key in PEM format for mTLS authentication.
    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.
    headers Map<String,String>
    The headers to send with the request
    hmacSecret String
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext Boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure Boolean
    Will ignore certificate errors raised by the client
    name String
    A custom name for your connector.
    rfc9421Components String
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId String
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey String
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl Double
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled Boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders Map<String,String>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls Boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    baseUrl string
    The base URL to fetch
    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.
    authentication HttpConnectorAuthentication
    Authentication Information
    awsAccessKeyId string
    The unique AWS access key ID.
    awsAuthType string
    Apply AWS signature version 4 authentication to the request.
    awsExternalId string
    The external ID to use when assuming the role.
    awsRegion string
    The AWS region, e.g. us-east-1.
    awsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey string
    The secret AWS access key.
    awsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    caCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate string
    The client certificate in PEM format for mTLS authentication.
    clientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    headers {[key: string]: string}
    The headers to send with the request
    hmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure boolean
    Will ignore certificate errors raised by the client
    name string
    A custom name for your connector.
    rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders {[key: string]: string}
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    base_url str
    The base URL to fetch
    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.
    authentication HttpConnectorAuthenticationArgs
    Authentication Information
    aws_access_key_id str
    The unique AWS access key ID.
    aws_auth_type str
    Apply AWS signature version 4 authentication to the request.
    aws_external_id str
    The external ID to use when assuming the role.
    aws_region str
    The AWS region, e.g. us-east-1.
    aws_role_arn str
    The Amazon Resource Name (ARN) of the role to assume.
    aws_secret_access_key str
    The secret AWS access key.
    aws_service str
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    ca_certificate str
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    client_certificate str
    The client certificate in PEM format for mTLS authentication.
    client_key str
    The client private key in PEM format for mTLS authentication.
    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.
    headers Mapping[str, str]
    The headers to send with the request
    hmac_secret str
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    include_headers_in_context bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure bool
    Will ignore certificate errors raised by the client
    name str
    A custom name for your connector.
    rfc9421_components str
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421_key_id str
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421_private_key str
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421_signature_ttl float
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421_signing_enabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secret_headers Mapping[str, str]
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    use_mtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    baseUrl String
    The base URL to fetch
    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.
    authentication Property Map
    Authentication Information
    awsAccessKeyId String
    The unique AWS access key ID.
    awsAuthType String
    Apply AWS signature version 4 authentication to the request.
    awsExternalId String
    The external ID to use when assuming the role.
    awsRegion String
    The AWS region, e.g. us-east-1.
    awsRoleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey String
    The secret AWS access key.
    awsService String
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    caCertificate String
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate String
    The client certificate in PEM format for mTLS authentication.
    clientKey String
    The client private key in PEM format for mTLS authentication.
    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.
    headers Map<String>
    The headers to send with the request
    hmacSecret String
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext Boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure Boolean
    Will ignore certificate errors raised by the client
    name String
    A custom name for your connector.
    rfc9421Components String
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId String
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey String
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl Number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled Boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders Map<String>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls Boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HttpConnector 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 HttpConnector Resource

    Get an existing HttpConnector 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?: HttpConnectorState, opts?: CustomResourceOptions): HttpConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication: Optional[HttpConnectorAuthenticationArgs] = None,
            aws_access_key_id: Optional[str] = None,
            aws_auth_type: Optional[str] = None,
            aws_external_id: Optional[str] = None,
            aws_region: Optional[str] = None,
            aws_role_arn: Optional[str] = None,
            aws_secret_access_key: Optional[str] = None,
            aws_service: Optional[str] = None,
            base_url: Optional[str] = None,
            ca_certificate: Optional[str] = None,
            client_certificate: Optional[str] = None,
            client_key: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            headers: Optional[Mapping[str, str]] = None,
            hmac_secret: Optional[str] = None,
            include_headers_in_context: Optional[bool] = None,
            insecure: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            rfc9421_components: Optional[str] = None,
            rfc9421_key_id: Optional[str] = None,
            rfc9421_private_key: Optional[str] = None,
            rfc9421_signature_ttl: Optional[float] = None,
            rfc9421_signing_enabled: Optional[bool] = None,
            secret_headers: Optional[Mapping[str, str]] = None,
            use_mtls: Optional[bool] = None,
            use_static_ips: Optional[bool] = None) -> HttpConnector
    func GetHttpConnector(ctx *Context, name string, id IDInput, state *HttpConnectorState, opts ...ResourceOption) (*HttpConnector, error)
    public static HttpConnector Get(string name, Input<string> id, HttpConnectorState? state, CustomResourceOptions? opts = null)
    public static HttpConnector get(String name, Output<String> id, HttpConnectorState state, CustomResourceOptions options)
    resources:  existingHttpConnector:    type: descope:HttpConnector    get:      id: ${id}
    import {
      to = descope_http_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 HttpConnectorState
    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 HttpConnectorState
    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 HttpConnectorState
    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 HttpConnectorState
    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:
    Authentication Descope.HttpConnectorAuthentication
    Authentication Information
    AwsAccessKeyId string
    The unique AWS access key ID.
    AwsAuthType string
    Apply AWS signature version 4 authentication to the request.
    AwsExternalId string
    The external ID to use when assuming the role.
    AwsRegion string
    The AWS region, e.g. us-east-1.
    AwsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    AwsSecretAccessKey string
    The secret AWS access key.
    AwsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    BaseUrl string
    The base URL to fetch
    CaCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    ClientCertificate string
    The client certificate in PEM format for mTLS authentication.
    ClientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    Headers Dictionary<string, string>
    The headers to send with the request
    HmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    IncludeHeadersInContext bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    Insecure bool
    Will ignore certificate errors raised by the client
    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.
    Rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    Rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    Rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    Rfc9421SignatureTtl double
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    Rfc9421SigningEnabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    SecretHeaders Dictionary<string, string>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    UseMtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    Authentication HttpConnectorAuthenticationArgs
    Authentication Information
    AwsAccessKeyId string
    The unique AWS access key ID.
    AwsAuthType string
    Apply AWS signature version 4 authentication to the request.
    AwsExternalId string
    The external ID to use when assuming the role.
    AwsRegion string
    The AWS region, e.g. us-east-1.
    AwsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    AwsSecretAccessKey string
    The secret AWS access key.
    AwsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    BaseUrl string
    The base URL to fetch
    CaCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    ClientCertificate string
    The client certificate in PEM format for mTLS authentication.
    ClientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    Headers map[string]string
    The headers to send with the request
    HmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    IncludeHeadersInContext bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    Insecure bool
    Will ignore certificate errors raised by the client
    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.
    Rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    Rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    Rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    Rfc9421SignatureTtl float64
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    Rfc9421SigningEnabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    SecretHeaders map[string]string
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    UseMtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    authentication object
    Authentication Information
    aws_access_key_id string
    The unique AWS access key ID.
    aws_auth_type string
    Apply AWS signature version 4 authentication to the request.
    aws_external_id string
    The external ID to use when assuming the role.
    aws_region string
    The AWS region, e.g. us-east-1.
    aws_role_arn string
    The Amazon Resource Name (ARN) of the role to assume.
    aws_secret_access_key string
    The secret AWS access key.
    aws_service string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    base_url string
    The base URL to fetch
    ca_certificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    client_certificate string
    The client certificate in PEM format for mTLS authentication.
    client_key string
    The client private key in PEM format for mTLS authentication.
    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.
    headers map(string)
    The headers to send with the request
    hmac_secret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    include_headers_in_context bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure bool
    Will ignore certificate errors raised by the client
    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.
    rfc9421_components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421_key_id string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421_private_key string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421_signature_ttl number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421_signing_enabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secret_headers map(string)
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    use_mtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    authentication HttpConnectorAuthentication
    Authentication Information
    awsAccessKeyId String
    The unique AWS access key ID.
    awsAuthType String
    Apply AWS signature version 4 authentication to the request.
    awsExternalId String
    The external ID to use when assuming the role.
    awsRegion String
    The AWS region, e.g. us-east-1.
    awsRoleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey String
    The secret AWS access key.
    awsService String
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    baseUrl String
    The base URL to fetch
    caCertificate String
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate String
    The client certificate in PEM format for mTLS authentication.
    clientKey String
    The client private key in PEM format for mTLS authentication.
    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.
    headers Map<String,String>
    The headers to send with the request
    hmacSecret String
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext Boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure Boolean
    Will ignore certificate errors raised by the client
    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.
    rfc9421Components String
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId String
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey String
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl Double
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled Boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders Map<String,String>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls Boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    authentication HttpConnectorAuthentication
    Authentication Information
    awsAccessKeyId string
    The unique AWS access key ID.
    awsAuthType string
    Apply AWS signature version 4 authentication to the request.
    awsExternalId string
    The external ID to use when assuming the role.
    awsRegion string
    The AWS region, e.g. us-east-1.
    awsRoleArn string
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey string
    The secret AWS access key.
    awsService string
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    baseUrl string
    The base URL to fetch
    caCertificate string
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate string
    The client certificate in PEM format for mTLS authentication.
    clientKey string
    The client private key in PEM format for mTLS authentication.
    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.
    headers {[key: string]: string}
    The headers to send with the request
    hmacSecret string
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure boolean
    Will ignore certificate errors raised by the client
    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.
    rfc9421Components string
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId string
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey string
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders {[key: string]: string}
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    authentication HttpConnectorAuthenticationArgs
    Authentication Information
    aws_access_key_id str
    The unique AWS access key ID.
    aws_auth_type str
    Apply AWS signature version 4 authentication to the request.
    aws_external_id str
    The external ID to use when assuming the role.
    aws_region str
    The AWS region, e.g. us-east-1.
    aws_role_arn str
    The Amazon Resource Name (ARN) of the role to assume.
    aws_secret_access_key str
    The secret AWS access key.
    aws_service str
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    base_url str
    The base URL to fetch
    ca_certificate str
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    client_certificate str
    The client certificate in PEM format for mTLS authentication.
    client_key str
    The client private key in PEM format for mTLS authentication.
    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.
    headers Mapping[str, str]
    The headers to send with the request
    hmac_secret str
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    include_headers_in_context bool
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure bool
    Will ignore certificate errors raised by the client
    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.
    rfc9421_components str
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421_key_id str
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421_private_key str
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421_signature_ttl float
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421_signing_enabled bool
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secret_headers Mapping[str, str]
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    use_mtls bool
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    authentication Property Map
    Authentication Information
    awsAccessKeyId String
    The unique AWS access key ID.
    awsAuthType String
    Apply AWS signature version 4 authentication to the request.
    awsExternalId String
    The external ID to use when assuming the role.
    awsRegion String
    The AWS region, e.g. us-east-1.
    awsRoleArn String
    The Amazon Resource Name (ARN) of the role to assume.
    awsSecretAccessKey String
    The secret AWS access key.
    awsService String
    The AWS service to target, e.g. lambda, execute-api, s3, etc.
    baseUrl String
    The base URL to fetch
    caCertificate String
    The Certificate Authority certificate in PEM format, for endpoints whose server certificate is signed by a private or internal CA. Leave empty to verify against the public trust store.
    clientCertificate String
    The client certificate in PEM format for mTLS authentication.
    clientKey String
    The client private key in PEM format for mTLS authentication.
    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.
    headers Map<String>
    The headers to send with the request
    hmacSecret String
    HMAC is a method for message signing with a symmetrical key. This secret will be used to sign the base64 encoded payload, and the resulting signature will be sent in the x-descope-webhook-s256 header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature
    includeHeadersInContext Boolean
    The connector response context will also include the headers and status code. The context will have a "body" attribute, a "headers" attribute, and a "statusCode" attribute. See more details in the help guide
    insecure Boolean
    Will ignore certificate errors raised by the client
    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.
    rfc9421Components String
    HTTP message components to include in the signature (e.g., @method, @target-uri, @authority, content-type, content-digest). Leave empty to use defaults: @method, @target-uri, @authority
    rfc9421KeyId String
    Identifier for the signing key. This will be included in the signature metadata to help the recipient identify which key was used for verification
    rfc9421PrivateKey String
    Provide a private key in PEM format or an HMAC secret. Algorithms such as ECDSA P-256/P-384, Ed25519, and RSA are supported. You can paste the key with or without newlines; both formats are accepted.
    rfc9421SignatureTtl Number
    How long the signature is valid for, in seconds. Default is 300 seconds (5 minutes). The signature includes automatic replay protection via a randomly generated nonce
    rfc9421SigningEnabled Boolean
    Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
    secretHeaders Map<String>
    The headers to send with the request. Values set here are stored encrypted and are never returned by the API, so they are not read back into the Terraform state.
    useMtls Boolean
    Present a client certificate during the TLS handshake. Requires an https:// base URL. Independent of the Authentication method above, so it can be combined with a bearer token, API key, basic auth or OAuth 2.0 client credentials.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Supporting Types

    HttpConnectorAuthentication, HttpConnectorAuthenticationArgs

    ApiKey Descope.HttpConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic Descope.HttpConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials Descope.HttpConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    ApiKey HttpConnectorAuthenticationApiKey
    API key authentication configuration.
    Basic HttpConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    BearerToken string
    Bearer token for HTTP authentication.
    Oauth2ClientCredentials HttpConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    api_key object
    API key authentication configuration.
    basic object
    Basic authentication credentials (username and password).
    bearer_token string
    Bearer token for HTTP authentication.
    oauth2_client_credentials object
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey HttpConnectorAuthenticationApiKey
    API key authentication configuration.
    basic HttpConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials HttpConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey HttpConnectorAuthenticationApiKey
    API key authentication configuration.
    basic HttpConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearerToken string
    Bearer token for HTTP authentication.
    oauth2ClientCredentials HttpConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    api_key HttpConnectorAuthenticationApiKey
    API key authentication configuration.
    basic HttpConnectorAuthenticationBasic
    Basic authentication credentials (username and password).
    bearer_token str
    Bearer token for HTTP authentication.
    oauth2_client_credentials HttpConnectorAuthenticationOauth2ClientCredentials
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
    apiKey Property Map
    API key authentication configuration.
    basic Property Map
    Basic authentication credentials (username and password).
    bearerToken String
    Bearer token for HTTP authentication.
    oauth2ClientCredentials Property Map
    OAuth 2.0 client credentials configuration used to fetch an access token before making requests.

    HttpConnectorAuthenticationApiKey, HttpConnectorAuthenticationApiKeyArgs

    Key string
    The API key.
    Token string
    The API secret.
    Key string
    The API key.
    Token string
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key String
    The API key.
    token String
    The API secret.
    key string
    The API key.
    token string
    The API secret.
    key str
    The API key.
    token str
    The API secret.
    key String
    The API key.
    token String
    The API secret.

    HttpConnectorAuthenticationBasic, HttpConnectorAuthenticationBasicArgs

    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    Password string
    Password for basic HTTP authentication.
    Username string
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.
    password string
    Password for basic HTTP authentication.
    username string
    Username for basic HTTP authentication.
    password str
    Password for basic HTTP authentication.
    username str
    Username for basic HTTP authentication.
    password String
    Password for basic HTTP authentication.
    username String
    Username for basic HTTP authentication.

    HttpConnectorAuthenticationOauth2ClientCredentials, HttpConnectorAuthenticationOauth2ClientCredentialsArgs

    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders Dictionary<string, string>
    Additional headers to include in the token request sent to the token endpoint.
    AuthUrl string
    The token endpoint URL used to request an access token.
    ClientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    ClientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    AuthStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    Scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    TokenRequestHeaders map[string]string
    Additional headers to include in the token request sent to the token endpoint.
    auth_url string
    The token endpoint URL used to request an access token.
    client_id string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    client_secret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    auth_style string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers map(string)
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String,String>
    Additional headers to include in the token request sent to the token endpoint.
    authUrl string
    The token endpoint URL used to request an access token.
    clientId string
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret string
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle string
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes string
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders {[key: string]: string}
    Additional headers to include in the token request sent to the token endpoint.
    auth_url str
    The token endpoint URL used to request an access token.
    client_id str
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    client_secret str
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    auth_style str
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes str
    A space-separated list of OAuth scopes to request when fetching the access token.
    token_request_headers Mapping[str, str]
    Additional headers to include in the token request sent to the token endpoint.
    authUrl String
    The token endpoint URL used to request an access token.
    clientId String
    The OAuth 2.0 client ID used to authenticate against the token endpoint.
    clientSecret String
    The OAuth 2.0 client secret used to authenticate against the token endpoint.
    authStyle String
    How the client credentials are sent to the token endpoint. Either header to send them in the Authorization header, or body to send them in the request body.
    scopes String
    A space-separated list of OAuth scopes to request when fetching the access token.
    tokenRequestHeaders Map<String>
    Additional headers to include in the token request sent to the token endpoint.

    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