published on Sunday, Sep 13, 2026 by Pulumi
published on Sunday, Sep 13, 2026 by Pulumi
Manages HMAC-SHA256 signing keys used to verify HTTP Message Signatures on Network ACL rules. The key material (value) is write-only: it is not returned by the API and is not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints. (EA Only)
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
// Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
// The key material (value) is write-only and not stored in Terraform state.
const myKey = new auth0.NetworkAclKey("my_key", {
name: "my-hmac-key",
alg: "hmac-sha256",
value: hmacKeyBase64,
});
// Reference the key in a Network ACL rule to allow only signed requests.
const allowSignedOnly = new auth0.NetworkAcl("allow_signed_only", {
description: "Block requests without a valid HMAC signature",
active: true,
priority: 99,
rule: {
action: {
block: true,
},
scope: "tenant",
notMatch: {
httpMessageSignature: {
keys: [{
id: myKey.id,
}],
},
},
},
});
import pulumi
import pulumi_auth0 as auth0
# Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
# The key material (value) is write-only and not stored in Terraform state.
my_key = auth0.NetworkAclKey("my_key",
name="my-hmac-key",
alg="hmac-sha256",
value=hmac_key_base64)
# Reference the key in a Network ACL rule to allow only signed requests.
allow_signed_only = auth0.NetworkAcl("allow_signed_only",
description="Block requests without a valid HMAC signature",
active=True,
priority=99,
rule={
"action": {
"block": True,
},
"scope": "tenant",
"not_match": {
"http_message_signature": {
"keys": [{
"id": my_key.id,
}],
},
},
})
package main
import (
"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
// The key material (value) is write-only and not stored in Terraform state.
myKey, err := auth0.NewNetworkAclKey(ctx, "my_key", &auth0.NetworkAclKeyArgs{
Name: pulumi.String("my-hmac-key"),
Alg: pulumi.String("hmac-sha256"),
Value: pulumi.Any(hmacKeyBase64),
})
if err != nil {
return err
}
// Reference the key in a Network ACL rule to allow only signed requests.
_, err = auth0.NewNetworkAcl(ctx, "allow_signed_only", &auth0.NetworkAclArgs{
Description: pulumi.String("Block requests without a valid HMAC signature"),
Active: pulumi.Bool(true),
Priority: pulumi.Int(99),
Rule: &auth0.NetworkAclRuleArgs{
Action: &auth0.NetworkAclRuleActionArgs{
Block: pulumi.Bool(true),
},
Scope: pulumi.String("tenant"),
NotMatch: &auth0.NetworkAclRuleNotMatchArgs{
HttpMessageSignature: &auth0.NetworkAclRuleNotMatchHttpMessageSignatureArgs{
Keys: auth0.NetworkAclRuleNotMatchHttpMessageSignatureKeyArray{
&auth0.NetworkAclRuleNotMatchHttpMessageSignatureKeyArgs{
Id: myKey.ID().ToIDOutput().ToStringOutput(),
},
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;
return await Deployment.RunAsync(() =>
{
// Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
// The key material (value) is write-only and not stored in Terraform state.
var myKey = new Auth0.NetworkAclKey("my_key", new()
{
Name = "my-hmac-key",
Alg = "hmac-sha256",
Value = hmacKeyBase64,
});
// Reference the key in a Network ACL rule to allow only signed requests.
var allowSignedOnly = new Auth0.NetworkAcl("allow_signed_only", new()
{
Description = "Block requests without a valid HMAC signature",
Active = true,
Priority = 99,
Rule = new Auth0.Inputs.NetworkAclRuleArgs
{
Action = new Auth0.Inputs.NetworkAclRuleActionArgs
{
Block = true,
},
Scope = "tenant",
NotMatch = new Auth0.Inputs.NetworkAclRuleNotMatchArgs
{
HttpMessageSignature = new Auth0.Inputs.NetworkAclRuleNotMatchHttpMessageSignatureArgs
{
Keys = new[]
{
new Auth0.Inputs.NetworkAclRuleNotMatchHttpMessageSignatureKeyArgs
{
Id = myKey.Id,
},
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.NetworkAclKey;
import com.pulumi.auth0.NetworkAclKeyArgs;
import com.pulumi.auth0.NetworkAcl;
import com.pulumi.auth0.NetworkAclArgs;
import com.pulumi.auth0.inputs.NetworkAclRuleArgs;
import com.pulumi.auth0.inputs.NetworkAclRuleActionArgs;
import com.pulumi.auth0.inputs.NetworkAclRuleNotMatchArgs;
import com.pulumi.auth0.inputs.NetworkAclRuleNotMatchHttpMessageSignatureArgs;
import com.pulumi.auth0.inputs.NetworkAclRuleNotMatchHttpMessageSignatureKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
// The key material (value) is write-only and not stored in Terraform state.
var myKey = new NetworkAclKey("myKey", NetworkAclKeyArgs.builder()
.name("my-hmac-key")
.alg("hmac-sha256")
.value(hmacKeyBase64)
.build());
// Reference the key in a Network ACL rule to allow only signed requests.
var allowSignedOnly = new NetworkAcl("allowSignedOnly", NetworkAclArgs.builder()
.description("Block requests without a valid HMAC signature")
.active(true)
.priority(99)
.rule(NetworkAclRuleArgs.builder()
.action(NetworkAclRuleActionArgs.builder()
.block(true)
.build())
.scope("tenant")
.notMatch(NetworkAclRuleNotMatchArgs.builder()
.httpMessageSignature(NetworkAclRuleNotMatchHttpMessageSignatureArgs.builder()
.keys(NetworkAclRuleNotMatchHttpMessageSignatureKeyArgs.builder()
.id(myKey.id())
.build())
.build())
.build())
.build())
.build());
}
}
resources:
# Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
# The key material (value) is write-only and not stored in Terraform state.
myKey:
type: auth0:NetworkAclKey
name: my_key
properties:
name: my-hmac-key
alg: hmac-sha256
value: ${hmacKeyBase64}
# Reference the key in a Network ACL rule to allow only signed requests.
allowSignedOnly:
type: auth0:NetworkAcl
name: allow_signed_only
properties:
description: Block requests without a valid HMAC signature
active: true
priority: 99
rule:
action:
block: true
scope: tenant
notMatch:
httpMessageSignature:
keys:
- id: ${myKey.id}
pulumi {
required_providers {
auth0 = {
source = "pulumi/auth0"
}
}
}
# Create an HMAC-SHA256 key for Network ACL HTTP Message Signature verification.
# The key material (value) is write-only and not stored in Terraform state.
resource "auth0_networkaclkey" "my_key" {
name = "my-hmac-key"
alg = "hmac-sha256"
value = hmacKeyBase64
}
# Reference the key in a Network ACL rule to allow only signed requests.
resource "auth0_networkacl" "allow_signed_only" {
description = "Block requests without a valid HMAC signature"
active = true
priority = 99
rule = {
action = {
block = true
}
scope = "tenant"
not_match = {
http_message_signature = {
keys = [{
"id" = auth0_networkaclkey.my_key.id
}]
}
}
}
}
Create NetworkAclKey Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkAclKey(name: string, args: NetworkAclKeyArgs, opts?: CustomResourceOptions);@overload
def NetworkAclKey(resource_name: str,
args: NetworkAclKeyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkAclKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
alg: Optional[str] = None,
value: Optional[str] = None,
name: Optional[str] = None)func NewNetworkAclKey(ctx *Context, name string, args NetworkAclKeyArgs, opts ...ResourceOption) (*NetworkAclKey, error)public NetworkAclKey(string name, NetworkAclKeyArgs args, CustomResourceOptions? opts = null)
public NetworkAclKey(String name, NetworkAclKeyArgs args)
public NetworkAclKey(String name, NetworkAclKeyArgs args, CustomResourceOptions options)
type: auth0:NetworkAclKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "auth0_network_acl_key" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args NetworkAclKeyArgs
- 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 NetworkAclKeyArgs
- 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 NetworkAclKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkAclKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkAclKeyArgs
- 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 networkAclKeyResource = new Auth0.NetworkAclKey("networkAclKeyResource", new()
{
Alg = "string",
Value = "string",
Name = "string",
});
example, err := auth0.NewNetworkAclKey(ctx, "networkAclKeyResource", &auth0.NetworkAclKeyArgs{
Alg: pulumi.String("string"),
Value: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "auth0_network_acl_key" "networkAclKeyResource" {
lifecycle {
create_before_destroy = true
}
alg = "string"
value = "string"
name = "string"
}
var networkAclKeyResource = new NetworkAclKey("networkAclKeyResource", NetworkAclKeyArgs.builder()
.alg("string")
.value("string")
.name("string")
.build());
network_acl_key_resource = auth0.NetworkAclKey("networkAclKeyResource",
alg="string",
value="string",
name="string")
const networkAclKeyResource = new auth0.NetworkAclKey("networkAclKeyResource", {
alg: "string",
value: "string",
name: "string",
});
type: auth0:NetworkAclKey
properties:
alg: string
name: string
value: string
NetworkAclKey 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 NetworkAclKey resource accepts the following input properties:
- Alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - Value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- Name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- Alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - Value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- Name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- alg String
- Algorithm used for the key. Currently only
hmac-sha256is supported. - value String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- name String
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- alg str
- Algorithm used for the key. Currently only
hmac-sha256is supported. - value str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- name str
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- alg String
- Algorithm used for the key. Currently only
hmac-sha256is supported. - value String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- name String
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkAclKey resource produces the following output properties:
- Created
At string - Time when the key was created.
- Fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - Time when the key was last updated.
- Created
At string - Time when the key was created.
- Fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - Time when the key was last updated.
- created_
at string - Time when the key was created.
- fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - Time when the key was last updated.
- created
At String - Time when the key was created.
- fingerprint String
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - Time when the key was last updated.
- created
At string - Time when the key was created.
- fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - Time when the key was last updated.
- created_
at str - Time when the key was created.
- fingerprint str
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Time when the key was last updated.
- created
At String - Time when the key was created.
- fingerprint String
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - Time when the key was last updated.
Look up Existing NetworkAclKey Resource
Get an existing NetworkAclKey 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?: NetworkAclKeyState, opts?: CustomResourceOptions): NetworkAclKey@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alg: Optional[str] = None,
created_at: Optional[str] = None,
fingerprint: Optional[str] = None,
name: Optional[str] = None,
updated_at: Optional[str] = None,
value: Optional[str] = None) -> NetworkAclKeyfunc GetNetworkAclKey(ctx *Context, name string, id IDInput, state *NetworkAclKeyState, opts ...ResourceOption) (*NetworkAclKey, error)public static NetworkAclKey Get(string name, Input<string> id, NetworkAclKeyState? state, CustomResourceOptions? opts = null)public static NetworkAclKey get(String name, Output<String> id, NetworkAclKeyState state, CustomResourceOptions options)resources: _: type: auth0:NetworkAclKey get: id: ${id}import {
to = auth0_network_acl_key.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - Created
At string - Time when the key was created.
- Fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- Name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- Updated
At string - Time when the key was last updated.
- Value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- Alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - Created
At string - Time when the key was created.
- Fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- Name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- Updated
At string - Time when the key was last updated.
- Value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - created_
at string - Time when the key was created.
- fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- updated_
at string - Time when the key was last updated.
- value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- alg String
- Algorithm used for the key. Currently only
hmac-sha256is supported. - created
At String - Time when the key was created.
- fingerprint String
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- name String
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- updated
At String - Time when the key was last updated.
- value String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- alg string
- Algorithm used for the key. Currently only
hmac-sha256is supported. - created
At string - Time when the key was created.
- fingerprint string
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- name string
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- updated
At string - Time when the key was last updated.
- value string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- alg str
- Algorithm used for the key. Currently only
hmac-sha256is supported. - created_
at str - Time when the key was created.
- fingerprint str
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- name str
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- updated_
at str - Time when the key was last updated.
- value str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
- alg String
- Algorithm used for the key. Currently only
hmac-sha256is supported. - created
At String - Time when the key was created.
- fingerprint String
- SHA-256 fingerprint of the decoded key material (lowercase hex). Used for drift detection.
- name String
- User-supplied label for the key. Must be unique across all Network ACL keys for the tenant. Max 255 characters.
- updated
At String - Time when the key was last updated.
- value String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. Base64-encoded raw key material. The decoded value must be between 32 and 512 bytes. This field is write-only: it is not returned by the API and not stored in Terraform state. Changes are detected by comparing SHA-256 fingerprints.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0Terraform Provider.
published on Sunday, Sep 13, 2026 by Pulumi