1. Packages
  2. Auth0 Provider
  3. API Docs
  4. SupplementalSignals
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

auth0.SupplementalSignals

auth0 logo
Viewing docs for Auth0 v3.38.0
published on Friday, Feb 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

    With this resource, you can configure Auth0 Supplemental Signals settings for your tenant. This resource is a singleton, meaning only one instance exists per tenant.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const mySupplementalSignals = new auth0.SupplementalSignals("my_supplemental_signals", {akamaiEnabled: true});

    import pulumi
import pulumi_auth0 as auth0

my_supplemental_signals = auth0.SupplementalSignals("my_supplemental_signals", akamai_enabled=True)

    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 {
		_, err := auth0.NewSupplementalSignals(ctx, "my_supplemental_signals", &auth0.SupplementalSignalsArgs{
			AkamaiEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var mySupplementalSignals = new Auth0.SupplementalSignals("my_supplemental_signals", new()
    {
        AkamaiEnabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.SupplementalSignals;
import com.pulumi.auth0.SupplementalSignalsArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var mySupplementalSignals = new SupplementalSignals("mySupplementalSignals", SupplementalSignalsArgs.builder()
            .akamaiEnabled(true)
            .build());

    }
}

    resources:
  mySupplementalSignals:
    type: auth0:SupplementalSignals
    name: my_supplemental_signals
    properties:
      akamaiEnabled: true

    Create SupplementalSignals Resource

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

    Constructor syntax

    new SupplementalSignals(name: string, args: SupplementalSignalsArgs, opts?: CustomResourceOptions);
    @overload
def SupplementalSignals(resource_name: str,
                        args: SupplementalSignalsArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def SupplementalSignals(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        akamai_enabled: Optional[bool] = None)
    func NewSupplementalSignals(ctx *Context, name string, args SupplementalSignalsArgs, opts ...ResourceOption) (*SupplementalSignals, error)
    public SupplementalSignals(string name, SupplementalSignalsArgs args, CustomResourceOptions? opts = null)
    public SupplementalSignals(String name, SupplementalSignalsArgs args)
public SupplementalSignals(String name, SupplementalSignalsArgs args, CustomResourceOptions options)

    type: auth0:SupplementalSignals
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SupplementalSignalsArgs
    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 SupplementalSignalsArgs
    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 SupplementalSignalsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SupplementalSignalsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SupplementalSignalsArgs
    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 supplementalSignalsResource = new Auth0.SupplementalSignals("supplementalSignalsResource", new()
{
    AkamaiEnabled = false,
});

    example, err := auth0.NewSupplementalSignals(ctx, "supplementalSignalsResource", &auth0.SupplementalSignalsArgs{
	AkamaiEnabled: pulumi.Bool(false),
})

    var supplementalSignalsResource = new SupplementalSignals("supplementalSignalsResource", SupplementalSignalsArgs.builder()
    .akamaiEnabled(false)
    .build());

    supplemental_signals_resource = auth0.SupplementalSignals("supplementalSignalsResource", akamai_enabled=False)

    const supplementalSignalsResource = new auth0.SupplementalSignals("supplementalSignalsResource", {akamaiEnabled: false});

    type: auth0:SupplementalSignals
properties:
    akamaiEnabled: false

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

    AkamaiEnabled bool
    Indicates if incoming Akamai Headers should be processed.
    AkamaiEnabled bool
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled Boolean
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled boolean
    Indicates if incoming Akamai Headers should be processed.
    akamai_enabled bool
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled Boolean
    Indicates if incoming Akamai Headers should be processed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SupplementalSignals 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SupplementalSignals Resource

    Get an existing SupplementalSignals 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?: SupplementalSignalsState, opts?: CustomResourceOptions): SupplementalSignals
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        akamai_enabled: Optional[bool] = None) -> SupplementalSignals
    func GetSupplementalSignals(ctx *Context, name string, id IDInput, state *SupplementalSignalsState, opts ...ResourceOption) (*SupplementalSignals, error)
    public static SupplementalSignals Get(string name, Input<string> id, SupplementalSignalsState? state, CustomResourceOptions? opts = null)
    public static SupplementalSignals get(String name, Output<String> id, SupplementalSignalsState state, CustomResourceOptions options)
    resources:  _:    type: auth0:SupplementalSignals    get:      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.
    The following state arguments are supported:
    AkamaiEnabled bool
    Indicates if incoming Akamai Headers should be processed.
    AkamaiEnabled bool
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled Boolean
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled boolean
    Indicates if incoming Akamai Headers should be processed.
    akamai_enabled bool
    Indicates if incoming Akamai Headers should be processed.
    akamaiEnabled Boolean
    Indicates if incoming Akamai Headers should be processed.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Viewing docs for Auth0 v3.38.0
    published on Friday, Feb 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-auth0
      Try Pulumi Cloud free. Your team will thank you.