Okta v4.4.0, Sep 18 23

Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

okta.app.getApp

Explore with Pulumi AI

Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Okta.App.GetApp.Invoke(new()
    {
        Label = "Example App",
    });

});

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.GetApp(ctx, &app.GetAppArgs{
			Label: pulumi.StringRef("Example App"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.AppFunctions;
import com.pulumi.okta.app.inputs.GetAppArgs;
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) {
        final var example = AppFunctions.getApp(GetAppArgs.builder()
            .label("Example App")
            .build());

    }
}

import pulumi
import pulumi_okta as okta

example = okta.app.get_app(label="Example App")

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

const example = okta.app.getApp({
    label: "Example App",
});

variables:
  example:
    fn::invoke:
      Function: okta:app:getApp
      Arguments:
        label: Example App

Using getApp

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>

def get_app(active_only: Optional[bool] = None,
            id: Optional[str] = None,
            label: Optional[str] = None,
            label_prefix: Optional[str] = None,
            skip_groups: Optional[bool] = None,
            skip_users: Optional[bool] = None,
            opts: Optional[InvokeOptions] = None) -> GetAppResult
def get_app_output(active_only: Optional[pulumi.Input[bool]] = None,
            id: Optional[pulumi.Input[str]] = None,
            label: Optional[pulumi.Input[str]] = None,
            label_prefix: Optional[pulumi.Input[str]] = None,
            skip_groups: Optional[pulumi.Input[bool]] = None,
            skip_users: Optional[pulumi.Input[bool]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]

func GetApp(ctx *Context, args *GetAppArgs, opts ...InvokeOption) (*GetAppResult, error)
func GetAppOutput(ctx *Context, args *GetAppOutputArgs, opts ...InvokeOption) GetAppResultOutput

> Note: This function is named GetApp in the Go SDK.

public static class GetApp 
{
    public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
    public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: okta:app/getApp:getApp
  arguments:
    # arguments dictionary

The following arguments are supported:

ActiveOnly bool

tells the provider to query for only ACTIVE applications.

Id string

id of application to retrieve, conflicts with label and label_prefix.

Label string

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time the API searches both name and label with a starts with query which may result in multiple apps being returned for the query. The data source further inspects the lables looking for an exact match.

LabelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

SkipGroups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

SkipUsers bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

ActiveOnly bool

tells the provider to query for only ACTIVE applications.

Id string

id of application to retrieve, conflicts with label and label_prefix.

Label string

LabelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

SkipGroups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

SkipUsers bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

activeOnly Boolean

tells the provider to query for only ACTIVE applications.

id String

id of application to retrieve, conflicts with label and label_prefix.

label String

labelPrefix String

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups Boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers Boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

activeOnly boolean

tells the provider to query for only ACTIVE applications.

id string

id of application to retrieve, conflicts with label and label_prefix.

label string

labelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

active_only bool

tells the provider to query for only ACTIVE applications.

id str

id of application to retrieve, conflicts with label and label_prefix.

label str

label_prefix str

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skip_groups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skip_users bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

activeOnly Boolean

tells the provider to query for only ACTIVE applications.

id String

id of application to retrieve, conflicts with label and label_prefix.

label String

labelPrefix String

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups Boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers Boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

getApp Result

The following output properties are available:

Groups List<string>

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

Links string

Generic JSON containing discoverable resources related to the app.

Name string

Application name.

Status string

Application status.

Users List<string>

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

ActiveOnly bool

Id string

Application ID.

Label string

Application label.

LabelPrefix string

SkipGroups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

SkipUsers bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

Groups []string

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

Links string

Generic JSON containing discoverable resources related to the app.

Name string

Application name.

Status string

Application status.

Users []string

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

ActiveOnly bool

Id string

Application ID.

Label string

Application label.

LabelPrefix string

SkipGroups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

SkipUsers bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

groups List<String>

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

links String

Generic JSON containing discoverable resources related to the app.

name String

Application name.

status String

Application status.

users List<String>

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

activeOnly Boolean

id String

Application ID.

label String

Application label.

labelPrefix String

skipGroups Boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers Boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

groups string[]

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

links string

Generic JSON containing discoverable resources related to the app.

name string

Application name.

status string

Application status.

users string[]

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

activeOnly boolean

id string

Application ID.

label string

Application label.

labelPrefix string

skipGroups boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

groups Sequence[str]

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

links str

Generic JSON containing discoverable resources related to the app.

name str

Application name.

status str

Application status.

users Sequence[str]

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

active_only bool

id str

Application ID.

label str

Application label.

label_prefix str

skip_groups bool

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skip_users bool

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

groups List<String>

Deprecated:

The groups field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_group_assignments

links String

Generic JSON containing discoverable resources related to the app.

name String

Application name.

status String

Application status.

users List<String>

Deprecated:

The users field is now deprecated for the data source okta_app, please replace all uses of this with: okta_app_user_assignments

activeOnly Boolean

id String

Application ID.

label String

Application label.

labelPrefix String

skipGroups Boolean

Deprecated:

Because groups has been removed, this attribute is a no op and will be removed

skipUsers Boolean

Deprecated:

Because users has been removed, this attribute is a no op and will be removed

Package Details

Repository: Okta pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

pulumi/pulumi-okta

okta.app.getApp

On this page

On this page

Example Usage

Using getApp

getApp Result

Package Details

On this page

On this page