okta.app.Bookmark
Explore with Pulumi AI
This resource allows you to create and configure a Bookmark 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.Bookmark("example", {
label: "Example",
url: "https://example.com",
});
import pulumi
import pulumi_okta as okta
example = okta.app.Bookmark("example",
label="Example",
url="https://example.com")
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.NewBookmark(ctx, "example", &app.BookmarkArgs{
Label: pulumi.String("Example"),
Url: pulumi.String("https://example.com"),
})
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.Bookmark("example", new()
{
Label = "Example",
Url = "https://example.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.Bookmark;
import com.pulumi.okta.app.BookmarkArgs;
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 Bookmark("example", BookmarkArgs.builder()
.label("Example")
.url("https://example.com")
.build());
}
}
resources:
example:
type: okta:app:Bookmark
properties:
label: Example
url: https://example.com
Create Bookmark Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Bookmark(name: string, args: BookmarkArgs, opts?: CustomResourceOptions);
@overload
def Bookmark(resource_name: str,
args: BookmarkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Bookmark(resource_name: str,
opts: Optional[ResourceOptions] = None,
label: Optional[str] = None,
url: Optional[str] = None,
auto_submit_toolbar: Optional[bool] = None,
admin_note: Optional[str] = None,
app_links_json: Optional[str] = None,
authentication_policy: 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,
request_integration: Optional[bool] = None,
status: Optional[str] = None,
accessibility_login_redirect_url: Optional[str] = None)
func NewBookmark(ctx *Context, name string, args BookmarkArgs, opts ...ResourceOption) (*Bookmark, error)
public Bookmark(string name, BookmarkArgs args, CustomResourceOptions? opts = null)
public Bookmark(String name, BookmarkArgs args)
public Bookmark(String name, BookmarkArgs args, CustomResourceOptions options)
type: okta:app:Bookmark
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 BookmarkArgs
- 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 BookmarkArgs
- 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 BookmarkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BookmarkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BookmarkArgs
- 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 bookmarkResource = new Okta.App.Bookmark("bookmarkResource", new()
{
Label = "string",
Url = "string",
AutoSubmitToolbar = false,
AdminNote = "string",
AppLinksJson = "string",
AuthenticationPolicy = "string",
AccessibilityErrorRedirectUrl = "string",
EnduserNote = "string",
HideIos = false,
HideWeb = false,
AccessibilitySelfService = false,
Logo = "string",
RequestIntegration = false,
Status = "string",
AccessibilityLoginRedirectUrl = "string",
});
example, err := app.NewBookmark(ctx, "bookmarkResource", &app.BookmarkArgs{
Label: pulumi.String("string"),
Url: pulumi.String("string"),
AutoSubmitToolbar: pulumi.Bool(false),
AdminNote: pulumi.String("string"),
AppLinksJson: pulumi.String("string"),
AuthenticationPolicy: 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"),
RequestIntegration: pulumi.Bool(false),
Status: pulumi.String("string"),
AccessibilityLoginRedirectUrl: pulumi.String("string"),
})
var bookmarkResource = new Bookmark("bookmarkResource", BookmarkArgs.builder()
.label("string")
.url("string")
.autoSubmitToolbar(false)
.adminNote("string")
.appLinksJson("string")
.authenticationPolicy("string")
.accessibilityErrorRedirectUrl("string")
.enduserNote("string")
.hideIos(false)
.hideWeb(false)
.accessibilitySelfService(false)
.logo("string")
.requestIntegration(false)
.status("string")
.accessibilityLoginRedirectUrl("string")
.build());
bookmark_resource = okta.app.Bookmark("bookmarkResource",
label="string",
url="string",
auto_submit_toolbar=False,
admin_note="string",
app_links_json="string",
authentication_policy="string",
accessibility_error_redirect_url="string",
enduser_note="string",
hide_ios=False,
hide_web=False,
accessibility_self_service=False,
logo="string",
request_integration=False,
status="string",
accessibility_login_redirect_url="string")
const bookmarkResource = new okta.app.Bookmark("bookmarkResource", {
label: "string",
url: "string",
autoSubmitToolbar: false,
adminNote: "string",
appLinksJson: "string",
authenticationPolicy: "string",
accessibilityErrorRedirectUrl: "string",
enduserNote: "string",
hideIos: false,
hideWeb: false,
accessibilitySelfService: false,
logo: "string",
requestIntegration: false,
status: "string",
accessibilityLoginRedirectUrl: "string",
});
type: okta:app:Bookmark
properties:
accessibilityErrorRedirectUrl: string
accessibilityLoginRedirectUrl: string
accessibilitySelfService: false
adminNote: string
appLinksJson: string
authenticationPolicy: string
autoSubmitToolbar: false
enduserNote: string
hideIos: false
hideWeb: false
label: string
logo: string
requestIntegration: false
status: string
url: string
Bookmark 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 Bookmark resource accepts the following input properties:
- Label string
- The Application's display name.
- Url string
- The URL of the bookmark.
- Accessibility
Error stringRedirect Url - Custom error page URL
- Accessibility
Login stringRedirect Url - Custom login page URL
- Accessibility
Self boolService - Enable self service. Default 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.
- Authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- Auto
Submit boolToolbar - Display auto submit toolbar
- 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.
- Request
Integration bool - Would you like Okta to add an integration for this app?
- Status string
- Status of application. By default, it is
ACTIVE
- Label string
- The Application's display name.
- Url string
- The URL of the bookmark.
- Accessibility
Error stringRedirect Url - Custom error page URL
- Accessibility
Login stringRedirect Url - Custom login page URL
- Accessibility
Self boolService - Enable self service. Default 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.
- Authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- Auto
Submit boolToolbar - Display auto submit toolbar
- 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.
- Request
Integration bool - Would you like Okta to add an integration for this app?
- Status string
- Status of application. By default, it is
ACTIVE
- label String
- The Application's display name.
- url String
- The URL of the bookmark.
- accessibility
Error StringRedirect Url - Custom error page URL
- accessibility
Login StringRedirect Url - Custom login page URL
- accessibility
Self BooleanService - Enable self service. Default 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.
- authentication
Policy String - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit BooleanToolbar - Display auto submit toolbar
- 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.
- request
Integration Boolean - Would you like Okta to add an integration for this app?
- status String
- Status of application. By default, it is
ACTIVE
- label string
- The Application's display name.
- url string
- The URL of the bookmark.
- accessibility
Error stringRedirect Url - Custom error page URL
- accessibility
Login stringRedirect Url - Custom login page URL
- accessibility
Self booleanService - Enable self service. Default 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.
- authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit booleanToolbar - Display auto submit toolbar
- 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.
- request
Integration boolean - Would you like Okta to add an integration for this app?
- status string
- Status of application. By default, it is
ACTIVE
- label str
- The Application's display name.
- url str
- The URL of the bookmark.
- accessibility_
error_ strredirect_ url - Custom error page URL
- accessibility_
login_ strredirect_ url - Custom login page URL
- accessibility_
self_ boolservice - Enable self service. Default 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.
- authentication_
policy str - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto_
submit_ booltoolbar - 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.
- request_
integration bool - Would you like Okta to add an integration for this app?
- status str
- Status of application. By default, it is
ACTIVE
- label String
- The Application's display name.
- url String
- The URL of the bookmark.
- accessibility
Error StringRedirect Url - Custom error page URL
- accessibility
Login StringRedirect Url - Custom login page URL
- accessibility
Self BooleanService - Enable self service. Default 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.
- authentication
Policy String - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit BooleanToolbar - Display auto submit toolbar
- 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.
- request
Integration Boolean - Would you like Okta to add an integration for this app?
- status String
- Status of application. By default, it is
ACTIVE
Outputs
All input properties are implicitly available as output properties. Additionally, the Bookmark resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Logo
Url string - URL of the application's logo
- Name string
- Name of the app.
- Sign
On stringMode - Sign on mode of application.
- Id string
- The provider-assigned unique ID for this managed resource.
- Logo
Url string - URL of the application's logo
- Name string
- Name of the app.
- Sign
On stringMode - Sign on mode of application.
- id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - URL of the application's logo
- name String
- Name of the app.
- sign
On StringMode - Sign on mode of application.
- id string
- The provider-assigned unique ID for this managed resource.
- logo
Url string - URL of the application's logo
- name string
- Name of the app.
- sign
On stringMode - 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_ strmode - Sign on mode of application.
- id String
- The provider-assigned unique ID for this managed resource.
- logo
Url String - URL of the application's logo
- name String
- Name of the app.
- sign
On StringMode - Sign on mode of application.
Look up Existing Bookmark Resource
Get an existing Bookmark 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?: BookmarkState, opts?: CustomResourceOptions): Bookmark
@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,
authentication_policy: 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,
request_integration: Optional[bool] = None,
sign_on_mode: Optional[str] = None,
status: Optional[str] = None,
url: Optional[str] = None) -> Bookmark
func GetBookmark(ctx *Context, name string, id IDInput, state *BookmarkState, opts ...ResourceOption) (*Bookmark, error)
public static Bookmark Get(string name, Input<string> id, BookmarkState? state, CustomResourceOptions? opts = null)
public static Bookmark get(String name, Output<String> id, BookmarkState 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 URL
- Accessibility
Self boolService - Enable self service. Default 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.
- Authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- Auto
Submit boolToolbar - Display auto submit toolbar
- 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 - URL of the application's logo
- Name string
- Name of the app.
- Request
Integration bool - Would you like Okta to add an integration for this app?
- Sign
On stringMode - Sign on mode of application.
- Status string
- Status of application. By default, it is
ACTIVE
- Url string
- The URL of the bookmark.
- Accessibility
Error stringRedirect Url - Custom error page URL
- Accessibility
Login stringRedirect Url - Custom login page URL
- Accessibility
Self boolService - Enable self service. Default 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.
- Authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- Auto
Submit boolToolbar - Display auto submit toolbar
- 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 - URL of the application's logo
- Name string
- Name of the app.
- Request
Integration bool - Would you like Okta to add an integration for this app?
- Sign
On stringMode - Sign on mode of application.
- Status string
- Status of application. By default, it is
ACTIVE
- Url string
- The URL of the bookmark.
- accessibility
Error StringRedirect Url - Custom error page URL
- accessibility
Login StringRedirect Url - Custom login page URL
- accessibility
Self BooleanService - Enable self service. Default 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.
- authentication
Policy String - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit BooleanToolbar - Display auto submit toolbar
- 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 - URL of the application's logo
- name String
- Name of the app.
- request
Integration Boolean - Would you like Okta to add an integration for this app?
- sign
On StringMode - Sign on mode of application.
- status String
- Status of application. By default, it is
ACTIVE
- url String
- The URL of the bookmark.
- accessibility
Error stringRedirect Url - Custom error page URL
- accessibility
Login stringRedirect Url - Custom login page URL
- accessibility
Self booleanService - Enable self service. Default 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.
- authentication
Policy string - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit booleanToolbar - Display auto submit toolbar
- 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 - URL of the application's logo
- name string
- Name of the app.
- request
Integration boolean - Would you like Okta to add an integration for this app?
- sign
On stringMode - Sign on mode of application.
- status string
- Status of application. By default, it is
ACTIVE
- url string
- The URL of the bookmark.
- accessibility_
error_ strredirect_ url - Custom error page URL
- accessibility_
login_ strredirect_ url - Custom login page URL
- accessibility_
self_ boolservice - Enable self service. Default 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.
- authentication_
policy str - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto_
submit_ booltoolbar - 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.
- request_
integration bool - Would you like Okta to add an integration for this app?
- sign_
on_ strmode - Sign on mode of application.
- status str
- Status of application. By default, it is
ACTIVE
- url str
- The URL of the bookmark.
- accessibility
Error StringRedirect Url - Custom error page URL
- accessibility
Login StringRedirect Url - Custom login page URL
- accessibility
Self BooleanService - Enable self service. Default 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.
- authentication
Policy String - The ID of the associated appsignonpolicy. If this property is removed from the application the default sign-on-policy will be associated with this application.
- auto
Submit BooleanToolbar - Display auto submit toolbar
- 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 - URL of the application's logo
- name String
- Name of the app.
- request
Integration Boolean - Would you like Okta to add an integration for this app?
- sign
On StringMode - Sign on mode of application.
- status String
- Status of application. By default, it is
ACTIVE
- url String
- The URL of the bookmark.
Import
$ pulumi import okta:app/bookmark:Bookmark 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.