published on Sunday, Oct 11, 2026 by Descope
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:
- 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
Descope.
Http Connector Authentication - Authentication Information
- Aws
Access stringKey Id - The unique AWS access key ID.
- Aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- Aws
External stringId - The external ID to use when assuming the role.
- Aws
Region string - The AWS region, e.g.
us-east-1. - Aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- Aws
Secret stringAccess Key - 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 Dictionary<string, 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Include
Headers boolIn Context - 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
- Rfc9421Key
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
- Rfc9421Private
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.
- Rfc9421Signature
Ttl 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
- Rfc9421Signing
Enabled bool - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- Secret
Headers 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.
- 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 boolIps - 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
Http
Connector Authentication Args - Authentication Information
- Aws
Access stringKey Id - The unique AWS access key ID.
- Aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- Aws
External stringId - The external ID to use when assuming the role.
- Aws
Region string - The AWS region, e.g.
us-east-1. - Aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- Aws
Secret stringAccess Key - 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]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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Include
Headers boolIn Context - 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
- Rfc9421Key
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
- Rfc9421Private
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.
- Rfc9421Signature
Ttl 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
- Rfc9421Signing
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]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 boolIps - 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_ stringkey_ id - The unique AWS access key ID.
- aws_
auth_ stringtype - Apply AWS signature version 4 authentication to the request.
- aws_
external_ stringid - The external ID to use when assuming the role.
- aws_
region string - The AWS region, e.g.
us-east-1. - aws_
role_ stringarn - The Amazon Resource Name (ARN) of the role to assume.
- aws_
secret_ stringaccess_ key - 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include_
headers_ boolin_ context - 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_ stringid - 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_ stringkey - 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_ numberttl - 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_ boolenabled - 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_ boolips - 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
Http
Connector Authentication - Authentication Information
- aws
Access StringKey Id - The unique AWS access key ID.
- aws
Auth StringType - Apply AWS signature version 4 authentication to the request.
- aws
External StringId - The external ID to use when assuming the role.
- aws
Region String - The AWS region, e.g.
us-east-1. - aws
Role StringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret StringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers BooleanIn Context - 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
Ttl 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
- rfc9421Signing
Enabled Boolean - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- secret
Headers 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.
- use
Mtls 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. - use
Static BooleanIps - 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
Http
Connector Authentication - Authentication Information
- aws
Access stringKey Id - The unique AWS access key ID.
- aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- aws
External stringId - The external ID to use when assuming the role.
- aws
Region string - The AWS region, e.g.
us-east-1. - aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret stringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers booleanIn Context - 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
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
- rfc9421Signing
Enabled boolean - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- secret
Headers {[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.
- use
Mtls 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. - use
Static booleanIps - 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
Http
Connector Authentication Args - Authentication Information
- aws_
access_ strkey_ id - The unique AWS access key ID.
- aws_
auth_ strtype - Apply AWS signature version 4 authentication to the request.
- aws_
external_ strid - The external ID to use when assuming the role.
- aws_
region str - The AWS region, e.g.
us-east-1. - aws_
role_ strarn - The Amazon Resource Name (ARN) of the role to assume.
- aws_
secret_ straccess_ key - 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include_
headers_ boolin_ context - 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_ strid - 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_ strkey - 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_ floatttl - 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_ boolenabled - 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_ boolips - 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 Property Map
- Authentication Information
- aws
Access StringKey Id - The unique AWS access key ID.
- aws
Auth StringType - Apply AWS signature version 4 authentication to the request.
- aws
External StringId - The external ID to use when assuming the role.
- aws
Region String - The AWS region, e.g.
us-east-1. - aws
Role StringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret StringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers BooleanIn Context - 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
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
- rfc9421Signing
Enabled Boolean - 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 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. - use
Static BooleanIps - 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) -> HttpConnectorfunc 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.
- Authentication
Descope.
Http Connector Authentication - Authentication Information
- Aws
Access stringKey Id - The unique AWS access key ID.
- Aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- Aws
External stringId - The external ID to use when assuming the role.
- Aws
Region string - The AWS region, e.g.
us-east-1. - Aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- Aws
Secret stringAccess Key - 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 Dictionary<string, 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Include
Headers boolIn Context - 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.
- 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
- Rfc9421Key
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
- Rfc9421Private
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.
- Rfc9421Signature
Ttl 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
- Rfc9421Signing
Enabled bool - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- Secret
Headers 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.
- 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 boolIps - Whether the connector should send all requests from specific static IPs.
- Authentication
Http
Connector Authentication Args - Authentication Information
- Aws
Access stringKey Id - The unique AWS access key ID.
- Aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- Aws
External stringId - The external ID to use when assuming the role.
- Aws
Region string - The AWS region, e.g.
us-east-1. - Aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- Aws
Secret stringAccess Key - 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]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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - Include
Headers boolIn Context - 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.
- 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
- Rfc9421Key
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
- Rfc9421Private
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.
- Rfc9421Signature
Ttl 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
- Rfc9421Signing
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]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 boolIps - Whether the connector should send all requests from specific static IPs.
- authentication object
- Authentication Information
- aws_
access_ stringkey_ id - The unique AWS access key ID.
- aws_
auth_ stringtype - Apply AWS signature version 4 authentication to the request.
- aws_
external_ stringid - The external ID to use when assuming the role.
- aws_
region string - The AWS region, e.g.
us-east-1. - aws_
role_ stringarn - The Amazon Resource Name (ARN) of the role to assume.
- aws_
secret_ stringaccess_ key - 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include_
headers_ boolin_ context - 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_ stringid - 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_ stringkey - 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_ numberttl - 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_ boolenabled - 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_ boolips - Whether the connector should send all requests from specific static IPs.
- authentication
Http
Connector Authentication - Authentication Information
- aws
Access StringKey Id - The unique AWS access key ID.
- aws
Auth StringType - Apply AWS signature version 4 authentication to the request.
- aws
External StringId - The external ID to use when assuming the role.
- aws
Region String - The AWS region, e.g.
us-east-1. - aws
Role StringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret StringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers BooleanIn Context - 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.
- 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.
- 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
Ttl 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
- rfc9421Signing
Enabled Boolean - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- secret
Headers 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.
- use
Mtls 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. - use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- authentication
Http
Connector Authentication - Authentication Information
- aws
Access stringKey Id - The unique AWS access key ID.
- aws
Auth stringType - Apply AWS signature version 4 authentication to the request.
- aws
External stringId - The external ID to use when assuming the role.
- aws
Region string - The AWS region, e.g.
us-east-1. - aws
Role stringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret stringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers booleanIn Context - 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.
- 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.
- 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
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
- rfc9421Signing
Enabled boolean - Enable RFC 9421 HTTP Message Signatures for cryptographically signing requests. Supports multiple algorithms including ECDSA, Ed25519, RSA, and HMAC
- secret
Headers {[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.
- use
Mtls 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. - use
Static booleanIps - Whether the connector should send all requests from specific static IPs.
- authentication
Http
Connector Authentication Args - Authentication Information
- aws_
access_ strkey_ id - The unique AWS access key ID.
- aws_
auth_ strtype - Apply AWS signature version 4 authentication to the request.
- aws_
external_ strid - The external ID to use when assuming the role.
- aws_
region str - The AWS region, e.g.
us-east-1. - aws_
role_ strarn - The Amazon Resource Name (ARN) of the role to assume.
- aws_
secret_ straccess_ key - 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include_
headers_ boolin_ context - 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_ strid - 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_ strkey - 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_ floatttl - 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_ boolenabled - 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_ boolips - Whether the connector should send all requests from specific static IPs.
- authentication Property Map
- Authentication Information
- aws
Access StringKey Id - The unique AWS access key ID.
- aws
Auth StringType - Apply AWS signature version 4 authentication to the request.
- aws
External StringId - The external ID to use when assuming the role.
- aws
Region String - The AWS region, e.g.
us-east-1. - aws
Role StringArn - The Amazon Resource Name (ARN) of the role to assume.
- aws
Secret StringAccess Key - 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 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
- 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-s256header. The receiving service should use this secret to verify the integrity and authenticity of the payload by checking the provided signature - include
Headers BooleanIn Context - 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.
- 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.
- 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
- rfc9421Key
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
- rfc9421Private
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.
- rfc9421Signature
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
- rfc9421Signing
Enabled Boolean - 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 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. - use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
Supporting Types
HttpConnectorAuthentication, HttpConnectorAuthenticationArgs
- Api
Key Descope.Http Connector Authentication Api Key - API key authentication configuration.
- Basic
Descope.
Http Connector Authentication Basic - Basic authentication credentials (username and password).
- Bearer
Token string - Bearer token for HTTP authentication.
- Oauth2Client
Credentials Descope.Http Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- Api
Key HttpConnector Authentication Api Key - API key authentication configuration.
- Basic
Http
Connector Authentication Basic - Basic authentication credentials (username and password).
- Bearer
Token string - Bearer token for HTTP authentication.
- Oauth2Client
Credentials HttpConnector Authentication Oauth2Client Credentials - 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_ objectcredentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key HttpConnector Authentication Api Key - API key authentication configuration.
- basic
Http
Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer
Token String - Bearer token for HTTP authentication.
- oauth2Client
Credentials HttpConnector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key HttpConnector Authentication Api Key - API key authentication configuration.
- basic
Http
Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer
Token string - Bearer token for HTTP authentication.
- oauth2Client
Credentials HttpConnector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api_
key HttpConnector Authentication Api Key - API key authentication configuration.
- basic
Http
Connector Authentication Basic - Basic authentication credentials (username and password).
- bearer_
token str - Bearer token for HTTP authentication.
- oauth2_
client_ Httpcredentials Connector Authentication Oauth2Client Credentials - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
- api
Key Property Map - API key authentication configuration.
- basic Property Map
- Basic authentication credentials (username and password).
- bearer
Token String - Bearer token for HTTP authentication.
- oauth2Client
Credentials Property Map - OAuth 2.0 client credentials configuration used to fetch an access token before making requests.
HttpConnectorAuthenticationApiKey, HttpConnectorAuthenticationApiKeyArgs
HttpConnectorAuthenticationBasic, HttpConnectorAuthenticationBasicArgs
HttpConnectorAuthenticationOauth2ClientCredentials, HttpConnectorAuthenticationOauth2ClientCredentialsArgs
- 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - Scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- Token
Request Dictionary<string, string>Headers - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - Scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- Token
Request map[string]stringHeaders - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- token_
request_ map(string)headers - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes String
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request Map<String,String>Headers - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes string
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request {[key: string]: string}Headers - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes str
- A space-separated list of OAuth scopes to request when fetching the access token.
- token_
request_ Mapping[str, str]headers - 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
headerto send them in theAuthorizationheader, orbodyto send them in the request body. - scopes String
- A space-separated list of OAuth scopes to request when fetching the access token.
- token
Request Map<String>Headers - 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
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope