1. Packages
  2. Authentik Provider
  3. API Docs
  4. StageCaptcha
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

authentik.StageCaptcha

Explore with Pulumi AI

Example Usage

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

const name = new authentik.StageCaptcha("name", {
    privateKey: "foo",
    publicKey: "bar",
});
Copy
import pulumi
import pulumi_authentik as authentik

name = authentik.StageCaptcha("name",
    private_key="foo",
    public_key="bar")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewStageCaptcha(ctx, "name", &authentik.StageCaptchaArgs{
			PrivateKey: pulumi.String("foo"),
			PublicKey:  pulumi.String("bar"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var name = new Authentik.StageCaptcha("name", new()
    {
        PrivateKey = "foo",
        PublicKey = "bar",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.StageCaptcha;
import com.pulumi.authentik.StageCaptchaArgs;
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 name = new StageCaptcha("name", StageCaptchaArgs.builder()
            .privateKey("foo")
            .publicKey("bar")
            .build());

    }
}
Copy
resources:
  name:
    type: authentik:StageCaptcha
    properties:
      privateKey: foo
      publicKey: bar
Copy

Create StageCaptcha Resource

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

Constructor syntax

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

@overload
def StageCaptcha(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 private_key: Optional[str] = None,
                 public_key: Optional[str] = None,
                 api_url: Optional[str] = None,
                 error_on_invalid_score: Optional[bool] = None,
                 interactive: Optional[bool] = None,
                 js_url: Optional[str] = None,
                 name: Optional[str] = None,
                 score_max_threshold: Optional[float] = None,
                 score_min_threshold: Optional[float] = None,
                 stage_captcha_id: Optional[str] = None)
func NewStageCaptcha(ctx *Context, name string, args StageCaptchaArgs, opts ...ResourceOption) (*StageCaptcha, error)
public StageCaptcha(string name, StageCaptchaArgs args, CustomResourceOptions? opts = null)
public StageCaptcha(String name, StageCaptchaArgs args)
public StageCaptcha(String name, StageCaptchaArgs args, CustomResourceOptions options)
type: authentik:StageCaptcha
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StageCaptchaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StageCaptchaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StageCaptchaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StageCaptchaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StageCaptchaArgs
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 stageCaptchaResource = new Authentik.StageCaptcha("stageCaptchaResource", new()
{
    PrivateKey = "string",
    PublicKey = "string",
    ApiUrl = "string",
    ErrorOnInvalidScore = false,
    Interactive = false,
    JsUrl = "string",
    Name = "string",
    ScoreMaxThreshold = 0,
    ScoreMinThreshold = 0,
    StageCaptchaId = "string",
});
Copy
example, err := authentik.NewStageCaptcha(ctx, "stageCaptchaResource", &authentik.StageCaptchaArgs{
	PrivateKey:          pulumi.String("string"),
	PublicKey:           pulumi.String("string"),
	ApiUrl:              pulumi.String("string"),
	ErrorOnInvalidScore: pulumi.Bool(false),
	Interactive:         pulumi.Bool(false),
	JsUrl:               pulumi.String("string"),
	Name:                pulumi.String("string"),
	ScoreMaxThreshold:   pulumi.Float64(0),
	ScoreMinThreshold:   pulumi.Float64(0),
	StageCaptchaId:      pulumi.String("string"),
})
Copy
var stageCaptchaResource = new StageCaptcha("stageCaptchaResource", StageCaptchaArgs.builder()
    .privateKey("string")
    .publicKey("string")
    .apiUrl("string")
    .errorOnInvalidScore(false)
    .interactive(false)
    .jsUrl("string")
    .name("string")
    .scoreMaxThreshold(0)
    .scoreMinThreshold(0)
    .stageCaptchaId("string")
    .build());
Copy
stage_captcha_resource = authentik.StageCaptcha("stageCaptchaResource",
    private_key="string",
    public_key="string",
    api_url="string",
    error_on_invalid_score=False,
    interactive=False,
    js_url="string",
    name="string",
    score_max_threshold=0,
    score_min_threshold=0,
    stage_captcha_id="string")
Copy
const stageCaptchaResource = new authentik.StageCaptcha("stageCaptchaResource", {
    privateKey: "string",
    publicKey: "string",
    apiUrl: "string",
    errorOnInvalidScore: false,
    interactive: false,
    jsUrl: "string",
    name: "string",
    scoreMaxThreshold: 0,
    scoreMinThreshold: 0,
    stageCaptchaId: "string",
});
Copy
type: authentik:StageCaptcha
properties:
    apiUrl: string
    errorOnInvalidScore: false
    interactive: false
    jsUrl: string
    name: string
    privateKey: string
    publicKey: string
    scoreMaxThreshold: 0
    scoreMinThreshold: 0
    stageCaptchaId: string
Copy

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

PrivateKey This property is required. string
PublicKey This property is required. string
ApiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
ErrorOnInvalidScore bool
Defaults to true.
Interactive bool
Defaults to false.
JsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
Name string
ScoreMaxThreshold double
Defaults to 0.5.
ScoreMinThreshold double
Defaults to 1.
StageCaptchaId string
The ID of this resource.
PrivateKey This property is required. string
PublicKey This property is required. string
ApiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
ErrorOnInvalidScore bool
Defaults to true.
Interactive bool
Defaults to false.
JsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
Name string
ScoreMaxThreshold float64
Defaults to 0.5.
ScoreMinThreshold float64
Defaults to 1.
StageCaptchaId string
The ID of this resource.
privateKey This property is required. String
publicKey This property is required. String
apiUrl String
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore Boolean
Defaults to true.
interactive Boolean
Defaults to false.
jsUrl String
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name String
scoreMaxThreshold Double
Defaults to 0.5.
scoreMinThreshold Double
Defaults to 1.
stageCaptchaId String
The ID of this resource.
privateKey This property is required. string
publicKey This property is required. string
apiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore boolean
Defaults to true.
interactive boolean
Defaults to false.
jsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name string
scoreMaxThreshold number
Defaults to 0.5.
scoreMinThreshold number
Defaults to 1.
stageCaptchaId string
The ID of this resource.
private_key This property is required. str
public_key This property is required. str
api_url str
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
error_on_invalid_score bool
Defaults to true.
interactive bool
Defaults to false.
js_url str
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name str
score_max_threshold float
Defaults to 0.5.
score_min_threshold float
Defaults to 1.
stage_captcha_id str
The ID of this resource.
privateKey This property is required. String
publicKey This property is required. String
apiUrl String
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore Boolean
Defaults to true.
interactive Boolean
Defaults to false.
jsUrl String
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name String
scoreMaxThreshold Number
Defaults to 0.5.
scoreMinThreshold Number
Defaults to 1.
stageCaptchaId String
The ID of this resource.

Outputs

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

Get an existing StageCaptcha 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?: StageCaptchaState, opts?: CustomResourceOptions): StageCaptcha
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_url: Optional[str] = None,
        error_on_invalid_score: Optional[bool] = None,
        interactive: Optional[bool] = None,
        js_url: Optional[str] = None,
        name: Optional[str] = None,
        private_key: Optional[str] = None,
        public_key: Optional[str] = None,
        score_max_threshold: Optional[float] = None,
        score_min_threshold: Optional[float] = None,
        stage_captcha_id: Optional[str] = None) -> StageCaptcha
func GetStageCaptcha(ctx *Context, name string, id IDInput, state *StageCaptchaState, opts ...ResourceOption) (*StageCaptcha, error)
public static StageCaptcha Get(string name, Input<string> id, StageCaptchaState? state, CustomResourceOptions? opts = null)
public static StageCaptcha get(String name, Output<String> id, StageCaptchaState state, CustomResourceOptions options)
resources:  _:    type: authentik:StageCaptcha    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
ErrorOnInvalidScore bool
Defaults to true.
Interactive bool
Defaults to false.
JsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
Name string
PrivateKey string
PublicKey string
ScoreMaxThreshold double
Defaults to 0.5.
ScoreMinThreshold double
Defaults to 1.
StageCaptchaId string
The ID of this resource.
ApiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
ErrorOnInvalidScore bool
Defaults to true.
Interactive bool
Defaults to false.
JsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
Name string
PrivateKey string
PublicKey string
ScoreMaxThreshold float64
Defaults to 0.5.
ScoreMinThreshold float64
Defaults to 1.
StageCaptchaId string
The ID of this resource.
apiUrl String
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore Boolean
Defaults to true.
interactive Boolean
Defaults to false.
jsUrl String
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name String
privateKey String
publicKey String
scoreMaxThreshold Double
Defaults to 0.5.
scoreMinThreshold Double
Defaults to 1.
stageCaptchaId String
The ID of this resource.
apiUrl string
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore boolean
Defaults to true.
interactive boolean
Defaults to false.
jsUrl string
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name string
privateKey string
publicKey string
scoreMaxThreshold number
Defaults to 0.5.
scoreMinThreshold number
Defaults to 1.
stageCaptchaId string
The ID of this resource.
api_url str
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
error_on_invalid_score bool
Defaults to true.
interactive bool
Defaults to false.
js_url str
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name str
private_key str
public_key str
score_max_threshold float
Defaults to 0.5.
score_min_threshold float
Defaults to 1.
stage_captcha_id str
The ID of this resource.
apiUrl String
Defaults to https://www.recaptcha.net/recaptcha/api/siteverify.
errorOnInvalidScore Boolean
Defaults to true.
interactive Boolean
Defaults to false.
jsUrl String
Defaults to https://www.recaptcha.net/recaptcha/api.js.
name String
privateKey String
publicKey String
scoreMaxThreshold Number
Defaults to 0.5.
scoreMinThreshold Number
Defaults to 1.
stageCaptchaId String
The ID of this resource.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.