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

okta.app.ThreeField

Explore with Pulumi AI

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

    Creates a Three Field Application. This resource allows you to create and configure a Three Field Application. > During an apply if there is change in ‘status’ the app will first be activated or deactivated in accordance with the ‘status’ change. Then, all other arguments that changed will be applied.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: okta:app:ThreeField
    properties:
      label: Example App
      signOnUrl: https://example.com/login.html
      signOnRedirectUrl: https://example.com
      revealPassword: true
      credentialsScheme: EDIT_USERNAME_AND_PASSWORD

    Create ThreeField Resource

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

    Constructor syntax

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

@overload
def ThreeField(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               extra_field_selector: Optional[str] = None,
               username_selector: Optional[str] = None,
               url: Optional[str] = None,
               password_selector: Optional[str] = None,
               label: Optional[str] = None,
               extra_field_value: Optional[str] = None,
               button_selector: Optional[str] = None,
               hide_web: Optional[bool] = None,
               reveal_password: Optional[bool] = None,
               credentials_scheme: Optional[str] = None,
               auto_submit_toolbar: Optional[bool] = None,
               hide_ios: Optional[bool] = None,
               accessibility_error_redirect_url: Optional[str] = None,
               app_links_json: Optional[str] = None,
               logo: Optional[str] = None,
               admin_note: Optional[str] = None,
               enduser_note: Optional[str] = None,
               shared_password: Optional[str] = None,
               shared_username: Optional[str] = None,
               status: Optional[str] = None,
               accessibility_self_service: Optional[bool] = None,
               url_regex: Optional[str] = None,
               user_name_template: Optional[str] = None,
               user_name_template_push_status: Optional[str] = None,
               user_name_template_suffix: Optional[str] = None,
               user_name_template_type: Optional[str] = None,
               accessibility_login_redirect_url: Optional[str] = None)
    func NewThreeField(ctx *Context, name string, args ThreeFieldArgs, opts ...ResourceOption) (*ThreeField, error)
    public ThreeField(string name, ThreeFieldArgs args, CustomResourceOptions? opts = null)
    public ThreeField(String name, ThreeFieldArgs args)
public ThreeField(String name, ThreeFieldArgs args, CustomResourceOptions options)

    type: okta:app:ThreeField
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 ThreeFieldArgs
    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 ThreeFieldArgs
    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 ThreeFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThreeFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThreeFieldArgs
    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 threeFieldResource = new Okta.App.ThreeField("threeFieldResource", new()
{
    ExtraFieldSelector = "string",
    UsernameSelector = "string",
    Url = "string",
    PasswordSelector = "string",
    Label = "string",
    ExtraFieldValue = "string",
    ButtonSelector = "string",
    HideWeb = false,
    RevealPassword = false,
    CredentialsScheme = "string",
    AutoSubmitToolbar = false,
    HideIos = false,
    AccessibilityErrorRedirectUrl = "string",
    AppLinksJson = "string",
    Logo = "string",
    AdminNote = "string",
    EnduserNote = "string",
    SharedPassword = "string",
    SharedUsername = "string",
    Status = "string",
    AccessibilitySelfService = false,
    UrlRegex = "string",
    UserNameTemplate = "string",
    UserNameTemplatePushStatus = "string",
    UserNameTemplateSuffix = "string",
    UserNameTemplateType = "string",
    AccessibilityLoginRedirectUrl = "string",
});

    example, err := app.NewThreeField(ctx, "threeFieldResource", &app.ThreeFieldArgs{
	ExtraFieldSelector:            pulumi.String("string"),
	UsernameSelector:              pulumi.String("string"),
	Url:                           pulumi.String("string"),
	PasswordSelector:              pulumi.String("string"),
	Label:                         pulumi.String("string"),
	ExtraFieldValue:               pulumi.String("string"),
	ButtonSelector:                pulumi.String("string"),
	HideWeb:                       pulumi.Bool(false),
	RevealPassword:                pulumi.Bool(false),
	CredentialsScheme:             pulumi.String("string"),
	AutoSubmitToolbar:             pulumi.Bool(false),
	HideIos:                       pulumi.Bool(false),
	AccessibilityErrorRedirectUrl: pulumi.String("string"),
	AppLinksJson:                  pulumi.String("string"),
	Logo:                          pulumi.String("string"),
	AdminNote:                     pulumi.String("string"),
	EnduserNote:                   pulumi.String("string"),
	SharedPassword:                pulumi.String("string"),
	SharedUsername:                pulumi.String("string"),
	Status:                        pulumi.String("string"),
	AccessibilitySelfService:      pulumi.Bool(false),
	UrlRegex:                      pulumi.String("string"),
	UserNameTemplate:              pulumi.String("string"),
	UserNameTemplatePushStatus:    pulumi.String("string"),
	UserNameTemplateSuffix:        pulumi.String("string"),
	UserNameTemplateType:          pulumi.String("string"),
	AccessibilityLoginRedirectUrl: pulumi.String("string"),
})

    var threeFieldResource = new ThreeField("threeFieldResource", ThreeFieldArgs.builder()
    .extraFieldSelector("string")
    .usernameSelector("string")
    .url("string")
    .passwordSelector("string")
    .label("string")
    .extraFieldValue("string")
    .buttonSelector("string")
    .hideWeb(false)
    .revealPassword(false)
    .credentialsScheme("string")
    .autoSubmitToolbar(false)
    .hideIos(false)
    .accessibilityErrorRedirectUrl("string")
    .appLinksJson("string")
    .logo("string")
    .adminNote("string")
    .enduserNote("string")
    .sharedPassword("string")
    .sharedUsername("string")
    .status("string")
    .accessibilitySelfService(false)
    .urlRegex("string")
    .userNameTemplate("string")
    .userNameTemplatePushStatus("string")
    .userNameTemplateSuffix("string")
    .userNameTemplateType("string")
    .accessibilityLoginRedirectUrl("string")
    .build());

    three_field_resource = okta.app.ThreeField("threeFieldResource",
    extra_field_selector="string",
    username_selector="string",
    url="string",
    password_selector="string",
    label="string",
    extra_field_value="string",
    button_selector="string",
    hide_web=False,
    reveal_password=False,
    credentials_scheme="string",
    auto_submit_toolbar=False,
    hide_ios=False,
    accessibility_error_redirect_url="string",
    app_links_json="string",
    logo="string",
    admin_note="string",
    enduser_note="string",
    shared_password="string",
    shared_username="string",
    status="string",
    accessibility_self_service=False,
    url_regex="string",
    user_name_template="string",
    user_name_template_push_status="string",
    user_name_template_suffix="string",
    user_name_template_type="string",
    accessibility_login_redirect_url="string")

    const threeFieldResource = new okta.app.ThreeField("threeFieldResource", {
    extraFieldSelector: "string",
    usernameSelector: "string",
    url: "string",
    passwordSelector: "string",
    label: "string",
    extraFieldValue: "string",
    buttonSelector: "string",
    hideWeb: false,
    revealPassword: false,
    credentialsScheme: "string",
    autoSubmitToolbar: false,
    hideIos: false,
    accessibilityErrorRedirectUrl: "string",
    appLinksJson: "string",
    logo: "string",
    adminNote: "string",
    enduserNote: "string",
    sharedPassword: "string",
    sharedUsername: "string",
    status: "string",
    accessibilitySelfService: false,
    urlRegex: "string",
    userNameTemplate: "string",
    userNameTemplatePushStatus: "string",
    userNameTemplateSuffix: "string",
    userNameTemplateType: "string",
    accessibilityLoginRedirectUrl: "string",
});

    type: okta:app:ThreeField
properties:
    accessibilityErrorRedirectUrl: string
    accessibilityLoginRedirectUrl: string
    accessibilitySelfService: false
    adminNote: string
    appLinksJson: string
    autoSubmitToolbar: false
    buttonSelector: string
    credentialsScheme: string
    enduserNote: string
    extraFieldSelector: string
    extraFieldValue: string
    hideIos: false
    hideWeb: false
    label: string
    logo: string
    passwordSelector: string
    revealPassword: false
    sharedPassword: string
    sharedUsername: string
    status: string
    url: string
    urlRegex: string
    userNameTemplate: string
    userNameTemplatePushStatus: string
    userNameTemplateSuffix: string
    userNameTemplateType: string
    usernameSelector: string

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

    ButtonSelector string
    Login button field CSS selector
    ExtraFieldSelector string
    Extra field CSS selector
    ExtraFieldValue string
    Value for extra form field
    Label string
    The Application's display name.
    PasswordSelector string
    Login password field CSS selector
    Url string
    Login URL
    UsernameSelector string
    Login username field CSS selector
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    CredentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    RevealPassword bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    SharedPassword string
    Shared password, required for certain schemes.
    SharedUsername string
    Shared username, required for certain schemes.
    Status string
    Status of application. By default, it is ACTIVE
    UrlRegex string
    A regex that further restricts URL to the specified regex
    UserNameTemplate string
    Username template. Default: ${source.login}
    UserNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    UserNameTemplateSuffix string
    Username template suffix
    UserNameTemplateType string
    Username template type. Default: BUILT_IN
    ButtonSelector string
    Login button field CSS selector
    ExtraFieldSelector string
    Extra field CSS selector
    ExtraFieldValue string
    Value for extra form field
    Label string
    The Application's display name.
    PasswordSelector string
    Login password field CSS selector
    Url string
    Login URL
    UsernameSelector string
    Login username field CSS selector
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    CredentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    RevealPassword bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    SharedPassword string
    Shared password, required for certain schemes.
    SharedUsername string
    Shared username, required for certain schemes.
    Status string
    Status of application. By default, it is ACTIVE
    UrlRegex string
    A regex that further restricts URL to the specified regex
    UserNameTemplate string
    Username template. Default: ${source.login}
    UserNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    UserNameTemplateSuffix string
    Username template suffix
    UserNameTemplateType string
    Username template type. Default: BUILT_IN
    buttonSelector String
    Login button field CSS selector
    extraFieldSelector String
    Extra field CSS selector
    extraFieldValue String
    Value for extra form field
    label String
    The Application's display name.
    passwordSelector String
    Login password field CSS selector
    url String
    Login URL
    usernameSelector String
    Login username field CSS selector
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    credentialsScheme String
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    revealPassword Boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword String
    Shared password, required for certain schemes.
    sharedUsername String
    Shared username, required for certain schemes.
    status String
    Status of application. By default, it is ACTIVE
    urlRegex String
    A regex that further restricts URL to the specified regex
    userNameTemplate String
    Username template. Default: ${source.login}
    userNameTemplatePushStatus String
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix String
    Username template suffix
    userNameTemplateType String
    Username template type. Default: BUILT_IN
    buttonSelector string
    Login button field CSS selector
    extraFieldSelector string
    Extra field CSS selector
    extraFieldValue string
    Value for extra form field
    label string
    The Application's display name.
    passwordSelector string
    Login password field CSS selector
    url string
    Login URL
    usernameSelector string
    Login username field CSS selector
    accessibilityErrorRedirectUrl string
    Custom error page URL
    accessibilityLoginRedirectUrl string
    Custom login page URL
    accessibilitySelfService boolean
    Enable self service. Default is false
    adminNote string
    Application notes for admins.
    appLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar boolean
    Display auto submit toolbar
    credentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote string
    Application notes for end users.
    hideIos boolean
    Do not display application icon on mobile app
    hideWeb boolean
    Do not display application icon to users
    logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    revealPassword boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword string
    Shared password, required for certain schemes.
    sharedUsername string
    Shared username, required for certain schemes.
    status string
    Status of application. By default, it is ACTIVE
    urlRegex string
    A regex that further restricts URL to the specified regex
    userNameTemplate string
    Username template. Default: ${source.login}
    userNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix string
    Username template suffix
    userNameTemplateType string
    Username template type. Default: BUILT_IN
    button_selector str
    Login button field CSS selector
    extra_field_selector str
    Extra field CSS selector
    extra_field_value str
    Value for extra form field
    label str
    The Application's display name.
    password_selector str
    Login password field CSS selector
    url str
    Login URL
    username_selector str
    Login username field CSS selector
    accessibility_error_redirect_url str
    Custom error page URL
    accessibility_login_redirect_url str
    Custom login page URL
    accessibility_self_service bool
    Enable self service. Default is false
    admin_note str
    Application notes for admins.
    app_links_json str
    Displays specific appLinks for the app. The value for each application link should be boolean.
    auto_submit_toolbar bool
    Display auto submit toolbar
    credentials_scheme str
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduser_note str
    Application notes for end users.
    hide_ios bool
    Do not display application icon on mobile app
    hide_web bool
    Do not display application icon to users
    logo str
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    reveal_password bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    shared_password str
    Shared password, required for certain schemes.
    shared_username str
    Shared username, required for certain schemes.
    status str
    Status of application. By default, it is ACTIVE
    url_regex str
    A regex that further restricts URL to the specified regex
    user_name_template str
    Username template. Default: ${source.login}
    user_name_template_push_status str
    Push username on update. Valid values: PUSH and DONT_PUSH
    user_name_template_suffix str
    Username template suffix
    user_name_template_type str
    Username template type. Default: BUILT_IN
    buttonSelector String
    Login button field CSS selector
    extraFieldSelector String
    Extra field CSS selector
    extraFieldValue String
    Value for extra form field
    label String
    The Application's display name.
    passwordSelector String
    Login password field CSS selector
    url String
    Login URL
    usernameSelector String
    Login username field CSS selector
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    credentialsScheme String
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    revealPassword Boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword String
    Shared password, required for certain schemes.
    sharedUsername String
    Shared username, required for certain schemes.
    status String
    Status of application. By default, it is ACTIVE
    urlRegex String
    A regex that further restricts URL to the specified regex
    userNameTemplate String
    Username template. Default: ${source.login}
    userNameTemplatePushStatus String
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix String
    Username template suffix
    userNameTemplateType String
    Username template type. Default: BUILT_IN

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ThreeField resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    SignOnMode string
    Sign on mode of application.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    SignOnMode string
    Sign on mode of application.
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    signOnMode String
    Sign on mode of application.
    id string
    The provider-assigned unique ID for this managed resource.
    logoUrl string
    URL of the application's logo
    name string
    Name of the app.
    signOnMode string
    Sign on mode of application.
    id str
    The provider-assigned unique ID for this managed resource.
    logo_url str
    URL of the application's logo
    name str
    Name of the app.
    sign_on_mode str
    Sign on mode of application.
    id String
    The provider-assigned unique ID for this managed resource.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    signOnMode String
    Sign on mode of application.

    Look up Existing ThreeField Resource

    Get an existing ThreeField 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?: ThreeFieldState, opts?: CustomResourceOptions): ThreeField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessibility_error_redirect_url: Optional[str] = None,
        accessibility_login_redirect_url: Optional[str] = None,
        accessibility_self_service: Optional[bool] = None,
        admin_note: Optional[str] = None,
        app_links_json: Optional[str] = None,
        auto_submit_toolbar: Optional[bool] = None,
        button_selector: Optional[str] = None,
        credentials_scheme: Optional[str] = None,
        enduser_note: Optional[str] = None,
        extra_field_selector: Optional[str] = None,
        extra_field_value: Optional[str] = None,
        hide_ios: Optional[bool] = None,
        hide_web: Optional[bool] = None,
        label: Optional[str] = None,
        logo: Optional[str] = None,
        logo_url: Optional[str] = None,
        name: Optional[str] = None,
        password_selector: Optional[str] = None,
        reveal_password: Optional[bool] = None,
        shared_password: Optional[str] = None,
        shared_username: Optional[str] = None,
        sign_on_mode: Optional[str] = None,
        status: Optional[str] = None,
        url: Optional[str] = None,
        url_regex: Optional[str] = None,
        user_name_template: Optional[str] = None,
        user_name_template_push_status: Optional[str] = None,
        user_name_template_suffix: Optional[str] = None,
        user_name_template_type: Optional[str] = None,
        username_selector: Optional[str] = None) -> ThreeField
    func GetThreeField(ctx *Context, name string, id IDInput, state *ThreeFieldState, opts ...ResourceOption) (*ThreeField, error)
    public static ThreeField Get(string name, Input<string> id, ThreeFieldState? state, CustomResourceOptions? opts = null)
    public static ThreeField get(String name, Output<String> id, ThreeFieldState 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:
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    ButtonSelector string
    Login button field CSS selector
    CredentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    EnduserNote string
    Application notes for end users.
    ExtraFieldSelector string
    Extra field CSS selector
    ExtraFieldValue string
    Value for extra form field
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Label string
    The Application's display name.
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    PasswordSelector string
    Login password field CSS selector
    RevealPassword bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    SharedPassword string
    Shared password, required for certain schemes.
    SharedUsername string
    Shared username, required for certain schemes.
    SignOnMode string
    Sign on mode of application.
    Status string
    Status of application. By default, it is ACTIVE
    Url string
    Login URL
    UrlRegex string
    A regex that further restricts URL to the specified regex
    UserNameTemplate string
    Username template. Default: ${source.login}
    UserNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    UserNameTemplateSuffix string
    Username template suffix
    UserNameTemplateType string
    Username template type. Default: BUILT_IN
    UsernameSelector string
    Login username field CSS selector
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    ButtonSelector string
    Login button field CSS selector
    CredentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    EnduserNote string
    Application notes for end users.
    ExtraFieldSelector string
    Extra field CSS selector
    ExtraFieldValue string
    Value for extra form field
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Label string
    The Application's display name.
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    PasswordSelector string
    Login password field CSS selector
    RevealPassword bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    SharedPassword string
    Shared password, required for certain schemes.
    SharedUsername string
    Shared username, required for certain schemes.
    SignOnMode string
    Sign on mode of application.
    Status string
    Status of application. By default, it is ACTIVE
    Url string
    Login URL
    UrlRegex string
    A regex that further restricts URL to the specified regex
    UserNameTemplate string
    Username template. Default: ${source.login}
    UserNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    UserNameTemplateSuffix string
    Username template suffix
    UserNameTemplateType string
    Username template type. Default: BUILT_IN
    UsernameSelector string
    Login username field CSS selector
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    buttonSelector String
    Login button field CSS selector
    credentialsScheme String
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote String
    Application notes for end users.
    extraFieldSelector String
    Extra field CSS selector
    extraFieldValue String
    Value for extra form field
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    label String
    The Application's display name.
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    passwordSelector String
    Login password field CSS selector
    revealPassword Boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword String
    Shared password, required for certain schemes.
    sharedUsername String
    Shared username, required for certain schemes.
    signOnMode String
    Sign on mode of application.
    status String
    Status of application. By default, it is ACTIVE
    url String
    Login URL
    urlRegex String
    A regex that further restricts URL to the specified regex
    userNameTemplate String
    Username template. Default: ${source.login}
    userNameTemplatePushStatus String
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix String
    Username template suffix
    userNameTemplateType String
    Username template type. Default: BUILT_IN
    usernameSelector String
    Login username field CSS selector
    accessibilityErrorRedirectUrl string
    Custom error page URL
    accessibilityLoginRedirectUrl string
    Custom login page URL
    accessibilitySelfService boolean
    Enable self service. Default is false
    adminNote string
    Application notes for admins.
    appLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar boolean
    Display auto submit toolbar
    buttonSelector string
    Login button field CSS selector
    credentialsScheme string
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote string
    Application notes for end users.
    extraFieldSelector string
    Extra field CSS selector
    extraFieldValue string
    Value for extra form field
    hideIos boolean
    Do not display application icon on mobile app
    hideWeb boolean
    Do not display application icon to users
    label string
    The Application's display name.
    logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl string
    URL of the application's logo
    name string
    Name of the app.
    passwordSelector string
    Login password field CSS selector
    revealPassword boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword string
    Shared password, required for certain schemes.
    sharedUsername string
    Shared username, required for certain schemes.
    signOnMode string
    Sign on mode of application.
    status string
    Status of application. By default, it is ACTIVE
    url string
    Login URL
    urlRegex string
    A regex that further restricts URL to the specified regex
    userNameTemplate string
    Username template. Default: ${source.login}
    userNameTemplatePushStatus string
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix string
    Username template suffix
    userNameTemplateType string
    Username template type. Default: BUILT_IN
    usernameSelector string
    Login username field CSS selector
    accessibility_error_redirect_url str
    Custom error page URL
    accessibility_login_redirect_url str
    Custom login page URL
    accessibility_self_service bool
    Enable self service. Default is false
    admin_note str
    Application notes for admins.
    app_links_json str
    Displays specific appLinks for the app. The value for each application link should be boolean.
    auto_submit_toolbar bool
    Display auto submit toolbar
    button_selector str
    Login button field CSS selector
    credentials_scheme str
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduser_note str
    Application notes for end users.
    extra_field_selector str
    Extra field CSS selector
    extra_field_value str
    Value for extra form field
    hide_ios bool
    Do not display application icon on mobile app
    hide_web bool
    Do not display application icon to users
    label str
    The Application's display name.
    logo str
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logo_url str
    URL of the application's logo
    name str
    Name of the app.
    password_selector str
    Login password field CSS selector
    reveal_password bool
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    shared_password str
    Shared password, required for certain schemes.
    shared_username str
    Shared username, required for certain schemes.
    sign_on_mode str
    Sign on mode of application.
    status str
    Status of application. By default, it is ACTIVE
    url str
    Login URL
    url_regex str
    A regex that further restricts URL to the specified regex
    user_name_template str
    Username template. Default: ${source.login}
    user_name_template_push_status str
    Push username on update. Valid values: PUSH and DONT_PUSH
    user_name_template_suffix str
    Username template suffix
    user_name_template_type str
    Username template type. Default: BUILT_IN
    username_selector str
    Login username field CSS selector
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    buttonSelector String
    Login button field CSS selector
    credentialsScheme String
    Application credentials scheme. One of: EDIT_USERNAME_AND_PASSWORD, ADMIN_SETS_CREDENTIALS, EDIT_PASSWORD_ONLY, EXTERNAL_PASSWORD_SYNC, or SHARED_USERNAME_AND_PASSWORD
    enduserNote String
    Application notes for end users.
    extraFieldSelector String
    Extra field CSS selector
    extraFieldValue String
    Value for extra form field
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    label String
    The Application's display name.
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    passwordSelector String
    Login password field CSS selector
    revealPassword Boolean
    Allow user to reveal password. It can not be set to true if credentials_scheme is ADMIN_SETS_CREDENTIALS, SHARED_USERNAME_AND_PASSWORD or EXTERNAL_PASSWORD_SYNC.
    sharedPassword String
    Shared password, required for certain schemes.
    sharedUsername String
    Shared username, required for certain schemes.
    signOnMode String
    Sign on mode of application.
    status String
    Status of application. By default, it is ACTIVE
    url String
    Login URL
    urlRegex String
    A regex that further restricts URL to the specified regex
    userNameTemplate String
    Username template. Default: ${source.login}
    userNameTemplatePushStatus String
    Push username on update. Valid values: PUSH and DONT_PUSH
    userNameTemplateSuffix String
    Username template suffix
    userNameTemplateType String
    Username template type. Default: BUILT_IN
    usernameSelector String
    Login username field CSS selector

    Import

    $ pulumi import okta:app/threeField:ThreeField example &#60;app id&#62;

    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