Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. app
  5. SecurePasswordStore
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.app.SecurePasswordStore

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    This resource allows you to create and configure a Secure Password Store 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

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

const example = new okta.app.SecurePasswordStore("example", {
    credentialsScheme: "ADMIN_SETS_CREDENTIALS",
    label: "example",
    passwordField: "pass",
    url: "https://test.com",
    usernameField: "user",
});

    import pulumi
import pulumi_okta as okta

example = okta.app.SecurePasswordStore("example",
    credentials_scheme="ADMIN_SETS_CREDENTIALS",
    label="example",
    password_field="pass",
    url="https://test.com",
    username_field="user")

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/app"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewSecurePasswordStore(ctx, "example", &app.SecurePasswordStoreArgs{
			CredentialsScheme: pulumi.String("ADMIN_SETS_CREDENTIALS"),
			Label:             pulumi.String("example"),
			PasswordField:     pulumi.String("pass"),
			Url:               pulumi.String("https://test.com"),
			UsernameField:     pulumi.String("user"),
		})
		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 example = new Okta.App.SecurePasswordStore("example", new()
    {
        CredentialsScheme = "ADMIN_SETS_CREDENTIALS",
        Label = "example",
        PasswordField = "pass",
        Url = "https://test.com",
        UsernameField = "user",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.SecurePasswordStore;
import com.pulumi.okta.app.SecurePasswordStoreArgs;
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 example = new SecurePasswordStore("example", SecurePasswordStoreArgs.builder()        
            .credentialsScheme("ADMIN_SETS_CREDENTIALS")
            .label("example")
            .passwordField("pass")
            .url("https://test.com")
            .usernameField("user")
            .build());

    }
}

    resources:
  example:
    type: okta:app:SecurePasswordStore
    properties:
      credentialsScheme: ADMIN_SETS_CREDENTIALS
      label: example
      passwordField: pass
      url: https://test.com
      usernameField: user

    Create SecurePasswordStore Resource

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

    Constructor syntax

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

@overload
def SecurePasswordStore(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        label: Optional[str] = None,
                        username_field: Optional[str] = None,
                        url: Optional[str] = None,
                        password_field: Optional[str] = None,
                        optional_field2: Optional[str] = None,
                        optional_field3_value: Optional[str] = None,
                        credentials_scheme: Optional[str] = None,
                        enduser_note: Optional[str] = None,
                        hide_ios: Optional[bool] = None,
                        hide_web: Optional[bool] = None,
                        app_links_json: Optional[str] = None,
                        logo: Optional[str] = None,
                        optional_field1: Optional[str] = None,
                        optional_field1_value: Optional[str] = None,
                        accessibility_error_redirect_url: Optional[str] = None,
                        optional_field2_value: Optional[str] = None,
                        optional_field3: Optional[str] = None,
                        auto_submit_toolbar: Optional[bool] = None,
                        admin_note: Optional[str] = None,
                        reveal_password: Optional[bool] = None,
                        shared_password: Optional[str] = None,
                        shared_username: Optional[str] = None,
                        status: Optional[str] = None,
                        accessibility_self_service: Optional[bool] = 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 NewSecurePasswordStore(ctx *Context, name string, args SecurePasswordStoreArgs, opts ...ResourceOption) (*SecurePasswordStore, error)
    public SecurePasswordStore(string name, SecurePasswordStoreArgs args, CustomResourceOptions? opts = null)
    public SecurePasswordStore(String name, SecurePasswordStoreArgs args)
public SecurePasswordStore(String name, SecurePasswordStoreArgs args, CustomResourceOptions options)

    type: okta:app:SecurePasswordStore
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 SecurePasswordStoreArgs
    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 SecurePasswordStoreArgs
    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 SecurePasswordStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecurePasswordStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecurePasswordStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var securePasswordStoreResource = new Okta.App.SecurePasswordStore("securePasswordStoreResource", new()
{
    Label = "string",
    UsernameField = "string",
    Url = "string",
    PasswordField = "string",
    OptionalField2 = "string",
    OptionalField3Value = "string",
    CredentialsScheme = "string",
    EnduserNote = "string",
    HideIos = false,
    HideWeb = false,
    AppLinksJson = "string",
    Logo = "string",
    OptionalField1 = "string",
    OptionalField1Value = "string",
    AccessibilityErrorRedirectUrl = "string",
    OptionalField2Value = "string",
    OptionalField3 = "string",
    AutoSubmitToolbar = false,
    AdminNote = "string",
    RevealPassword = false,
    SharedPassword = "string",
    SharedUsername = "string",
    Status = "string",
    AccessibilitySelfService = false,
    UserNameTemplate = "string",
    UserNameTemplatePushStatus = "string",
    UserNameTemplateSuffix = "string",
    UserNameTemplateType = "string",
    AccessibilityLoginRedirectUrl = "string",
});

    example, err := app.NewSecurePasswordStore(ctx, "securePasswordStoreResource", &app.SecurePasswordStoreArgs{
	Label:                         pulumi.String("string"),
	UsernameField:                 pulumi.String("string"),
	Url:                           pulumi.String("string"),
	PasswordField:                 pulumi.String("string"),
	OptionalField2:                pulumi.String("string"),
	OptionalField3Value:           pulumi.String("string"),
	CredentialsScheme:             pulumi.String("string"),
	EnduserNote:                   pulumi.String("string"),
	HideIos:                       pulumi.Bool(false),
	HideWeb:                       pulumi.Bool(false),
	AppLinksJson:                  pulumi.String("string"),
	Logo:                          pulumi.String("string"),
	OptionalField1:                pulumi.String("string"),
	OptionalField1Value:           pulumi.String("string"),
	AccessibilityErrorRedirectUrl: pulumi.String("string"),
	OptionalField2Value:           pulumi.String("string"),
	OptionalField3:                pulumi.String("string"),
	AutoSubmitToolbar:             pulumi.Bool(false),
	AdminNote:                     pulumi.String("string"),
	RevealPassword:                pulumi.Bool(false),
	SharedPassword:                pulumi.String("string"),
	SharedUsername:                pulumi.String("string"),
	Status:                        pulumi.String("string"),
	AccessibilitySelfService:      pulumi.Bool(false),
	UserNameTemplate:              pulumi.String("string"),
	UserNameTemplatePushStatus:    pulumi.String("string"),
	UserNameTemplateSuffix:        pulumi.String("string"),
	UserNameTemplateType:          pulumi.String("string"),
	AccessibilityLoginRedirectUrl: pulumi.String("string"),
})

    var securePasswordStoreResource = new SecurePasswordStore("securePasswordStoreResource", SecurePasswordStoreArgs.builder()        
    .label("string")
    .usernameField("string")
    .url("string")
    .passwordField("string")
    .optionalField2("string")
    .optionalField3Value("string")
    .credentialsScheme("string")
    .enduserNote("string")
    .hideIos(false)
    .hideWeb(false)
    .appLinksJson("string")
    .logo("string")
    .optionalField1("string")
    .optionalField1Value("string")
    .accessibilityErrorRedirectUrl("string")
    .optionalField2Value("string")
    .optionalField3("string")
    .autoSubmitToolbar(false)
    .adminNote("string")
    .revealPassword(false)
    .sharedPassword("string")
    .sharedUsername("string")
    .status("string")
    .accessibilitySelfService(false)
    .userNameTemplate("string")
    .userNameTemplatePushStatus("string")
    .userNameTemplateSuffix("string")
    .userNameTemplateType("string")
    .accessibilityLoginRedirectUrl("string")
    .build());

    secure_password_store_resource = okta.app.SecurePasswordStore("securePasswordStoreResource",
    label="string",
    username_field="string",
    url="string",
    password_field="string",
    optional_field2="string",
    optional_field3_value="string",
    credentials_scheme="string",
    enduser_note="string",
    hide_ios=False,
    hide_web=False,
    app_links_json="string",
    logo="string",
    optional_field1="string",
    optional_field1_value="string",
    accessibility_error_redirect_url="string",
    optional_field2_value="string",
    optional_field3="string",
    auto_submit_toolbar=False,
    admin_note="string",
    reveal_password=False,
    shared_password="string",
    shared_username="string",
    status="string",
    accessibility_self_service=False,
    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 securePasswordStoreResource = new okta.app.SecurePasswordStore("securePasswordStoreResource", {
    label: "string",
    usernameField: "string",
    url: "string",
    passwordField: "string",
    optionalField2: "string",
    optionalField3Value: "string",
    credentialsScheme: "string",
    enduserNote: "string",
    hideIos: false,
    hideWeb: false,
    appLinksJson: "string",
    logo: "string",
    optionalField1: "string",
    optionalField1Value: "string",
    accessibilityErrorRedirectUrl: "string",
    optionalField2Value: "string",
    optionalField3: "string",
    autoSubmitToolbar: false,
    adminNote: "string",
    revealPassword: false,
    sharedPassword: "string",
    sharedUsername: "string",
    status: "string",
    accessibilitySelfService: false,
    userNameTemplate: "string",
    userNameTemplatePushStatus: "string",
    userNameTemplateSuffix: "string",
    userNameTemplateType: "string",
    accessibilityLoginRedirectUrl: "string",
});

    type: okta:app:SecurePasswordStore
properties:
    accessibilityErrorRedirectUrl: string
    accessibilityLoginRedirectUrl: string
    accessibilitySelfService: false
    adminNote: string
    appLinksJson: string
    autoSubmitToolbar: false
    credentialsScheme: string
    enduserNote: string
    hideIos: false
    hideWeb: false
    label: string
    logo: string
    optionalField1: string
    optionalField1Value: string
    optionalField2: string
    optionalField2Value: string
    optionalField3: string
    optionalField3Value: string
    passwordField: string
    revealPassword: false
    sharedPassword: string
    sharedUsername: string
    status: string
    url: string
    userNameTemplate: string
    userNameTemplatePushStatus: string
    userNameTemplateSuffix: string
    userNameTemplateType: string
    usernameField: string

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

    Label string
    The display name of the Application.
    PasswordField string
    Login password field.
    Url string
    Login URL.
    UsernameField string
    Login username field.
    AccessibilityErrorRedirectUrl string
    Custom error page URL.
    AccessibilityLoginRedirectUrl string
    Custom login page for this application.
    AccessibilitySelfService bool
    Enable self-service. By default, it 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. Can be set to "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.
    OptionalField1 string
    Name of optional param in the login form.
    OptionalField1Value string
    Name of optional value in the login form.
    OptionalField2 string
    Name of optional param in the login form.
    OptionalField2Value string
    Name of optional value in the login form.
    OptionalField3 string
    Name of optional param in the login form.
    OptionalField3Value string
    Name of optional value in the login form.
    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".
    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".
    Label string
    The display name of the Application.
    PasswordField string
    Login password field.
    Url string
    Login URL.
    UsernameField string
    Login username field.
    AccessibilityErrorRedirectUrl string
    Custom error page URL.
    AccessibilityLoginRedirectUrl string
    Custom login page for this application.
    AccessibilitySelfService bool
    Enable self-service. By default, it 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. Can be set to "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.
    OptionalField1 string
    Name of optional param in the login form.
    OptionalField1Value string
    Name of optional value in the login form.
    OptionalField2 string
    Name of optional param in the login form.
    OptionalField2Value string
    Name of optional value in the login form.
    OptionalField3 string
    Name of optional param in the login form.
    OptionalField3Value string
    Name of optional value in the login form.
    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".
    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".
    label String
    The display name of the Application.
    passwordField String
    Login password field.
    url String
    Login URL.
    usernameField String
    Login username field.
    accessibilityErrorRedirectUrl String
    Custom error page URL.
    accessibilityLoginRedirectUrl String
    Custom login page for this application.
    accessibilitySelfService Boolean
    Enable self-service. By default, it 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. Can be set to "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.
    optionalField1 String
    Name of optional param in the login form.
    optionalField1Value String
    Name of optional value in the login form.
    optionalField2 String
    Name of optional param in the login form.
    optionalField2Value String
    Name of optional value in the login form.
    optionalField3 String
    Name of optional param in the login form.
    optionalField3Value String
    Name of optional value in the login form.
    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".
    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".
    label string
    The display name of the Application.
    passwordField string
    Login password field.
    url string
    Login URL.
    usernameField string
    Login username field.
    accessibilityErrorRedirectUrl string
    Custom error page URL.
    accessibilityLoginRedirectUrl string
    Custom login page for this application.
    accessibilitySelfService boolean
    Enable self-service. By default, it 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. Can be set to "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.
    optionalField1 string
    Name of optional param in the login form.
    optionalField1Value string
    Name of optional value in the login form.
    optionalField2 string
    Name of optional param in the login form.
    optionalField2Value string
    Name of optional value in the login form.
    optionalField3 string
    Name of optional param in the login form.
    optionalField3Value string
    Name of optional value in the login form.
    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".
    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".
    label str
    The display name of the Application.
    password_field str
    Login password field.
    url str
    Login URL.
    username_field str
    Login username field.
    accessibility_error_redirect_url str
    Custom error page URL.
    accessibility_login_redirect_url str
    Custom login page for this application.
    accessibility_self_service bool
    Enable self-service. By default, it 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. Can be set to "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.
    optional_field1 str
    Name of optional param in the login form.
    optional_field1_value str
    Name of optional value in the login form.
    optional_field2 str
    Name of optional param in the login form.
    optional_field2_value str
    Name of optional value in the login form.
    optional_field3 str
    Name of optional param in the login form.
    optional_field3_value str
    Name of optional value in the login form.
    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".
    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".
    label String
    The display name of the Application.
    passwordField String
    Login password field.
    url String
    Login URL.
    usernameField String
    Login username field.
    accessibilityErrorRedirectUrl String
    Custom error page URL.
    accessibilityLoginRedirectUrl String
    Custom login page for this application.
    accessibilitySelfService Boolean
    Enable self-service. By default, it 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. Can be set to "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.
    optionalField1 String
    Name of optional param in the login form.
    optionalField1Value String
    Name of optional value in the login form.
    optionalField2 String
    Name of optional param in the login form.
    optionalField2Value String
    Name of optional value in the login form.
    optionalField3 String
    Name of optional param in the login form.
    optionalField3Value String
    Name of optional value in the login form.
    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".
    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 SecurePasswordStore 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 assigned to the application by Okta.
    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 assigned to the application by Okta.
    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 assigned to the application by Okta.
    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 assigned to the application by Okta.
    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 assigned to the application by Okta.
    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 assigned to the application by Okta.
    signOnMode String
    Sign-on mode of application.

    Look up Existing SecurePasswordStore Resource

    Get an existing SecurePasswordStore 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?: SecurePasswordStoreState, opts?: CustomResourceOptions): SecurePasswordStore
    @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,
        credentials_scheme: Optional[str] = None,
        enduser_note: 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,
        optional_field1: Optional[str] = None,
        optional_field1_value: Optional[str] = None,
        optional_field2: Optional[str] = None,
        optional_field2_value: Optional[str] = None,
        optional_field3: Optional[str] = None,
        optional_field3_value: Optional[str] = None,
        password_field: 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,
        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_field: Optional[str] = None) -> SecurePasswordStore
    func GetSecurePasswordStore(ctx *Context, name string, id IDInput, state *SecurePasswordStoreState, opts ...ResourceOption) (*SecurePasswordStore, error)
    public static SecurePasswordStore Get(string name, Input<string> id, SecurePasswordStoreState? state, CustomResourceOptions? opts = null)
    public static SecurePasswordStore get(String name, Output<String> id, SecurePasswordStoreState 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 for this application.
    AccessibilitySelfService bool
    Enable self-service. By default, it 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. Can be set to "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.
    Label string
    The display name of the Application.
    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 assigned to the application by Okta.
    OptionalField1 string
    Name of optional param in the login form.
    OptionalField1Value string
    Name of optional value in the login form.
    OptionalField2 string
    Name of optional param in the login form.
    OptionalField2Value string
    Name of optional value in the login form.
    OptionalField3 string
    Name of optional param in the login form.
    OptionalField3Value string
    Name of optional value in the login form.
    PasswordField string
    Login password field.
    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.
    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".
    UsernameField string
    Login username field.
    AccessibilityErrorRedirectUrl string
    Custom error page URL.
    AccessibilityLoginRedirectUrl string
    Custom login page for this application.
    AccessibilitySelfService bool
    Enable self-service. By default, it 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. Can be set to "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.
    Label string
    The display name of the Application.
    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 assigned to the application by Okta.
    OptionalField1 string
    Name of optional param in the login form.
    OptionalField1Value string
    Name of optional value in the login form.
    OptionalField2 string
    Name of optional param in the login form.
    OptionalField2Value string
    Name of optional value in the login form.
    OptionalField3 string
    Name of optional param in the login form.
    OptionalField3Value string
    Name of optional value in the login form.
    PasswordField string
    Login password field.
    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.
    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".
    UsernameField string
    Login username field.
    accessibilityErrorRedirectUrl String
    Custom error page URL.
    accessibilityLoginRedirectUrl String
    Custom login page for this application.
    accessibilitySelfService Boolean
    Enable self-service. By default, it 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. Can be set to "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.
    label String
    The display name of the Application.
    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 assigned to the application by Okta.
    optionalField1 String
    Name of optional param in the login form.
    optionalField1Value String
    Name of optional value in the login form.
    optionalField2 String
    Name of optional param in the login form.
    optionalField2Value String
    Name of optional value in the login form.
    optionalField3 String
    Name of optional param in the login form.
    optionalField3Value String
    Name of optional value in the login form.
    passwordField String
    Login password field.
    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.
    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".
    usernameField String
    Login username field.
    accessibilityErrorRedirectUrl string
    Custom error page URL.
    accessibilityLoginRedirectUrl string
    Custom login page for this application.
    accessibilitySelfService boolean
    Enable self-service. By default, it 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. Can be set to "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.
    label string
    The display name of the Application.
    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 assigned to the application by Okta.
    optionalField1 string
    Name of optional param in the login form.
    optionalField1Value string
    Name of optional value in the login form.
    optionalField2 string
    Name of optional param in the login form.
    optionalField2Value string
    Name of optional value in the login form.
    optionalField3 string
    Name of optional param in the login form.
    optionalField3Value string
    Name of optional value in the login form.
    passwordField string
    Login password field.
    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.
    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".
    usernameField string
    Login username field.
    accessibility_error_redirect_url str
    Custom error page URL.
    accessibility_login_redirect_url str
    Custom login page for this application.
    accessibility_self_service bool
    Enable self-service. By default, it 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. Can be set to "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.
    label str
    The display name of the Application.
    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 assigned to the application by Okta.
    optional_field1 str
    Name of optional param in the login form.
    optional_field1_value str
    Name of optional value in the login form.
    optional_field2 str
    Name of optional param in the login form.
    optional_field2_value str
    Name of optional value in the login form.
    optional_field3 str
    Name of optional param in the login form.
    optional_field3_value str
    Name of optional value in the login form.
    password_field str
    Login password field.
    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.
    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_field str
    Login username field.
    accessibilityErrorRedirectUrl String
    Custom error page URL.
    accessibilityLoginRedirectUrl String
    Custom login page for this application.
    accessibilitySelfService Boolean
    Enable self-service. By default, it 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. Can be set to "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.
    label String
    The display name of the Application.
    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 assigned to the application by Okta.
    optionalField1 String
    Name of optional param in the login form.
    optionalField1Value String
    Name of optional value in the login form.
    optionalField2 String
    Name of optional param in the login form.
    optionalField2Value String
    Name of optional value in the login form.
    optionalField3 String
    Name of optional param in the login form.
    optionalField3Value String
    Name of optional value in the login form.
    passwordField String
    Login password field.
    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.
    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".
    usernameField String
    Login username field.

    Import

    Secure Password Store Application can be imported via the Okta ID.

    $ pulumi import okta:app/securePasswordStore:SecurePasswordStore 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.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta