Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. AppSharedCredentials
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

okta.AppSharedCredentials

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

Creates a SWA shared credentials app. This resource allows you to create and configure SWA shared credentials app.

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.AppSharedCredentials("example", {
    label: "Example App",
    status: "ACTIVE",
    buttonField: "btn-login",
    usernameField: "txtbox-username",
    passwordField: "txtbox-password",
    url: "https://example.com/login.html",
    redirectUrl: "https://example.com/redirect_url",
    checkbox: "checkbox_red",
    userNameTemplate: "user.firstName",
    userNameTemplateType: "CUSTOM",
    userNameTemplateSuffix: "hello",
    sharedPassword: "sharedpass",
    sharedUsername: "sharedusername",
    accessibilitySelfService: true,
    accessibilityErrorRedirectUrl: "https://example.com/redirect_url_1",
    accessibilityLoginRedirectUrl: "https://example.com/redirect_url_2",
    autoSubmitToolbar: true,
    hideIos: true,
});
Copy
import pulumi
import pulumi_okta as okta

example = okta.AppSharedCredentials("example",
    label="Example App",
    status="ACTIVE",
    button_field="btn-login",
    username_field="txtbox-username",
    password_field="txtbox-password",
    url="https://example.com/login.html",
    redirect_url="https://example.com/redirect_url",
    checkbox="checkbox_red",
    user_name_template="user.firstName",
    user_name_template_type="CUSTOM",
    user_name_template_suffix="hello",
    shared_password="sharedpass",
    shared_username="sharedusername",
    accessibility_self_service=True,
    accessibility_error_redirect_url="https://example.com/redirect_url_1",
    accessibility_login_redirect_url="https://example.com/redirect_url_2",
    auto_submit_toolbar=True,
    hide_ios=True)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewAppSharedCredentials(ctx, "example", &okta.AppSharedCredentialsArgs{
			Label:                         pulumi.String("Example App"),
			Status:                        pulumi.String("ACTIVE"),
			ButtonField:                   pulumi.String("btn-login"),
			UsernameField:                 pulumi.String("txtbox-username"),
			PasswordField:                 pulumi.String("txtbox-password"),
			Url:                           pulumi.String("https://example.com/login.html"),
			RedirectUrl:                   pulumi.String("https://example.com/redirect_url"),
			Checkbox:                      pulumi.String("checkbox_red"),
			UserNameTemplate:              pulumi.String("user.firstName"),
			UserNameTemplateType:          pulumi.String("CUSTOM"),
			UserNameTemplateSuffix:        pulumi.String("hello"),
			SharedPassword:                pulumi.String("sharedpass"),
			SharedUsername:                pulumi.String("sharedusername"),
			AccessibilitySelfService:      pulumi.Bool(true),
			AccessibilityErrorRedirectUrl: pulumi.String("https://example.com/redirect_url_1"),
			AccessibilityLoginRedirectUrl: pulumi.String("https://example.com/redirect_url_2"),
			AutoSubmitToolbar:             pulumi.Bool(true),
			HideIos:                       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.AppSharedCredentials("example", new()
    {
        Label = "Example App",
        Status = "ACTIVE",
        ButtonField = "btn-login",
        UsernameField = "txtbox-username",
        PasswordField = "txtbox-password",
        Url = "https://example.com/login.html",
        RedirectUrl = "https://example.com/redirect_url",
        Checkbox = "checkbox_red",
        UserNameTemplate = "user.firstName",
        UserNameTemplateType = "CUSTOM",
        UserNameTemplateSuffix = "hello",
        SharedPassword = "sharedpass",
        SharedUsername = "sharedusername",
        AccessibilitySelfService = true,
        AccessibilityErrorRedirectUrl = "https://example.com/redirect_url_1",
        AccessibilityLoginRedirectUrl = "https://example.com/redirect_url_2",
        AutoSubmitToolbar = true,
        HideIos = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.AppSharedCredentials;
import com.pulumi.okta.AppSharedCredentialsArgs;
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 AppSharedCredentials("example", AppSharedCredentialsArgs.builder()
            .label("Example App")
            .status("ACTIVE")
            .buttonField("btn-login")
            .usernameField("txtbox-username")
            .passwordField("txtbox-password")
            .url("https://example.com/login.html")
            .redirectUrl("https://example.com/redirect_url")
            .checkbox("checkbox_red")
            .userNameTemplate("user.firstName")
            .userNameTemplateType("CUSTOM")
            .userNameTemplateSuffix("hello")
            .sharedPassword("sharedpass")
            .sharedUsername("sharedusername")
            .accessibilitySelfService(true)
            .accessibilityErrorRedirectUrl("https://example.com/redirect_url_1")
            .accessibilityLoginRedirectUrl("https://example.com/redirect_url_2")
            .autoSubmitToolbar(true)
            .hideIos(true)
            .build());

    }
}
Copy
resources:
  example:
    type: okta:AppSharedCredentials
    properties:
      label: Example App
      status: ACTIVE
      buttonField: btn-login
      usernameField: txtbox-username
      passwordField: txtbox-password
      url: https://example.com/login.html
      redirectUrl: https://example.com/redirect_url
      checkbox: checkbox_red
      userNameTemplate: user.firstName
      userNameTemplateType: CUSTOM
      userNameTemplateSuffix: hello
      sharedPassword: sharedpass
      sharedUsername: sharedusername
      accessibilitySelfService: true
      accessibilityErrorRedirectUrl: https://example.com/redirect_url_1
      accessibilityLoginRedirectUrl: https://example.com/redirect_url_2
      autoSubmitToolbar: true
      hideIos: true
Copy

Create AppSharedCredentials Resource

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

Constructor syntax

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

@overload
def AppSharedCredentials(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         label: Optional[str] = None,
                         logo: Optional[str] = None,
                         auto_submit_toolbar: Optional[bool] = None,
                         password_field: Optional[str] = None,
                         app_links_json: Optional[str] = None,
                         preconfigured_app: Optional[str] = None,
                         button_field: Optional[str] = None,
                         checkbox: Optional[str] = None,
                         redirect_url: Optional[str] = None,
                         hide_ios: Optional[bool] = None,
                         hide_web: Optional[bool] = None,
                         accessibility_login_redirect_url: Optional[str] = None,
                         accessibility_error_redirect_url: Optional[str] = None,
                         admin_note: Optional[str] = None,
                         accessibility_self_service: Optional[bool] = None,
                         enduser_note: Optional[str] = None,
                         shared_password: Optional[str] = None,
                         shared_username: 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_field: Optional[str] = None)
func NewAppSharedCredentials(ctx *Context, name string, args AppSharedCredentialsArgs, opts ...ResourceOption) (*AppSharedCredentials, error)
public AppSharedCredentials(string name, AppSharedCredentialsArgs args, CustomResourceOptions? opts = null)
public AppSharedCredentials(String name, AppSharedCredentialsArgs args)
public AppSharedCredentials(String name, AppSharedCredentialsArgs args, CustomResourceOptions options)

type: okta:AppSharedCredentials
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AppSharedCredentialsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AppSharedCredentialsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AppSharedCredentialsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AppSharedCredentialsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppSharedCredentialsArgs
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 appSharedCredentialsResource = new Okta.AppSharedCredentials("appSharedCredentialsResource", new()
{
    Label = "string",
    Logo = "string",
    AutoSubmitToolbar = false,
    PasswordField = "string",
    AppLinksJson = "string",
    PreconfiguredApp = "string",
    ButtonField = "string",
    Checkbox = "string",
    RedirectUrl = "string",
    HideIos = false,
    HideWeb = false,
    AccessibilityLoginRedirectUrl = "string",
    AccessibilityErrorRedirectUrl = "string",
    AdminNote = "string",
    AccessibilitySelfService = false,
    EnduserNote = "string",
    SharedPassword = "string",
    SharedUsername = "string",
    Status = "string",
    Url = "string",
    UrlRegex = "string",
    UserNameTemplate = "string",
    UserNameTemplatePushStatus = "string",
    UserNameTemplateSuffix = "string",
    UserNameTemplateType = "string",
    UsernameField = "string",
});
Copy
example, err := okta.NewAppSharedCredentials(ctx, "appSharedCredentialsResource", &okta.AppSharedCredentialsArgs{
	Label:                         pulumi.String("string"),
	Logo:                          pulumi.String("string"),
	AutoSubmitToolbar:             pulumi.Bool(false),
	PasswordField:                 pulumi.String("string"),
	AppLinksJson:                  pulumi.String("string"),
	PreconfiguredApp:              pulumi.String("string"),
	ButtonField:                   pulumi.String("string"),
	Checkbox:                      pulumi.String("string"),
	RedirectUrl:                   pulumi.String("string"),
	HideIos:                       pulumi.Bool(false),
	HideWeb:                       pulumi.Bool(false),
	AccessibilityLoginRedirectUrl: pulumi.String("string"),
	AccessibilityErrorRedirectUrl: pulumi.String("string"),
	AdminNote:                     pulumi.String("string"),
	AccessibilitySelfService:      pulumi.Bool(false),
	EnduserNote:                   pulumi.String("string"),
	SharedPassword:                pulumi.String("string"),
	SharedUsername:                pulumi.String("string"),
	Status:                        pulumi.String("string"),
	Url:                           pulumi.String("string"),
	UrlRegex:                      pulumi.String("string"),
	UserNameTemplate:              pulumi.String("string"),
	UserNameTemplatePushStatus:    pulumi.String("string"),
	UserNameTemplateSuffix:        pulumi.String("string"),
	UserNameTemplateType:          pulumi.String("string"),
	UsernameField:                 pulumi.String("string"),
})
Copy
var appSharedCredentialsResource = new AppSharedCredentials("appSharedCredentialsResource", AppSharedCredentialsArgs.builder()
    .label("string")
    .logo("string")
    .autoSubmitToolbar(false)
    .passwordField("string")
    .appLinksJson("string")
    .preconfiguredApp("string")
    .buttonField("string")
    .checkbox("string")
    .redirectUrl("string")
    .hideIos(false)
    .hideWeb(false)
    .accessibilityLoginRedirectUrl("string")
    .accessibilityErrorRedirectUrl("string")
    .adminNote("string")
    .accessibilitySelfService(false)
    .enduserNote("string")
    .sharedPassword("string")
    .sharedUsername("string")
    .status("string")
    .url("string")
    .urlRegex("string")
    .userNameTemplate("string")
    .userNameTemplatePushStatus("string")
    .userNameTemplateSuffix("string")
    .userNameTemplateType("string")
    .usernameField("string")
    .build());
Copy
app_shared_credentials_resource = okta.AppSharedCredentials("appSharedCredentialsResource",
    label="string",
    logo="string",
    auto_submit_toolbar=False,
    password_field="string",
    app_links_json="string",
    preconfigured_app="string",
    button_field="string",
    checkbox="string",
    redirect_url="string",
    hide_ios=False,
    hide_web=False,
    accessibility_login_redirect_url="string",
    accessibility_error_redirect_url="string",
    admin_note="string",
    accessibility_self_service=False,
    enduser_note="string",
    shared_password="string",
    shared_username="string",
    status="string",
    url="string",
    url_regex="string",
    user_name_template="string",
    user_name_template_push_status="string",
    user_name_template_suffix="string",
    user_name_template_type="string",
    username_field="string")
Copy
const appSharedCredentialsResource = new okta.AppSharedCredentials("appSharedCredentialsResource", {
    label: "string",
    logo: "string",
    autoSubmitToolbar: false,
    passwordField: "string",
    appLinksJson: "string",
    preconfiguredApp: "string",
    buttonField: "string",
    checkbox: "string",
    redirectUrl: "string",
    hideIos: false,
    hideWeb: false,
    accessibilityLoginRedirectUrl: "string",
    accessibilityErrorRedirectUrl: "string",
    adminNote: "string",
    accessibilitySelfService: false,
    enduserNote: "string",
    sharedPassword: "string",
    sharedUsername: "string",
    status: "string",
    url: "string",
    urlRegex: "string",
    userNameTemplate: "string",
    userNameTemplatePushStatus: "string",
    userNameTemplateSuffix: "string",
    userNameTemplateType: "string",
    usernameField: "string",
});
Copy
type: okta:AppSharedCredentials
properties:
    accessibilityErrorRedirectUrl: string
    accessibilityLoginRedirectUrl: string
    accessibilitySelfService: false
    adminNote: string
    appLinksJson: string
    autoSubmitToolbar: false
    buttonField: string
    checkbox: string
    enduserNote: string
    hideIos: false
    hideWeb: false
    label: string
    logo: string
    passwordField: string
    preconfiguredApp: string
    redirectUrl: string
    sharedPassword: string
    sharedUsername: string
    status: string
    url: string
    urlRegex: string
    userNameTemplate: string
    userNameTemplatePushStatus: string
    userNameTemplateSuffix: string
    userNameTemplateType: string
    usernameField: string
Copy

AppSharedCredentials Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AppSharedCredentials resource accepts the following input properties:

Label This property is required. string
The Application's display name.
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
ButtonField string
Login button field
Checkbox string
CSS selector for the checkbox
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.
PasswordField string
Login password field
PreconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
RedirectUrl string
Secondary URL of the sign-in page for this app
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
Url string
The URL of the sign-in page for this app.
UrlRegex string
A regular expression that further restricts url to the specified regular expression.
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
Label This property is required. string
The Application's display name.
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
ButtonField string
Login button field
Checkbox string
CSS selector for the checkbox
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.
PasswordField string
Login password field
PreconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
RedirectUrl string
Secondary URL of the sign-in page for this app
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
Url string
The URL of the sign-in page for this app.
UrlRegex string
A regular expression that further restricts url to the specified regular expression.
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
label This property is required. String
The Application's display name.
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
buttonField String
Login button field
checkbox String
CSS selector for the checkbox
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.
passwordField String
Login password field
preconfiguredApp String
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl String
Secondary URL of the sign-in page for this app
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
url String
The URL of the sign-in page for this app.
urlRegex String
A regular expression that further restricts url to the specified regular expression.
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
label This property is required. string
The Application's display name.
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
buttonField string
Login button field
checkbox string
CSS selector for the checkbox
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.
passwordField string
Login password field
preconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl string
Secondary URL of the sign-in page for this app
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
url string
The URL of the sign-in page for this app.
urlRegex string
A regular expression that further restricts url to the specified regular expression.
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
label This property is required. str
The Application's display name.
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_field str
Login button field
checkbox str
CSS selector for the checkbox
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.
password_field str
Login password field
preconfigured_app str
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirect_url str
Secondary URL of the sign-in page for this app
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 str
The URL of the sign-in page for this app.
url_regex str
A regular expression that further restricts url to the specified regular expression.
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
label This property is required. String
The Application's display name.
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
buttonField String
Login button field
checkbox String
CSS selector for the checkbox
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.
passwordField String
Login password field
preconfiguredApp String
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl String
Secondary URL of the sign-in page for this app
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
url String
The URL of the sign-in page for this app.
urlRegex String
A regular expression that further restricts url to the specified regular expression.
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

Outputs

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

Get an existing AppSharedCredentials 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?: AppSharedCredentialsState, opts?: CustomResourceOptions): AppSharedCredentials
@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_field: Optional[str] = None,
        checkbox: 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,
        password_field: Optional[str] = None,
        preconfigured_app: Optional[str] = None,
        redirect_url: Optional[str] = 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_field: Optional[str] = None) -> AppSharedCredentials
func GetAppSharedCredentials(ctx *Context, name string, id IDInput, state *AppSharedCredentialsState, opts ...ResourceOption) (*AppSharedCredentials, error)
public static AppSharedCredentials Get(string name, Input<string> id, AppSharedCredentialsState? state, CustomResourceOptions? opts = null)
public static AppSharedCredentials get(String name, Output<String> id, AppSharedCredentialsState state, CustomResourceOptions options)
resources:  _:    type: okta:AppSharedCredentials    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
ButtonField string
Login button field
Checkbox string
CSS selector for the checkbox
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 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.
PasswordField string
Login password field
PreconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
RedirectUrl string
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
UrlRegex string
A regular expression that further restricts url to the specified regular expression.
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 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
ButtonField string
Login button field
Checkbox string
CSS selector for the checkbox
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 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.
PasswordField string
Login password field
PreconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
RedirectUrl string
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
UrlRegex string
A regular expression that further restricts url to the specified regular expression.
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 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
buttonField String
Login button field
checkbox String
CSS selector for the checkbox
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 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.
passwordField String
Login password field
preconfiguredApp String
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl String
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
urlRegex String
A regular expression that further restricts url to the specified regular expression.
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 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
buttonField string
Login button field
checkbox string
CSS selector for the checkbox
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 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.
passwordField string
Login password field
preconfiguredApp string
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl string
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
urlRegex string
A regular expression that further restricts url to the specified regular expression.
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 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_field str
Login button field
checkbox str
CSS selector for the checkbox
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 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_field str
Login password field
preconfigured_app str
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirect_url str
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
url_regex str
A regular expression that further restricts url to the specified regular expression.
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 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
buttonField String
Login button field
checkbox String
CSS selector for the checkbox
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 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.
passwordField String
Login password field
preconfiguredApp String
Name of application from the Okta Integration Network, if not included a custom app will be created.
redirectUrl String
Secondary URL of the sign-in page for this app
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
The URL of the sign-in page for this app.
urlRegex String
A regular expression that further restricts url to the specified regular expression.
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

$ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example <app_id>
Copy

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 v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta