1. Packages
  2. Okta
  3. API Docs
  4. app
  5. getApp
Okta v4.9.1 published on Monday, Jan 1, 0001 by Pulumi

okta.app.getApp

Explore with Pulumi AI

okta logo
Okta v4.9.1 published on Monday, Jan 1, 0001 by Pulumi

    Get an application of any kind from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.app.getApp({
        label: "Example App",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.app.get_app(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
    	})
    }
    
    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 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());
    
        }
    }
    
    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
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    ActiveOnly bool
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    activeOnly Boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    activeOnly boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    active_only bool
    Search only ACTIVE applications.
    id str
    Id of application to retrieve, conflicts with label and label_prefix.
    label str
    The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skip_users bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    activeOnly Boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    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>
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    Links string
    Discoverable resources related to the app
    Name string
    Name of application.
    Status string
    Status of application.
    Users List<string>
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    ActiveOnly bool
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    Groups []string
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    Links string
    Discoverable resources related to the app
    Name string
    Name of application.
    Status string
    Status of application.
    Users []string
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    ActiveOnly bool
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    SkipUsers bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    groups List<String>
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    links String
    Discoverable resources related to the app
    name String
    Name of application.
    status String
    Status of application.
    users List<String>
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    activeOnly Boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    groups string[]
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    links string
    Discoverable resources related to the app
    name string
    Name of application.
    status string
    Status of application.
    users string[]
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    activeOnly boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    groups Sequence[str]
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    links str
    Discoverable resources related to the app
    name str
    Name of application.
    status str
    Status of application.
    users Sequence[str]
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    active_only bool
    Search only ACTIVE applications.
    id str
    Id of application to retrieve, conflicts with label and label_prefix.
    label str
    The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skip_users bool
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

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

    groups List<String>
    Groups associated with the application

    Deprecated: The groups field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.AppGroupAssignments

    links String
    Discoverable resources related to the app
    name String
    Name of application.
    status String
    Status of application.
    users List<String>
    Users associated with the application

    Deprecated: The users field is now deprecated for the data source okta.app.getApp, please replace all uses of this with: okta.getAppUserAssignments

    activeOnly Boolean
    Search 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=\n\n query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications
    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
    Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources

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

    skipUsers Boolean
    Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources

    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 logo
    Okta v4.9.1 published on Monday, Jan 1, 0001 by Pulumi