Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. CaptchaOrgWideSettings
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

okta.CaptchaOrgWideSettings

Explore with Pulumi AI

okta logo
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
pulumi/pulumi-okta

    Manages Org-Wide CAPTCHA settings

    WARNING: This feature is only available as a part of the Identity Engine. Contact support for further information. This resource allows you to configure which parts of the authentication flow requires users to pass the CAPTCHA logic. CAPTCHA org-wide settings can be disabled by unsetting ‘captcha_id’ and ’enabled_for’.

    Create CaptchaOrgWideSettings Resource

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

    Constructor syntax

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

@overload
def CaptchaOrgWideSettings(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           captcha_id: Optional[str] = None,
                           enabled_fors: Optional[Sequence[str]] = None)
    func NewCaptchaOrgWideSettings(ctx *Context, name string, args *CaptchaOrgWideSettingsArgs, opts ...ResourceOption) (*CaptchaOrgWideSettings, error)
    public CaptchaOrgWideSettings(string name, CaptchaOrgWideSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public CaptchaOrgWideSettings(String name, CaptchaOrgWideSettingsArgs args)
public CaptchaOrgWideSettings(String name, CaptchaOrgWideSettingsArgs args, CustomResourceOptions options)

    type: okta:CaptchaOrgWideSettings
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 CaptchaOrgWideSettingsArgs
    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 CaptchaOrgWideSettingsArgs
    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 CaptchaOrgWideSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CaptchaOrgWideSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CaptchaOrgWideSettingsArgs
    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 captchaOrgWideSettingsResource = new Okta.CaptchaOrgWideSettings("captchaOrgWideSettingsResource", new()
{
    CaptchaId = "string",
    EnabledFors = new[]
    {
        "string",
    },
});

    example, err := okta.NewCaptchaOrgWideSettings(ctx, "captchaOrgWideSettingsResource", &okta.CaptchaOrgWideSettingsArgs{
	CaptchaId: pulumi.String("string"),
	EnabledFors: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var captchaOrgWideSettingsResource = new CaptchaOrgWideSettings("captchaOrgWideSettingsResource", CaptchaOrgWideSettingsArgs.builder()
    .captchaId("string")
    .enabledFors("string")
    .build());

    captcha_org_wide_settings_resource = okta.CaptchaOrgWideSettings("captchaOrgWideSettingsResource",
    captcha_id="string",
    enabled_fors=["string"])

    const captchaOrgWideSettingsResource = new okta.CaptchaOrgWideSettings("captchaOrgWideSettingsResource", {
    captchaId: "string",
    enabledFors: ["string"],
});

    type: okta:CaptchaOrgWideSettings
properties:
    captchaId: string
    enabledFors:
        - string

    CaptchaOrgWideSettings Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CaptchaOrgWideSettings resource accepts the following input properties:

    CaptchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    EnabledFors List<string>
    Set of pages that have CAPTCHA enabled
    CaptchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    EnabledFors []string
    Set of pages that have CAPTCHA enabled
    captchaId String
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors List<String>
    Set of pages that have CAPTCHA enabled
    captchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors string[]
    Set of pages that have CAPTCHA enabled
    captcha_id str
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabled_fors Sequence[str]
    Set of pages that have CAPTCHA enabled
    captchaId String
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors List<String>
    Set of pages that have CAPTCHA enabled

    Outputs

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

    Get an existing CaptchaOrgWideSettings 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?: CaptchaOrgWideSettingsState, opts?: CustomResourceOptions): CaptchaOrgWideSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        captcha_id: Optional[str] = None,
        enabled_fors: Optional[Sequence[str]] = None) -> CaptchaOrgWideSettings
    func GetCaptchaOrgWideSettings(ctx *Context, name string, id IDInput, state *CaptchaOrgWideSettingsState, opts ...ResourceOption) (*CaptchaOrgWideSettings, error)
    public static CaptchaOrgWideSettings Get(string name, Input<string> id, CaptchaOrgWideSettingsState? state, CustomResourceOptions? opts = null)
    public static CaptchaOrgWideSettings get(String name, Output<String> id, CaptchaOrgWideSettingsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CaptchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    EnabledFors List<string>
    Set of pages that have CAPTCHA enabled
    CaptchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    EnabledFors []string
    Set of pages that have CAPTCHA enabled
    captchaId String
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors List<String>
    Set of pages that have CAPTCHA enabled
    captchaId string
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors string[]
    Set of pages that have CAPTCHA enabled
    captcha_id str
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabled_fors Sequence[str]
    Set of pages that have CAPTCHA enabled
    captchaId String
    Array of pages that have CAPTCHA enabled. Valid values: SSR, SSPR and SIGN_IN.
    enabledFors List<String>
    Set of pages that have CAPTCHA enabled

    Import

    $ pulumi import okta:index/captchaOrgWideSettings:CaptchaOrgWideSettings example _

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi
    pulumi/pulumi-okta