Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi
published on Friday, Sep 11, 2026 by Pulumi
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi
published on Friday, Sep 11, 2026 by Pulumi
Retrieves the CAPTCHA settings object for your organization. > Note: If the current organization hasn’t configured CAPTCHA Settings, the request returns an empty object.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const testCaptcha = new okta.Captcha("test", {
name: "testAcc_replace_with_uuid",
type: "HCAPTCHA",
siteKey: "random_key",
secretKey: "random_secret_key",
});
const testOrgCaptcha = new okta.OrgCaptcha("test", {
captchaId: testCaptcha.id,
enabledPages: ["SIGN_IN"],
});
const test = okta.getOrgCaptcha({});
import pulumi
import pulumi_okta as okta
test_captcha = okta.Captcha("test",
name="testAcc_replace_with_uuid",
type="HCAPTCHA",
site_key="random_key",
secret_key="random_secret_key")
test_org_captcha = okta.OrgCaptcha("test",
captcha_id=test_captcha.id,
enabled_pages=["SIGN_IN"])
test = okta.get_org_captcha()
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v7/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
testCaptcha, err := okta.NewCaptcha(ctx, "test", &okta.CaptchaArgs{
Name: pulumi.String("testAcc_replace_with_uuid"),
Type: pulumi.String("HCAPTCHA"),
SiteKey: pulumi.String("random_key"),
SecretKey: pulumi.String("random_secret_key"),
})
if err != nil {
return err
}
_, err = okta.NewOrgCaptcha(ctx, "test", &okta.OrgCaptchaArgs{
CaptchaId: testCaptcha.ID().ToIDOutput().ToStringOutput(),
EnabledPages: pulumi.StringArray{
pulumi.String("SIGN_IN"),
},
})
if err != nil {
return err
}
_, err = okta.GetOrgCaptcha(ctx, &okta.LookupOrgCaptchaArgs{}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var testCaptcha = new Okta.Captcha("test", new()
{
Name = "testAcc_replace_with_uuid",
Type = "HCAPTCHA",
SiteKey = "random_key",
SecretKey = "random_secret_key",
});
var testOrgCaptcha = new Okta.OrgCaptcha("test", new()
{
CaptchaId = testCaptcha.Id,
EnabledPages = new[]
{
"SIGN_IN",
},
});
var test = Okta.GetOrgCaptcha.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Captcha;
import com.pulumi.okta.CaptchaArgs;
import com.pulumi.okta.OrgCaptcha;
import com.pulumi.okta.OrgCaptchaArgs;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetOrgCaptchaArgs;
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) {
var testCaptcha = new Captcha("testCaptcha", CaptchaArgs.builder()
.name("testAcc_replace_with_uuid")
.type("HCAPTCHA")
.siteKey("random_key")
.secretKey("random_secret_key")
.build());
var testOrgCaptcha = new OrgCaptcha("testOrgCaptcha", OrgCaptchaArgs.builder()
.captchaId(testCaptcha.id())
.enabledPages("SIGN_IN")
.build());
final var test = OktaFunctions.getOrgCaptcha(GetOrgCaptchaArgs.builder()
.build());
}
}
resources:
testCaptcha:
type: okta:Captcha
name: test
properties:
name: testAcc_replace_with_uuid
type: HCAPTCHA
siteKey: random_key
secretKey: random_secret_key
testOrgCaptcha:
type: okta:OrgCaptcha
name: test
properties:
captchaId: ${testCaptcha.id}
enabledPages:
- SIGN_IN
variables:
test:
fn::invoke:
function: okta:getOrgCaptcha
arguments: {}
pulumi {
required_providers {
okta = {
source = "pulumi/okta"
}
}
}
data "okta_getorgcaptcha" "test" {
}
resource "okta_captcha" "test" {
name = "testAcc_replace_with_uuid"
type = "HCAPTCHA"
site_key = "random_key"
secret_key = "random_secret_key"
}
resource "okta_orgcaptcha" "test" {
captcha_id = okta_captcha.test.id
enabled_pages = ["SIGN_IN"]
}
Using getOrgCaptcha
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getOrgCaptcha(args: GetOrgCaptchaArgs, opts?: InvokeOptions): Promise<GetOrgCaptchaResult>
function getOrgCaptchaOutput(args: GetOrgCaptchaOutputArgs, opts?: InvokeOutputOptions): Output<GetOrgCaptchaResult>def get_org_captcha(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOrgCaptchaResult
def get_org_captcha_output(id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetOrgCaptchaResult]func LookupOrgCaptcha(ctx *Context, args *LookupOrgCaptchaArgs, opts ...InvokeOption) (*LookupOrgCaptchaResult, error)
func LookupOrgCaptchaOutput(ctx *Context, args *LookupOrgCaptchaOutputArgs, opts ...InvokeOption) LookupOrgCaptchaResultOutput> Note: This function is named LookupOrgCaptcha in the Go SDK.
public static class GetOrgCaptcha
{
public static Task<GetOrgCaptchaResult> InvokeAsync(GetOrgCaptchaArgs args, InvokeOptions? opts = null)
public static Output<GetOrgCaptchaResult> Invoke(GetOrgCaptchaInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetOrgCaptchaResult> Invoke(GetOrgCaptchaInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetOrgCaptchaResult> getOrgCaptcha(GetOrgCaptchaArgs args, InvokeOptions options)
public static Output<GetOrgCaptchaResult> getOrgCaptcha(GetOrgCaptchaArgs args, InvokeOptions options)
public static Output<GetOrgCaptchaResult> getOrgCaptcha(GetOrgCaptchaArgs args, InvokeOutputOptions options)
fn::invoke:
function: okta:index/getOrgCaptcha:getOrgCaptcha
arguments:
# arguments dictionarydata "okta_get_org_captcha" "name" {
# arguments
}The following arguments are supported:
- Id string
- Unique identifier of the org_captcha.
- Id string
- Unique identifier of the org_captcha.
- id string
- Unique identifier of the org_captcha.
- id String
- Unique identifier of the org_captcha.
- id string
- Unique identifier of the org_captcha.
- id str
- Unique identifier of the org_captcha.
- id String
- Unique identifier of the org_captcha.
getOrgCaptcha Result
The following output properties are available:
- Captcha
Id string - The unique key of the associated CAPTCHA instance
- Enabled
Pages List<string> - An array of pages that have CAPTCHA enabled
- Id string
- Unique identifier of the org_captcha.
- Captcha
Id string - The unique key of the associated CAPTCHA instance
- Enabled
Pages []string - An array of pages that have CAPTCHA enabled
- Id string
- Unique identifier of the org_captcha.
- captcha_
id string - The unique key of the associated CAPTCHA instance
- enabled_
pages list(string) - An array of pages that have CAPTCHA enabled
- id string
- Unique identifier of the org_captcha.
- captcha
Id String - The unique key of the associated CAPTCHA instance
- enabled
Pages List<String> - An array of pages that have CAPTCHA enabled
- id String
- Unique identifier of the org_captcha.
- captcha
Id string - The unique key of the associated CAPTCHA instance
- enabled
Pages string[] - An array of pages that have CAPTCHA enabled
- id string
- Unique identifier of the org_captcha.
- captcha_
id str - The unique key of the associated CAPTCHA instance
- enabled_
pages Sequence[str] - An array of pages that have CAPTCHA enabled
- id str
- Unique identifier of the org_captcha.
- captcha
Id String - The unique key of the associated CAPTCHA instance
- enabled
Pages List<String> - An array of pages that have CAPTCHA enabled
- id String
- Unique identifier of the org_captcha.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oktaTerraform Provider.
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi
published on Friday, Sep 11, 2026 by Pulumi