Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. app
  5. BasicAuth
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.app.BasicAuth

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    This resource allows you to create and configure an Auto Login Okta Application.

    During an apply if there is change in status the app will first be activated or deactivated in accordance with the status change. Then, all other arguments that changed will be applied.

    Example Usage

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

const example = new okta.app.BasicAuth("example", {
    label: "Example",
    url: "https://example.com/login.html",
    authUrl: "https://example.com/auth.html",
});

    import pulumi
import pulumi_okta as okta

example = okta.app.BasicAuth("example",
    label="Example",
    url="https://example.com/login.html",
    auth_url="https://example.com/auth.html")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.NewBasicAuth(ctx, "example", &app.BasicAuthArgs{
			Label:   pulumi.String("Example"),
			Url:     pulumi.String("https://example.com/login.html"),
			AuthUrl: pulumi.String("https://example.com/auth.html"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.App.BasicAuth("example", new()
    {
        Label = "Example",
        Url = "https://example.com/login.html",
        AuthUrl = "https://example.com/auth.html",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.BasicAuth;
import com.pulumi.okta.app.BasicAuthArgs;
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 BasicAuth("example", BasicAuthArgs.builder()
            .label("Example")
            .url("https://example.com/login.html")
            .authUrl("https://example.com/auth.html")
            .build());

    }
}

    resources:
  example:
    type: okta:app:BasicAuth
    properties:
      label: Example
      url: https://example.com/login.html
      authUrl: https://example.com/auth.html

    Create BasicAuth Resource

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

    Constructor syntax

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

@overload
def BasicAuth(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auth_url: Optional[str] = None,
              url: Optional[str] = None,
              label: Optional[str] = None,
              auto_submit_toolbar: Optional[bool] = None,
              app_links_json: Optional[str] = None,
              admin_note: Optional[str] = None,
              accessibility_error_redirect_url: Optional[str] = None,
              enduser_note: Optional[str] = None,
              hide_ios: Optional[bool] = None,
              hide_web: Optional[bool] = None,
              accessibility_self_service: Optional[bool] = None,
              logo: Optional[str] = None,
              status: Optional[str] = None,
              accessibility_login_redirect_url: Optional[str] = None)
    func NewBasicAuth(ctx *Context, name string, args BasicAuthArgs, opts ...ResourceOption) (*BasicAuth, error)
    public BasicAuth(string name, BasicAuthArgs args, CustomResourceOptions? opts = null)
    public BasicAuth(String name, BasicAuthArgs args)
public BasicAuth(String name, BasicAuthArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var basicAuthResource = new Okta.App.BasicAuth("basicAuthResource", new()
{
    AuthUrl = "string",
    Url = "string",
    Label = "string",
    AutoSubmitToolbar = false,
    AppLinksJson = "string",
    AdminNote = "string",
    AccessibilityErrorRedirectUrl = "string",
    EnduserNote = "string",
    HideIos = false,
    HideWeb = false,
    AccessibilitySelfService = false,
    Logo = "string",
    Status = "string",
    AccessibilityLoginRedirectUrl = "string",
});

    example, err := app.NewBasicAuth(ctx, "basicAuthResource", &app.BasicAuthArgs{
	AuthUrl:                       pulumi.String("string"),
	Url:                           pulumi.String("string"),
	Label:                         pulumi.String("string"),
	AutoSubmitToolbar:             pulumi.Bool(false),
	AppLinksJson:                  pulumi.String("string"),
	AdminNote:                     pulumi.String("string"),
	AccessibilityErrorRedirectUrl: pulumi.String("string"),
	EnduserNote:                   pulumi.String("string"),
	HideIos:                       pulumi.Bool(false),
	HideWeb:                       pulumi.Bool(false),
	AccessibilitySelfService:      pulumi.Bool(false),
	Logo:                          pulumi.String("string"),
	Status:                        pulumi.String("string"),
	AccessibilityLoginRedirectUrl: pulumi.String("string"),
})

    var basicAuthResource = new BasicAuth("basicAuthResource", BasicAuthArgs.builder()
    .authUrl("string")
    .url("string")
    .label("string")
    .autoSubmitToolbar(false)
    .appLinksJson("string")
    .adminNote("string")
    .accessibilityErrorRedirectUrl("string")
    .enduserNote("string")
    .hideIos(false)
    .hideWeb(false)
    .accessibilitySelfService(false)
    .logo("string")
    .status("string")
    .accessibilityLoginRedirectUrl("string")
    .build());

    basic_auth_resource = okta.app.BasicAuth("basicAuthResource",
    auth_url="string",
    url="string",
    label="string",
    auto_submit_toolbar=False,
    app_links_json="string",
    admin_note="string",
    accessibility_error_redirect_url="string",
    enduser_note="string",
    hide_ios=False,
    hide_web=False,
    accessibility_self_service=False,
    logo="string",
    status="string",
    accessibility_login_redirect_url="string")

    const basicAuthResource = new okta.app.BasicAuth("basicAuthResource", {
    authUrl: "string",
    url: "string",
    label: "string",
    autoSubmitToolbar: false,
    appLinksJson: "string",
    adminNote: "string",
    accessibilityErrorRedirectUrl: "string",
    enduserNote: "string",
    hideIos: false,
    hideWeb: false,
    accessibilitySelfService: false,
    logo: "string",
    status: "string",
    accessibilityLoginRedirectUrl: "string",
});

    type: okta:app:BasicAuth
properties:
    accessibilityErrorRedirectUrl: string
    accessibilityLoginRedirectUrl: string
    accessibilitySelfService: false
    adminNote: string
    appLinksJson: string
    authUrl: string
    autoSubmitToolbar: false
    enduserNote: string
    hideIos: false
    hideWeb: false
    label: string
    logo: string
    status: string
    url: string

    BasicAuth Resource Properties

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

    Inputs

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

    The BasicAuth resource accepts the following input properties:

    AuthUrl string
    The URL of the authenticating site for this app.
    Label string
    The Application's display name.
    Url string
    The URL of the sign-in page for this app.
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    Status string
    Status of application. By default, it is ACTIVE
    AuthUrl string
    The URL of the authenticating site for this app.
    Label string
    The Application's display name.
    Url string
    The URL of the sign-in page for this app.
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    Status string
    Status of application. By default, it is ACTIVE
    authUrl String
    The URL of the authenticating site for this app.
    label String
    The Application's display name.
    url String
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    status String
    Status of application. By default, it is ACTIVE
    authUrl string
    The URL of the authenticating site for this app.
    label string
    The Application's display name.
    url string
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl string
    Custom error page URL
    accessibilityLoginRedirectUrl string
    Custom login page URL
    accessibilitySelfService boolean
    Enable self service. Default is false
    adminNote string
    Application notes for admins.
    appLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar boolean
    Display auto submit toolbar
    enduserNote string
    Application notes for end users.
    hideIos boolean
    Do not display application icon on mobile app
    hideWeb boolean
    Do not display application icon to users
    logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    status string
    Status of application. By default, it is ACTIVE
    auth_url str
    The URL of the authenticating site for this app.
    label str
    The Application's display name.
    url str
    The URL of the sign-in page for this app.
    accessibility_error_redirect_url str
    Custom error page URL
    accessibility_login_redirect_url str
    Custom login page URL
    accessibility_self_service bool
    Enable self service. Default is false
    admin_note str
    Application notes for admins.
    app_links_json str
    Displays specific appLinks for the app. The value for each application link should be boolean.
    auto_submit_toolbar bool
    Display auto submit toolbar
    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.
    status str
    Status of application. By default, it is ACTIVE
    authUrl String
    The URL of the authenticating site for this app.
    label String
    The Application's display name.
    url String
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    status String
    Status of application. By default, it is ACTIVE

    Outputs

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

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

    Look up Existing BasicAuth Resource

    Get an existing BasicAuth 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?: BasicAuthState, opts?: CustomResourceOptions): BasicAuth
    @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,
        auth_url: Optional[str] = None,
        auto_submit_toolbar: Optional[bool] = 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,
        sign_on_mode: Optional[str] = None,
        status: Optional[str] = None,
        url: Optional[str] = None) -> BasicAuth
    func GetBasicAuth(ctx *Context, name string, id IDInput, state *BasicAuthState, opts ...ResourceOption) (*BasicAuth, error)
    public static BasicAuth Get(string name, Input<string> id, BasicAuthState? state, CustomResourceOptions? opts = null)
    public static BasicAuth get(String name, Output<String> id, BasicAuthState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AuthUrl string
    The URL of the authenticating site for this app.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Label string
    The Application's display name.
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    SignOnMode string
    Sign on mode of application.
    Status string
    Status of application. By default, it is ACTIVE
    Url string
    The URL of the sign-in page for this app.
    AccessibilityErrorRedirectUrl string
    Custom error page URL
    AccessibilityLoginRedirectUrl string
    Custom login page URL
    AccessibilitySelfService bool
    Enable self service. Default is false
    AdminNote string
    Application notes for admins.
    AppLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    AuthUrl string
    The URL of the authenticating site for this app.
    AutoSubmitToolbar bool
    Display auto submit toolbar
    EnduserNote string
    Application notes for end users.
    HideIos bool
    Do not display application icon on mobile app
    HideWeb bool
    Do not display application icon to users
    Label string
    The Application's display name.
    Logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    LogoUrl string
    URL of the application's logo
    Name string
    Name of the app.
    SignOnMode string
    Sign on mode of application.
    Status string
    Status of application. By default, it is ACTIVE
    Url string
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    authUrl String
    The URL of the authenticating site for this app.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    label String
    The Application's display name.
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    signOnMode String
    Sign on mode of application.
    status String
    Status of application. By default, it is ACTIVE
    url String
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl string
    Custom error page URL
    accessibilityLoginRedirectUrl string
    Custom login page URL
    accessibilitySelfService boolean
    Enable self service. Default is false
    adminNote string
    Application notes for admins.
    appLinksJson string
    Displays specific appLinks for the app. The value for each application link should be boolean.
    authUrl string
    The URL of the authenticating site for this app.
    autoSubmitToolbar boolean
    Display auto submit toolbar
    enduserNote string
    Application notes for end users.
    hideIos boolean
    Do not display application icon on mobile app
    hideWeb boolean
    Do not display application icon to users
    label string
    The Application's display name.
    logo string
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl string
    URL of the application's logo
    name string
    Name of the app.
    signOnMode string
    Sign on mode of application.
    status string
    Status of application. By default, it is ACTIVE
    url string
    The URL of the sign-in page for this app.
    accessibility_error_redirect_url str
    Custom error page URL
    accessibility_login_redirect_url str
    Custom login page URL
    accessibility_self_service bool
    Enable self service. Default is false
    admin_note str
    Application notes for admins.
    app_links_json str
    Displays specific appLinks for the app. The value for each application link should be boolean.
    auth_url str
    The URL of the authenticating site for this app.
    auto_submit_toolbar bool
    Display auto submit toolbar
    enduser_note str
    Application notes for end users.
    hide_ios bool
    Do not display application icon on mobile app
    hide_web bool
    Do not display application icon to users
    label str
    The Application's display name.
    logo str
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logo_url str
    URL of the application's logo
    name str
    Name of the app.
    sign_on_mode str
    Sign on mode of application.
    status str
    Status of application. By default, it is ACTIVE
    url str
    The URL of the sign-in page for this app.
    accessibilityErrorRedirectUrl String
    Custom error page URL
    accessibilityLoginRedirectUrl String
    Custom login page URL
    accessibilitySelfService Boolean
    Enable self service. Default is false
    adminNote String
    Application notes for admins.
    appLinksJson String
    Displays specific appLinks for the app. The value for each application link should be boolean.
    authUrl String
    The URL of the authenticating site for this app.
    autoSubmitToolbar Boolean
    Display auto submit toolbar
    enduserNote String
    Application notes for end users.
    hideIos Boolean
    Do not display application icon on mobile app
    hideWeb Boolean
    Do not display application icon to users
    label String
    The Application's display name.
    logo String
    Local file path to the logo. The file must be in PNG, JPG, or GIF format, and less than 1 MB in size.
    logoUrl String
    URL of the application's logo
    name String
    Name of the app.
    signOnMode String
    Sign on mode of application.
    status String
    Status of application. By default, it is ACTIVE
    url String
    The URL of the sign-in page for this app.

    Import

    $ pulumi import okta:app/basicAuth:BasicAuth 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.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta