Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta
  3. API Docs
  4. CustomizedSigninPage
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi
pulumi/pulumi-okta

okta.CustomizedSigninPage

Explore with Pulumi AI

okta logo
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi
pulumi/pulumi-okta

    Manage the customized signin page of a brand

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Brand;
import com.pulumi.okta.BrandArgs;
import com.pulumi.okta.CustomizedSigninPage;
import com.pulumi.okta.CustomizedSigninPageArgs;
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 test = new Brand("test", BrandArgs.builder()
            .name("testBrand")
            .locale("en")
            .build());

        var testCustomizedSigninPage = new CustomizedSigninPage("testCustomizedSigninPage", CustomizedSigninPageArgs.builder()
            .brandId(oktaBrand.test().id())
            .pageContent("""
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="robots" content="noindex,nofollow" />
    <!-- Styles generated from theme -->
    <link href="{{themedStylesUrl}}" rel="stylesheet" type="text/css">
    <!-- Favicon from theme -->
    <link rel="shortcut icon" href="{{faviconUrl}}" type="image/x-icon"/>

    <title>{{pageTitle}}</title>
    {{{SignInWidgetResources}}}

    <style nonce="{{nonceValue}}">
        #login-bg-image-id {
            background-image: {{bgImageUrl}}
        }
    </style>
</head>
<body>
    <div id="login-bg-image-id" class="login-bg-image tb--background"></div>
    <div id="okta-login-container"></div>

    <!--
        "OktaUtil" defines a global OktaUtil object
        that contains methods used to complete the Okta login flow.
     -->
    {{{OktaUtil}}}

    <script type="text/javascript" nonce="{{nonceValue}}">
        // "config" object contains default widget configuration
        // with any custom overrides defined in your admin settings.
        var config = OktaUtil.getSignInWidgetConfig();

        // Render the Okta Sign-In Widget
        var oktaSignIn = new OktaSignIn(config);
        oktaSignIn.renderEl({ el: '#okta-login-container' },
            OktaUtil.completeLogin,
            function(error) {
                // Logs errors that occur when configuring the widget.
                // Remove or replace this with your own custom error handler.
                console.log(error.message, error);
            }
        );
    </script>
</body>
</html>
            """)
            .widgetVersion("^6")
            .widgetCustomizations(CustomizedSigninPageWidgetCustomizationsArgs.builder()
                .widgetGeneration("G3")
                .build())
            .build());

    }
}

    resources:
  test:
    type: okta:Brand
    properties:
      name: testBrand
      locale: en
  testCustomizedSigninPage:
    type: okta:CustomizedSigninPage
    name: test
    properties:
      brandId: ${oktaBrand.test.id}
      pageContent: |
        <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
        <html>
        <head>
            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
            <meta name="viewport" content="width=device-width, initial-scale=1.0" />
            <meta name="robots" content="noindex,nofollow" />
            <!-- Styles generated from theme -->
            <link href="{{themedStylesUrl}}" rel="stylesheet" type="text/css">
            <!-- Favicon from theme -->
            <link rel="shortcut icon" href="{{faviconUrl}}" type="image/x-icon"/>

            <title>{{pageTitle}}</title>
            {{{SignInWidgetResources}}}

            <style nonce="{{nonceValue}}">
                #login-bg-image-id {
                    background-image: {{bgImageUrl}}
                }
            </style>
        </head>
        <body>
            <div id="login-bg-image-id" class="login-bg-image tb--background"></div>
            <div id="okta-login-container"></div>

            <!--
                "OktaUtil" defines a global OktaUtil object
                that contains methods used to complete the Okta login flow.
             -->
            {{{OktaUtil}}}

            <script type="text/javascript" nonce="{{nonceValue}}">
                // "config" object contains default widget configuration
                // with any custom overrides defined in your admin settings.
                var config = OktaUtil.getSignInWidgetConfig();

                // Render the Okta Sign-In Widget
                var oktaSignIn = new OktaSignIn(config);
                oktaSignIn.renderEl({ el: '#okta-login-container' },
                    OktaUtil.completeLogin,
                    function(error) {
                        // Logs errors that occur when configuring the widget.
                        // Remove or replace this with your own custom error handler.
                        console.log(error.message, error);
                    }
                );
            </script>
        </body>
        </html>        
      widgetVersion: ^6
      widgetCustomizations:
        - widgetGeneration: G3

    Create CustomizedSigninPage Resource

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

    Constructor syntax

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

@overload
def CustomizedSigninPage(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         brand_id: Optional[str] = None,
                         page_content: Optional[str] = None,
                         widget_version: Optional[str] = None,
                         content_security_policy_setting: Optional[CustomizedSigninPageContentSecurityPolicySettingArgs] = None,
                         widget_customizations: Optional[CustomizedSigninPageWidgetCustomizationsArgs] = None)
    func NewCustomizedSigninPage(ctx *Context, name string, args CustomizedSigninPageArgs, opts ...ResourceOption) (*CustomizedSigninPage, error)
    public CustomizedSigninPage(string name, CustomizedSigninPageArgs args, CustomResourceOptions? opts = null)
    public CustomizedSigninPage(String name, CustomizedSigninPageArgs args)
public CustomizedSigninPage(String name, CustomizedSigninPageArgs args, CustomResourceOptions options)

    type: okta:CustomizedSigninPage
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 CustomizedSigninPageArgs
    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 CustomizedSigninPageArgs
    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 CustomizedSigninPageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomizedSigninPageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomizedSigninPageArgs
    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 customizedSigninPageResource = new Okta.CustomizedSigninPage("customizedSigninPageResource", new()
{
    BrandId = "string",
    PageContent = "string",
    WidgetVersion = "string",
    ContentSecurityPolicySetting = new Okta.Inputs.CustomizedSigninPageContentSecurityPolicySettingArgs
    {
        Mode = "string",
        ReportUri = "string",
        SrcLists = new[]
        {
            "string",
        },
    },
    WidgetCustomizations = new Okta.Inputs.CustomizedSigninPageWidgetCustomizationsArgs
    {
        WidgetGeneration = "string",
        HelpUrl = "string",
        UsernameInfoTip = "string",
        CustomLink1Label = "string",
        CustomLink1Url = "string",
        CustomLink2Label = "string",
        CustomLink2Url = "string",
        ForgotPasswordLabel = "string",
        PasswordInfoTip = "string",
        AuthenticatorPageCustomLinkUrl = "string",
        ClassicRecoveryFlowEmailOrUsernameLabel = "string",
        ForgotPasswordUrl = "string",
        PasswordLabel = "string",
        ShowPasswordVisibilityToggle = false,
        ShowUserIdentifier = false,
        SignInLabel = "string",
        UnlockAccountLabel = "string",
        UnlockAccountUrl = "string",
        AuthenticatorPageCustomLinkLabel = "string",
        UsernameLabel = "string",
        HelpLabel = "string",
    },
});

    example, err := okta.NewCustomizedSigninPage(ctx, "customizedSigninPageResource", &okta.CustomizedSigninPageArgs{
	BrandId:       pulumi.String("string"),
	PageContent:   pulumi.String("string"),
	WidgetVersion: pulumi.String("string"),
	ContentSecurityPolicySetting: &okta.CustomizedSigninPageContentSecurityPolicySettingArgs{
		Mode:      pulumi.String("string"),
		ReportUri: pulumi.String("string"),
		SrcLists: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	WidgetCustomizations: &okta.CustomizedSigninPageWidgetCustomizationsArgs{
		WidgetGeneration:                        pulumi.String("string"),
		HelpUrl:                                 pulumi.String("string"),
		UsernameInfoTip:                         pulumi.String("string"),
		CustomLink1Label:                        pulumi.String("string"),
		CustomLink1Url:                          pulumi.String("string"),
		CustomLink2Label:                        pulumi.String("string"),
		CustomLink2Url:                          pulumi.String("string"),
		ForgotPasswordLabel:                     pulumi.String("string"),
		PasswordInfoTip:                         pulumi.String("string"),
		AuthenticatorPageCustomLinkUrl:          pulumi.String("string"),
		ClassicRecoveryFlowEmailOrUsernameLabel: pulumi.String("string"),
		ForgotPasswordUrl:                       pulumi.String("string"),
		PasswordLabel:                           pulumi.String("string"),
		ShowPasswordVisibilityToggle:            pulumi.Bool(false),
		ShowUserIdentifier:                      pulumi.Bool(false),
		SignInLabel:                             pulumi.String("string"),
		UnlockAccountLabel:                      pulumi.String("string"),
		UnlockAccountUrl:                        pulumi.String("string"),
		AuthenticatorPageCustomLinkLabel:        pulumi.String("string"),
		UsernameLabel:                           pulumi.String("string"),
		HelpLabel:                               pulumi.String("string"),
	},
})

    var customizedSigninPageResource = new CustomizedSigninPage("customizedSigninPageResource", CustomizedSigninPageArgs.builder()
    .brandId("string")
    .pageContent("string")
    .widgetVersion("string")
    .contentSecurityPolicySetting(CustomizedSigninPageContentSecurityPolicySettingArgs.builder()
        .mode("string")
        .reportUri("string")
        .srcLists("string")
        .build())
    .widgetCustomizations(CustomizedSigninPageWidgetCustomizationsArgs.builder()
        .widgetGeneration("string")
        .helpUrl("string")
        .usernameInfoTip("string")
        .customLink1Label("string")
        .customLink1Url("string")
        .customLink2Label("string")
        .customLink2Url("string")
        .forgotPasswordLabel("string")
        .passwordInfoTip("string")
        .authenticatorPageCustomLinkUrl("string")
        .classicRecoveryFlowEmailOrUsernameLabel("string")
        .forgotPasswordUrl("string")
        .passwordLabel("string")
        .showPasswordVisibilityToggle(false)
        .showUserIdentifier(false)
        .signInLabel("string")
        .unlockAccountLabel("string")
        .unlockAccountUrl("string")
        .authenticatorPageCustomLinkLabel("string")
        .usernameLabel("string")
        .helpLabel("string")
        .build())
    .build());

    customized_signin_page_resource = okta.CustomizedSigninPage("customizedSigninPageResource",
    brand_id="string",
    page_content="string",
    widget_version="string",
    content_security_policy_setting=okta.CustomizedSigninPageContentSecurityPolicySettingArgs(
        mode="string",
        report_uri="string",
        src_lists=["string"],
    ),
    widget_customizations=okta.CustomizedSigninPageWidgetCustomizationsArgs(
        widget_generation="string",
        help_url="string",
        username_info_tip="string",
        custom_link1_label="string",
        custom_link1_url="string",
        custom_link2_label="string",
        custom_link2_url="string",
        forgot_password_label="string",
        password_info_tip="string",
        authenticator_page_custom_link_url="string",
        classic_recovery_flow_email_or_username_label="string",
        forgot_password_url="string",
        password_label="string",
        show_password_visibility_toggle=False,
        show_user_identifier=False,
        sign_in_label="string",
        unlock_account_label="string",
        unlock_account_url="string",
        authenticator_page_custom_link_label="string",
        username_label="string",
        help_label="string",
    ))

    const customizedSigninPageResource = new okta.CustomizedSigninPage("customizedSigninPageResource", {
    brandId: "string",
    pageContent: "string",
    widgetVersion: "string",
    contentSecurityPolicySetting: {
        mode: "string",
        reportUri: "string",
        srcLists: ["string"],
    },
    widgetCustomizations: {
        widgetGeneration: "string",
        helpUrl: "string",
        usernameInfoTip: "string",
        customLink1Label: "string",
        customLink1Url: "string",
        customLink2Label: "string",
        customLink2Url: "string",
        forgotPasswordLabel: "string",
        passwordInfoTip: "string",
        authenticatorPageCustomLinkUrl: "string",
        classicRecoveryFlowEmailOrUsernameLabel: "string",
        forgotPasswordUrl: "string",
        passwordLabel: "string",
        showPasswordVisibilityToggle: false,
        showUserIdentifier: false,
        signInLabel: "string",
        unlockAccountLabel: "string",
        unlockAccountUrl: "string",
        authenticatorPageCustomLinkLabel: "string",
        usernameLabel: "string",
        helpLabel: "string",
    },
});

    type: okta:CustomizedSigninPage
properties:
    brandId: string
    contentSecurityPolicySetting:
        mode: string
        reportUri: string
        srcLists:
            - string
    pageContent: string
    widgetCustomizations:
        authenticatorPageCustomLinkLabel: string
        authenticatorPageCustomLinkUrl: string
        classicRecoveryFlowEmailOrUsernameLabel: string
        customLink1Label: string
        customLink1Url: string
        customLink2Label: string
        customLink2Url: string
        forgotPasswordLabel: string
        forgotPasswordUrl: string
        helpLabel: string
        helpUrl: string
        passwordInfoTip: string
        passwordLabel: string
        showPasswordVisibilityToggle: false
        showUserIdentifier: false
        signInLabel: string
        unlockAccountLabel: string
        unlockAccountUrl: string
        usernameInfoTip: string
        usernameLabel: string
        widgetGeneration: string
    widgetVersion: string

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

    BrandId string
    brand id of the preview signin page
    PageContent string
    page content of the preview signin page
    WidgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    ContentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    WidgetCustomizations CustomizedSigninPageWidgetCustomizations
    BrandId string
    brand id of the preview signin page
    PageContent string
    page content of the preview signin page
    WidgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    ContentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySettingArgs
    WidgetCustomizations CustomizedSigninPageWidgetCustomizationsArgs
    brandId String
    brand id of the preview signin page
    pageContent String
    page content of the preview signin page
    widgetVersion String
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    contentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    widgetCustomizations CustomizedSigninPageWidgetCustomizations
    brandId string
    brand id of the preview signin page
    pageContent string
    page content of the preview signin page
    widgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    contentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    widgetCustomizations CustomizedSigninPageWidgetCustomizations
    brand_id str
    brand id of the preview signin page
    page_content str
    page content of the preview signin page
    widget_version str
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    content_security_policy_setting CustomizedSigninPageContentSecurityPolicySettingArgs
    widget_customizations CustomizedSigninPageWidgetCustomizationsArgs
    brandId String
    brand id of the preview signin page
    pageContent String
    page content of the preview signin page
    widgetVersion String
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    contentSecurityPolicySetting Property Map
    widgetCustomizations Property Map

    Outputs

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

    Get an existing CustomizedSigninPage 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?: CustomizedSigninPageState, opts?: CustomResourceOptions): CustomizedSigninPage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        brand_id: Optional[str] = None,
        content_security_policy_setting: Optional[CustomizedSigninPageContentSecurityPolicySettingArgs] = None,
        page_content: Optional[str] = None,
        widget_customizations: Optional[CustomizedSigninPageWidgetCustomizationsArgs] = None,
        widget_version: Optional[str] = None) -> CustomizedSigninPage
    func GetCustomizedSigninPage(ctx *Context, name string, id IDInput, state *CustomizedSigninPageState, opts ...ResourceOption) (*CustomizedSigninPage, error)
    public static CustomizedSigninPage Get(string name, Input<string> id, CustomizedSigninPageState? state, CustomResourceOptions? opts = null)
    public static CustomizedSigninPage get(String name, Output<String> id, CustomizedSigninPageState 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:
    BrandId string
    brand id of the preview signin page
    ContentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    PageContent string
    page content of the preview signin page
    WidgetCustomizations CustomizedSigninPageWidgetCustomizations
    WidgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    BrandId string
    brand id of the preview signin page
    ContentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySettingArgs
    PageContent string
    page content of the preview signin page
    WidgetCustomizations CustomizedSigninPageWidgetCustomizationsArgs
    WidgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    brandId String
    brand id of the preview signin page
    contentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    pageContent String
    page content of the preview signin page
    widgetCustomizations CustomizedSigninPageWidgetCustomizations
    widgetVersion String
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    brandId string
    brand id of the preview signin page
    contentSecurityPolicySetting CustomizedSigninPageContentSecurityPolicySetting
    pageContent string
    page content of the preview signin page
    widgetCustomizations CustomizedSigninPageWidgetCustomizations
    widgetVersion string
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    brand_id str
    brand id of the preview signin page
    content_security_policy_setting CustomizedSigninPageContentSecurityPolicySettingArgs
    page_content str
    page content of the preview signin page
    widget_customizations CustomizedSigninPageWidgetCustomizationsArgs
    widget_version str
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.
    brandId String
    brand id of the preview signin page
    contentSecurityPolicySetting Property Map
    pageContent String
    page content of the preview signin page
    widgetCustomizations Property Map
    widgetVersion String
    widget version specified as a Semver. The following are currently supported *, ^1, ^2, ^3, ^4, ^5, ^6, ^7, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 2.10, 2.11, 2.12, 2.13, 2.14, 2.15, 2.16, 2.17, 2.18, 2.19, 2.20, 2.21, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 5.10, 5.11, 5.12, 5.13, 5.14, 5.15, 5.16, 6.0, 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13.

    Supporting Types

    CustomizedSigninPageContentSecurityPolicySetting, CustomizedSigninPageContentSecurityPolicySettingArgs

    Mode string
    enforced or report_only
    ReportUri string
    SrcLists List<string>
    Mode string
    enforced or report_only
    ReportUri string
    SrcLists []string
    mode String
    enforced or report_only
    reportUri String
    srcLists List<String>
    mode string
    enforced or report_only
    reportUri string
    srcLists string[]
    mode str
    enforced or report_only
    report_uri str
    src_lists Sequence[str]
    mode String
    enforced or report_only
    reportUri String
    srcLists List<String>

    CustomizedSigninPageWidgetCustomizations, CustomizedSigninPageWidgetCustomizationsArgs

    Import

    $ pulumi import okta:index/customizedSigninPage:CustomizedSigninPage example <brand_id>

    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.11.0 published on Tuesday, Sep 17, 2024 by Pulumi
    pulumi/pulumi-okta