getApps

Okta v6.1.0, Oct 29 25

Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Using getApps

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 getApps(args: GetAppsArgs, opts?: InvokeOptions): Promise<GetAppsResult>
function getAppsOutput(args: GetAppsOutputArgs, opts?: InvokeOptions): Output<GetAppsResult>

def get_apps(active_only: Optional[bool] = None,
             include_non_deleted: Optional[bool] = None,
             label: Optional[str] = None,
             label_prefix: Optional[str] = None,
             q: Optional[str] = None,
             use_optimization: Optional[bool] = None,
             opts: Optional[InvokeOptions] = None) -> GetAppsResult
def get_apps_output(active_only: Optional[pulumi.Input[bool]] = None,
             include_non_deleted: Optional[pulumi.Input[bool]] = None,
             label: Optional[pulumi.Input[str]] = None,
             label_prefix: Optional[pulumi.Input[str]] = None,
             q: Optional[pulumi.Input[str]] = None,
             use_optimization: Optional[pulumi.Input[bool]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetAppsResult]

func GetApps(ctx *Context, args *GetAppsArgs, opts ...InvokeOption) (*GetAppsResult, error)
func GetAppsOutput(ctx *Context, args *GetAppsOutputArgs, opts ...InvokeOption) GetAppsResultOutput

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

public static class GetApps 
{
    public static Task<GetAppsResult> InvokeAsync(GetAppsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppsResult> Invoke(GetAppsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppsResult> getApps(GetAppsArgs args, InvokeOptions options)
public static Output<GetAppsResult> getApps(GetAppsArgs args, InvokeOptions options)

fn::invoke:
  function: okta:index/getApps:getApps
  arguments:
    # arguments dictionary

The following arguments are supported:

ActiveOnly bool: Search only active applications.
IncludeNonDeleted bool: Specifies whether to include non-active, but not deleted apps in the results.
Label string: Searches for applications whose label or name property matches this value exactly.
LabelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
Q string: Searches for apps with name or label properties that starts with the q value.
UseOptimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

ActiveOnly bool: Search only active applications.
IncludeNonDeleted bool: Specifies whether to include non-active, but not deleted apps in the results.
Label string: Searches for applications whose label or name property matches this value exactly.
LabelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
Q string: Searches for apps with name or label properties that starts with the q value.
UseOptimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

activeOnly Boolean: Search only active applications.
includeNonDeleted Boolean: Specifies whether to include non-active, but not deleted apps in the results.
label String: Searches for applications whose label or name property matches this value exactly.
labelPrefix String: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q String: Searches for apps with name or label properties that starts with the q value.
useOptimization Boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

activeOnly boolean: Search only active applications.
includeNonDeleted boolean: Specifies whether to include non-active, but not deleted apps in the results.
label string: Searches for applications whose label or name property matches this value exactly.
labelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q string: Searches for apps with name or label properties that starts with the q value.
useOptimization boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

active_only bool: Search only active applications.
include_non_deleted bool: Specifies whether to include non-active, but not deleted apps in the results.
label str: Searches for applications whose label or name property matches this value exactly.
label_prefix str: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q str: Searches for apps with name or label properties that starts with the q value.
use_optimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

activeOnly Boolean: Search only active applications.
includeNonDeleted Boolean: Specifies whether to include non-active, but not deleted apps in the results.
label String: Searches for applications whose label or name property matches this value exactly.
labelPrefix String: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q String: Searches for apps with name or label properties that starts with the q value.
useOptimization Boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

getApps Result

The following output properties are available:

Apps List<GetAppsApp>: The list of applications that match the search criteria.
Id string: The provider-assigned unique ID for this managed resource.
ActiveOnly bool: Search only active applications.
IncludeNonDeleted bool: Specifies whether to include non-active, but not deleted apps in the results.
Label string: Searches for applications whose label or name property matches this value exactly.
LabelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
Q string: Searches for apps with name or label properties that starts with the q value.
UseOptimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

Apps []GetAppsApp: The list of applications that match the search criteria.
Id string: The provider-assigned unique ID for this managed resource.
ActiveOnly bool: Search only active applications.
IncludeNonDeleted bool: Specifies whether to include non-active, but not deleted apps in the results.
Label string: Searches for applications whose label or name property matches this value exactly.
LabelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
Q string: Searches for apps with name or label properties that starts with the q value.
UseOptimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

apps List<GetAppsApp>: The list of applications that match the search criteria.
id String: The provider-assigned unique ID for this managed resource.
activeOnly Boolean: Search only active applications.
includeNonDeleted Boolean: Specifies whether to include non-active, but not deleted apps in the results.
label String: Searches for applications whose label or name property matches this value exactly.
labelPrefix String: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q String: Searches for apps with name or label properties that starts with the q value.
useOptimization Boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

apps GetAppsApp[]: The list of applications that match the search criteria.
id string: The provider-assigned unique ID for this managed resource.
activeOnly boolean: Search only active applications.
includeNonDeleted boolean: Specifies whether to include non-active, but not deleted apps in the results.
label string: Searches for applications whose label or name property matches this value exactly.
labelPrefix string: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q string: Searches for apps with name or label properties that starts with the q value.
useOptimization boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

apps Sequence[GetAppsApp]: The list of applications that match the search criteria.
id str: The provider-assigned unique ID for this managed resource.
active_only bool: Search only active applications.
include_non_deleted bool: Specifies whether to include non-active, but not deleted apps in the results.
label str: Searches for applications whose label or name property matches this value exactly.
label_prefix str: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q str: Searches for apps with name or label properties that starts with the q value.
use_optimization bool: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

apps List<Property Map>: The list of applications that match the search criteria.
id String: The provider-assigned unique ID for this managed resource.
activeOnly Boolean: Search only active applications.
includeNonDeleted Boolean: Specifies whether to include non-active, but not deleted apps in the results.
label String: Searches for applications whose label or name property matches this value exactly.
labelPrefix String: Searches for applications whose label or name property begins with this value. Warning: This might not work as intended and will be removed in the future release. Use q instead.
Deprecated: Use q instead. This attribute will be removed in a future version.
q String: Searches for apps with name or label properties that starts with the q value.
useOptimization Boolean: Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.