okta.AppSharedCredentials
Explore with Pulumi AI
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 thestatus
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", {
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",
});
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")
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{
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
})
}
using System.Collections.Generic;
using System.Linq;
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 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());
}
}
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
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 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.
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",
});
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"),
})
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());
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")
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",
});
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
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.
- Accessibility
Error stringRedirect Url - Custom error page URL.
- Accessibility
Login stringRedirect Url - Custom login page for this application.
- Accessibility
Self boolService - Enable self-service. By default, it is
false
. - Admin
Note string - Application notes for admins.
- App
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- Auto
Submit boolToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- Checkbox string
- CSS selector for the checkbox.
- Enduser
Note string - 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 string
- 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 string - CSS selector for the Password field in the sign-in form.
- Preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- Redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- Status string
- The status of the application, by default, it is
"ACTIVE"
. - Url string
- The URL of the sign-in page for this app.
- Url
Regex string - A regular expression that further restricts url to the specified regular expression.
- User
Name stringTemplate - Username template. Default:
"${source.login}"
- User
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - User
Name stringTemplate Suffix - Username template suffix.
- User
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - Username
Field string - CSS selector for the username field.
- Label string
- The Application's display name.
- Accessibility
Error stringRedirect Url - Custom error page URL.
- Accessibility
Login stringRedirect Url - Custom login page for this application.
- Accessibility
Self boolService - Enable self-service. By default, it is
false
. - Admin
Note string - Application notes for admins.
- App
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- Auto
Submit boolToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- Checkbox string
- CSS selector for the checkbox.
- Enduser
Note string - 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 string
- 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 string - CSS selector for the Password field in the sign-in form.
- Preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- Redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- Status string
- The status of the application, by default, it is
"ACTIVE"
. - Url string
- The URL of the sign-in page for this app.
- Url
Regex string - A regular expression that further restricts url to the specified regular expression.
- User
Name stringTemplate - Username template. Default:
"${source.login}"
- User
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - User
Name stringTemplate Suffix - Username template suffix.
- User
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - Username
Field string - CSS selector for the username field.
- label String
- The Application's display name.
- accessibility
Error StringRedirect Url - Custom error page URL.
- accessibility
Login StringRedirect Url - Custom login page for this application.
- accessibility
Self BooleanService - Enable self-service. By default, it is
false
. - admin
Note String - Application notes for admins.
- app
Links StringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit BooleanToolbar - Display auto submit toolbar.
- String
- CSS selector for the Sign-In button in the sign-in form.
- checkbox String
- CSS selector for the checkbox.
- enduser
Note String - Application notes for end users.
- hide
Ios Boolean - Do not display application icon on mobile app.
- hide
Web 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.
- password
Field String - CSS selector for the Password field in the sign-in form.
- preconfigured
App String - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url String - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- String
- Shared password, required for certain schemes.
- String
- Shared username, required for certain schemes.
- status String
- The status of the application, by default, it is
"ACTIVE"
. - url String
- The URL of the sign-in page for this app.
- url
Regex String - A regular expression that further restricts url to the specified regular expression.
- user
Name StringTemplate - Username template. Default:
"${source.login}"
- user
Name StringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name StringTemplate Suffix - Username template suffix.
- user
Name StringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field String - CSS selector for the username field.
- label string
- The Application's display name.
- accessibility
Error stringRedirect Url - Custom error page URL.
- accessibility
Login stringRedirect Url - Custom login page for this application.
- accessibility
Self booleanService - Enable self-service. By default, it is
false
. - admin
Note string - Application notes for admins.
- app
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit booleanToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- checkbox string
- CSS selector for the checkbox.
- enduser
Note string - Application notes for end users.
- hide
Ios boolean - Do not display application icon on mobile app.
- hide
Web 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.
- password
Field string - CSS selector for the Password field in the sign-in form.
- preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- status string
- The status of the application, by default, it is
"ACTIVE"
. - url string
- The URL of the sign-in page for this app.
- url
Regex string - A regular expression that further restricts url to the specified regular expression.
- user
Name stringTemplate - Username template. Default:
"${source.login}"
- user
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name stringTemplate Suffix - Username template suffix.
- user
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field string - CSS selector for the username field.
- label str
- The Application's display name.
- accessibility_
error_ strredirect_ url - Custom error page URL.
- accessibility_
login_ strredirect_ url - Custom login page for this application.
- accessibility_
self_ boolservice - Enable self-service. By default, it is
false
. - admin_
note str - Application notes for admins.
- app_
links_ strjson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto_
submit_ booltoolbar - Display auto submit toolbar.
- 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.
- 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.
- str
- Shared password, required for certain schemes.
- str
- Shared username, required for certain schemes.
- 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_ strtemplate - Username template. Default:
"${source.login}"
- user_
name_ strtemplate_ push_ status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user_
name_ strtemplate_ suffix - Username template suffix.
- user_
name_ strtemplate_ type - Username template type. Default:
"BUILT_IN"
. - username_
field str - CSS selector for the username field.
- label String
- The Application's display name.
- accessibility
Error StringRedirect Url - Custom error page URL.
- accessibility
Login StringRedirect Url - Custom login page for this application.
- accessibility
Self BooleanService - Enable self-service. By default, it is
false
. - admin
Note String - Application notes for admins.
- app
Links StringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit BooleanToolbar - Display auto submit toolbar.
- String
- CSS selector for the Sign-In button in the sign-in form.
- checkbox String
- CSS selector for the checkbox.
- enduser
Note String - Application notes for end users.
- hide
Ios Boolean - Do not display application icon on mobile app.
- hide
Web 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.
- password
Field String - CSS selector for the Password field in the sign-in form.
- preconfigured
App String - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url String - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- String
- Shared password, required for certain schemes.
- String
- Shared username, required for certain schemes.
- status String
- The status of the application, by default, it is
"ACTIVE"
. - url String
- The URL of the sign-in page for this app.
- url
Regex String - A regular expression that further restricts url to the specified regular expression.
- user
Name StringTemplate - Username template. Default:
"${source.login}"
- user
Name StringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name StringTemplate Suffix - Username template suffix.
- user
Name StringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field String - CSS selector for the 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.
- Logo
Url string - Direct link of application logo.
- Name string
- Name assigned to the application by Okta.
- Sign
On stringMode - Authentication mode of app.
- Id string
- The provider-assigned unique ID for this managed resource.
- Logo
Url string - Direct link of application logo.
- Name string
- Name assigned to the application by Okta.
- Sign
On stringMode - Authentication mode of app.
- id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - Direct link of application logo.
- name String
- Name assigned to the application by Okta.
- sign
On StringMode - Authentication mode of app.
- id string
- The provider-assigned unique ID for this managed resource.
- logo
Url string - Direct link of application logo.
- name string
- Name assigned to the application by Okta.
- sign
On stringMode - 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_ strmode - Authentication mode of app.
- id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - Direct link of application logo.
- name String
- Name assigned to the application by Okta.
- sign
On StringMode - 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,
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)
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.
- Accessibility
Error stringRedirect Url - Custom error page URL.
- Accessibility
Login stringRedirect Url - Custom login page for this application.
- Accessibility
Self boolService - Enable self-service. By default, it is
false
. - Admin
Note string - Application notes for admins.
- App
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- Auto
Submit boolToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- Checkbox string
- CSS selector for the checkbox.
- Enduser
Note string - 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 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.
- Logo
Url string - Direct link of application logo.
- Name string
- Name assigned to the application by Okta.
- Password
Field string - CSS selector for the Password field in the sign-in form.
- Preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- Redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- Sign
On stringMode - Authentication mode of app.
- Status string
- The status of the application, by default, it is
"ACTIVE"
. - Url string
- The URL of the sign-in page for this app.
- Url
Regex string - A regular expression that further restricts url to the specified regular expression.
- User
Name stringTemplate - Username template. Default:
"${source.login}"
- User
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - User
Name stringTemplate Suffix - Username template suffix.
- User
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - Username
Field string - CSS selector for the username field.
- Accessibility
Error stringRedirect Url - Custom error page URL.
- Accessibility
Login stringRedirect Url - Custom login page for this application.
- Accessibility
Self boolService - Enable self-service. By default, it is
false
. - Admin
Note string - Application notes for admins.
- App
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- Auto
Submit boolToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- Checkbox string
- CSS selector for the checkbox.
- Enduser
Note string - 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 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.
- Logo
Url string - Direct link of application logo.
- Name string
- Name assigned to the application by Okta.
- Password
Field string - CSS selector for the Password field in the sign-in form.
- Preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- Redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- Sign
On stringMode - Authentication mode of app.
- Status string
- The status of the application, by default, it is
"ACTIVE"
. - Url string
- The URL of the sign-in page for this app.
- Url
Regex string - A regular expression that further restricts url to the specified regular expression.
- User
Name stringTemplate - Username template. Default:
"${source.login}"
- User
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - User
Name stringTemplate Suffix - Username template suffix.
- User
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - Username
Field string - CSS selector for the username field.
- accessibility
Error StringRedirect Url - Custom error page URL.
- accessibility
Login StringRedirect Url - Custom login page for this application.
- accessibility
Self BooleanService - Enable self-service. By default, it is
false
. - admin
Note String - Application notes for admins.
- app
Links StringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit BooleanToolbar - Display auto submit toolbar.
- String
- CSS selector for the Sign-In button in the sign-in form.
- checkbox String
- CSS selector for the checkbox.
- enduser
Note String - Application notes for end users.
- hide
Ios Boolean - Do not display application icon on mobile app.
- hide
Web 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.
- logo
Url String - Direct link of application logo.
- name String
- Name assigned to the application by Okta.
- password
Field String - CSS selector for the Password field in the sign-in form.
- preconfigured
App String - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url String - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- String
- Shared password, required for certain schemes.
- String
- Shared username, required for certain schemes.
- sign
On StringMode - Authentication mode of app.
- status String
- The status of the application, by default, it is
"ACTIVE"
. - url String
- The URL of the sign-in page for this app.
- url
Regex String - A regular expression that further restricts url to the specified regular expression.
- user
Name StringTemplate - Username template. Default:
"${source.login}"
- user
Name StringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name StringTemplate Suffix - Username template suffix.
- user
Name StringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field String - CSS selector for the username field.
- accessibility
Error stringRedirect Url - Custom error page URL.
- accessibility
Login stringRedirect Url - Custom login page for this application.
- accessibility
Self booleanService - Enable self-service. By default, it is
false
. - admin
Note string - Application notes for admins.
- app
Links stringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit booleanToolbar - Display auto submit toolbar.
- string
- CSS selector for the Sign-In button in the sign-in form.
- checkbox string
- CSS selector for the checkbox.
- enduser
Note string - Application notes for end users.
- hide
Ios boolean - Do not display application icon on mobile app.
- hide
Web 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.
- logo
Url string - Direct link of application logo.
- name string
- Name assigned to the application by Okta.
- password
Field string - CSS selector for the Password field in the sign-in form.
- preconfigured
App string - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url string - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- string
- Shared password, required for certain schemes.
- string
- Shared username, required for certain schemes.
- sign
On stringMode - Authentication mode of app.
- status string
- The status of the application, by default, it is
"ACTIVE"
. - url string
- The URL of the sign-in page for this app.
- url
Regex string - A regular expression that further restricts url to the specified regular expression.
- user
Name stringTemplate - Username template. Default:
"${source.login}"
- user
Name stringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name stringTemplate Suffix - Username template suffix.
- user
Name stringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field string - CSS selector for the username field.
- accessibility_
error_ strredirect_ url - Custom error page URL.
- accessibility_
login_ strredirect_ url - Custom login page for this application.
- accessibility_
self_ boolservice - Enable self-service. By default, it is
false
. - admin_
note str - Application notes for admins.
- app_
links_ strjson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto_
submit_ booltoolbar - Display auto submit toolbar.
- 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.
- 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.
- str
- Shared password, required for certain schemes.
- str
- Shared username, required for certain schemes.
- sign_
on_ strmode - Authentication mode of app.
- 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_ strtemplate - Username template. Default:
"${source.login}"
- user_
name_ strtemplate_ push_ status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user_
name_ strtemplate_ suffix - Username template suffix.
- user_
name_ strtemplate_ type - Username template type. Default:
"BUILT_IN"
. - username_
field str - CSS selector for the username field.
- accessibility
Error StringRedirect Url - Custom error page URL.
- accessibility
Login StringRedirect Url - Custom login page for this application.
- accessibility
Self BooleanService - Enable self-service. By default, it is
false
. - admin
Note String - Application notes for admins.
- app
Links StringJson - Displays specific appLinks for the app. The value for each application link should be boolean.
- auto
Submit BooleanToolbar - Display auto submit toolbar.
- String
- CSS selector for the Sign-In button in the sign-in form.
- checkbox String
- CSS selector for the checkbox.
- enduser
Note String - Application notes for end users.
- hide
Ios Boolean - Do not display application icon on mobile app.
- hide
Web 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.
- logo
Url String - Direct link of application logo.
- name String
- Name assigned to the application by Okta.
- password
Field String - CSS selector for the Password field in the sign-in form.
- preconfigured
App String - name of application from the Okta Integration Network, if not included a custom app will be created.
- redirect
Url String - Redirect URL. If going to the login page URL redirects to another page, then enter that URL here.
- String
- Shared password, required for certain schemes.
- String
- Shared username, required for certain schemes.
- sign
On StringMode - Authentication mode of app.
- status String
- The status of the application, by default, it is
"ACTIVE"
. - url String
- The URL of the sign-in page for this app.
- url
Regex String - A regular expression that further restricts url to the specified regular expression.
- user
Name StringTemplate - Username template. Default:
"${source.login}"
- user
Name StringTemplate Push Status - Push username on update. Valid values:
"PUSH"
and"DONT_PUSH"
. - user
Name StringTemplate Suffix - Username template suffix.
- user
Name StringTemplate Type - Username template type. Default:
"BUILT_IN"
. - username
Field String - CSS selector for the username field.
Import
Okta SWA Shared Credentials App can be imported via the Okta ID.
$ pulumi import okta:index/appSharedCredentials:AppSharedCredentials example <app id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
okta
Terraform Provider.