1. Pulumi Registry
  2. Okta
  3. API Docs
  4. AppSharedCredentials
okta logo
Okta v3.21.0, Mar 15 23

okta.AppSharedCredentials

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

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

});

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/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{
			AccessibilityErrorRedirectUrl: pulumi.String("https://example.com/redirect_url_1"),
			AccessibilityLoginRedirectUrl: pulumi.String("https://example.com/redirect_url_2"),
			AccessibilitySelfService:      pulumi.Bool(true),
			AutoSubmitToolbar:             pulumi.Bool(true),
			ButtonField:                   pulumi.String("btn-login"),
			Checkbox:                      pulumi.String("checkbox_red"),
			HideIos:                       pulumi.Bool(true),
			Label:                         pulumi.String("Example App"),
			PasswordField:                 pulumi.String("txtbox-password"),
			RedirectUrl:                   pulumi.String("https://example.com/redirect_url"),
			SharedPassword:                pulumi.String("sharedpass"),
			SharedUsername:                pulumi.String("sharedusername"),
			Status:                        pulumi.String("ACTIVE"),
			Url:                           pulumi.String("https://example.com/login.html"),
			UserNameTemplate:              pulumi.String("user.firstName"),
			UserNameTemplateSuffix:        pulumi.String("hello"),
			UserNameTemplateType:          pulumi.String("CUSTOM"),
			UsernameField:                 pulumi.String("txtbox-username"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

    }
}

import pulumi
import pulumi_okta as okta

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

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

const example = new okta.AppSharedCredentials("example", {
    accessibilityErrorRedirectUrl: "https://example.com/redirect_url_1",
    accessibilityLoginRedirectUrl: "https://example.com/redirect_url_2",
    accessibilitySelfService: true,
    autoSubmitToolbar: true,
    buttonField: "btn-login",
    checkbox: "checkbox_red",
    hideIos: true,
    label: "Example App",
    passwordField: "txtbox-password",
    redirectUrl: "https://example.com/redirect_url",
    sharedPassword: "sharedpass",
    sharedUsername: "sharedusername",
    status: "ACTIVE",
    url: "https://example.com/login.html",
    userNameTemplate: "user.firstName",
    userNameTemplateSuffix: "hello",
    userNameTemplateType: "CUSTOM",
    usernameField: "txtbox-username",
});

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

Create AppSharedCredentials Resource

new AppSharedCredentials(name: string, args: AppSharedCredentialsArgs, opts?: CustomResourceOptions);
@overload
def AppSharedCredentials(resource_name: 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,
                         groups: Optional[Sequence[str]] = None,
                         hide_ios: Optional[bool] = None,
                         hide_web: Optional[bool] = None,
                         label: Optional[str] = None,
                         logo: 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,
                         skip_groups: Optional[bool] = None,
                         skip_users: Optional[bool] = 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,
                         users: Optional[Sequence[AppSharedCredentialsUserArgs]] = None)
@overload
def AppSharedCredentials(resource_name: str,
                         args: AppSharedCredentialsArgs,
                         opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args AppSharedCredentialsArgs
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 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 string
The unique name of the resource.
args AppSharedCredentialsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSharedCredentialsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppSharedCredentialsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The AppSharedCredentials resource accepts the following input properties:

Label string

The Application's display name.

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.

ButtonField string

CSS selector for the Sign-In button in the sign-in form.

Checkbox string

CSS selector for the checkbox.

EnduserNote string

Application notes for end users.

Groups List<string>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

RedirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

SharedPassword string

Shared password, required for certain schemes.

SharedUsername string

Shared username, required for certain schemes.

SkipGroups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

Status string

The status of the 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

CSS selector for the username field.

Users List<AppSharedCredentialsUserArgs>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Label string

The Application's display name.

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.

ButtonField string

CSS selector for the Sign-In button in the sign-in form.

Checkbox string

CSS selector for the checkbox.

EnduserNote string

Application notes for end users.

Groups []string

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

RedirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

SharedPassword string

Shared password, required for certain schemes.

SharedUsername string

Shared username, required for certain schemes.

SkipGroups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

Status string

The status of the 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

CSS selector for the username field.

Users []AppSharedCredentialsUserArgs

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label String

The Application's display name.

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.

buttonField String

CSS selector for the Sign-In button in the sign-in form.

checkbox String

CSS selector for the checkbox.

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl String

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword String

Shared password, required for certain schemes.

sharedUsername String

Shared username, required for certain schemes.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status String

The status of the 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

CSS selector for the username field.

users List<AppSharedCredentialsUserArgs>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label string

The Application's display name.

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.

buttonField string

CSS selector for the Sign-In button in the sign-in form.

checkbox string

CSS selector for the checkbox.

enduserNote string

Application notes for end users.

groups string[]

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

preconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword string

Shared password, required for certain schemes.

sharedUsername string

Shared username, required for certain schemes.

skipGroups boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status string

The status of the 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

CSS selector for the username field.

users AppSharedCredentialsUserArgs[]

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label str

The Application's display name.

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.

button_field str

CSS selector for the Sign-In button in the sign-in form.

checkbox str

CSS selector for the checkbox.

enduser_note str

Application notes for end users.

groups Sequence[str]

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

preconfigured_app str

name of application from the Okta Integration Network, if not included a custom app will be created.

redirect_url str

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

shared_password str

Shared password, required for certain schemes.

shared_username str

Shared username, required for certain schemes.

skip_groups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skip_users bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status str

The status of the 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

CSS selector for the username field.

users Sequence[AppSharedCredentialsUserArgs]

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

label String

The Application's display name.

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.

buttonField String

CSS selector for the Sign-In button in the sign-in form.

checkbox String

CSS selector for the checkbox.

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

CSS selector for the Password field in the sign-in form.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl String

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword String

Shared password, required for certain schemes.

sharedUsername String

Shared username, required for certain schemes.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status String

The status of the 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

CSS selector for the username field.

users List<Property Map>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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

Direct link of application logo.

Name string

Name assigned to the application by Okta.

SignOnMode string

Authentication mode of app.

Id string

The provider-assigned unique ID for this managed resource.

LogoUrl string

Direct link of application logo.

Name string

Name assigned to the application by Okta.

SignOnMode string

Authentication mode of app.

id String

The provider-assigned unique ID for this managed resource.

logoUrl String

Direct link of application logo.

name String

Name assigned to the application by Okta.

signOnMode String

Authentication mode of app.

id string

The provider-assigned unique ID for this managed resource.

logoUrl string

Direct link of application logo.

name string

Name assigned to the application by Okta.

signOnMode string

Authentication mode of app.

id str

The provider-assigned unique ID for this managed resource.

logo_url str

Direct link of application logo.

name str

Name assigned to the application by Okta.

sign_on_mode str

Authentication mode of app.

id String

The provider-assigned unique ID for this managed resource.

logoUrl String

Direct link of application logo.

name String

Name assigned to the application by Okta.

signOnMode String

Authentication mode of app.

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,
        groups: Optional[Sequence[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,
        skip_groups: Optional[bool] = None,
        skip_users: Optional[bool] = 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,
        users: Optional[Sequence[AppSharedCredentialsUserArgs]] = 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)
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.

ButtonField string

CSS selector for the Sign-In button in the sign-in form.

Checkbox string

CSS selector for the checkbox.

EnduserNote string

Application notes for end users.

Groups List<string>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

Name string

Name assigned to the application by Okta.

PasswordField string

CSS selector for the Password field in the sign-in form.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

RedirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

SharedPassword string

Shared password, required for certain schemes.

SharedUsername string

Shared username, required for certain schemes.

SignOnMode string

Authentication mode of app.

SkipGroups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

Status string

The status of the 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

CSS selector for the username field.

Users List<AppSharedCredentialsUserArgs>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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.

ButtonField string

CSS selector for the Sign-In button in the sign-in form.

Checkbox string

CSS selector for the checkbox.

EnduserNote string

Application notes for end users.

Groups []string

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

Name string

Name assigned to the application by Okta.

PasswordField string

CSS selector for the Password field in the sign-in form.

PreconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

RedirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

SharedPassword string

Shared password, required for certain schemes.

SharedUsername string

Shared username, required for certain schemes.

SignOnMode string

Authentication mode of app.

SkipGroups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

Status string

The status of the 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

CSS selector for the username field.

Users []AppSharedCredentialsUserArgs

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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.

buttonField String

CSS selector for the Sign-In button in the sign-in form.

checkbox String

CSS selector for the checkbox.

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

name String

Name assigned to the application by Okta.

passwordField String

CSS selector for the Password field in the sign-in form.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl String

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword String

Shared password, required for certain schemes.

sharedUsername String

Shared username, required for certain schemes.

signOnMode String

Authentication mode of app.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status String

The status of the 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

CSS selector for the username field.

users List<AppSharedCredentialsUserArgs>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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.

buttonField string

CSS selector for the Sign-In button in the sign-in form.

checkbox string

CSS selector for the checkbox.

enduserNote string

Application notes for end users.

groups string[]

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

name string

Name assigned to the application by Okta.

passwordField string

CSS selector for the Password field in the sign-in form.

preconfiguredApp string

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl string

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword string

Shared password, required for certain schemes.

sharedUsername string

Shared username, required for certain schemes.

signOnMode string

Authentication mode of app.

skipGroups boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status string

The status of the 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

CSS selector for the username field.

users AppSharedCredentialsUserArgs[]

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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.

button_field str

CSS selector for the Sign-In button in the sign-in form.

checkbox str

CSS selector for the checkbox.

enduser_note str

Application notes for end users.

groups Sequence[str]

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

name str

Name assigned to the application by Okta.

password_field str

CSS selector for the Password field in the sign-in form.

preconfigured_app str

name of application from the Okta Integration Network, if not included a custom app will be created.

redirect_url str

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

shared_password str

Shared password, required for certain schemes.

shared_username str

Shared username, required for certain schemes.

sign_on_mode str

Authentication mode of app.

skip_groups bool

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skip_users bool

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status str

The status of the 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

CSS selector for the username field.

users Sequence[AppSharedCredentialsUserArgs]

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

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.

buttonField String

CSS selector for the Sign-In button in the sign-in form.

checkbox String

CSS selector for the checkbox.

enduserNote String

Application notes for end users.

groups List<String>

Groups associated with the application. See okta.app.GroupAssignment for a more flexible approach.

Deprecated:

The direct configuration of groups in this app resource is deprecated, please ensure you use the resource okta_app_group_assignments for this functionality.

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

Direct link of application logo.

name String

Name assigned to the application by Okta.

passwordField String

CSS selector for the Password field in the sign-in form.

preconfiguredApp String

name of application from the Okta Integration Network, if not included a custom app will be created.

redirectUrl String

Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.

sharedPassword String

Shared password, required for certain schemes.

sharedUsername String

Shared username, required for certain schemes.

signOnMode String

Authentication mode of app.

skipGroups Boolean

Indicator that allows the app to skip groups sync (it's also can be provided during import). Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync (it's also can be provided during import). Default is false.

status String

The status of the 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

CSS selector for the username field.

users List<Property Map>

The users assigned to the application. See okta.app.User for a more flexible approach.

Deprecated:

The direct configuration of users in this app resource is deprecated, please ensure you use the resource okta_app_user for this functionality.

Supporting Types

AppSharedCredentialsUser

Id string

ID of an app.

Password string
Scope string
Username string
Id string

ID of an app.

Password string
Scope string
Username string
id String

ID of an app.

password String
scope String
username String
id string

ID of an app.

password string
scope string
username string
id str

ID of an app.

password str
scope str
username str
id String

ID of an app.

password String
scope String
username String

Import

Okta SWA Shared Credentials App can be imported via the Okta ID.

 $ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example &#60;app id&#62;

It’s also possible to import app without groups or/and users. In this case ID may look like this

 $ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example &#60;app id&#62;/skip_users

 $ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example &#60;app id&#62;/skip_users/skip_groups

 $ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example &#60;app id&#62;/skip_groups

Package Details

Repository
Okta pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.