Okta v4.13.1 published on Monday, Jan 27, 2025 by Pulumi
okta.getApps
Explore with Pulumi AI
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,
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,
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:
- Active
Only bool - Search only active applications.
- Include
Non boolDeleted - 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.
- Label
Prefix string - Searches for applications whose label or name property begins with this 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.
- Active
Only bool - Search only active applications.
- Include
Non boolDeleted - 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.
- Label
Prefix string - Searches for applications whose label or name property begins with this 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.
- active
Only Boolean - Search only active applications.
- include
Non BooleanDeleted - 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.
- label
Prefix String - Searches for applications whose label or name property begins with this value.
- use
Optimization 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 boolean - Search only active applications.
- include
Non booleanDeleted - 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.
- label
Prefix string - Searches for applications whose label or name property begins with this value.
- use
Optimization 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_ booldeleted - 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.
- 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.
- active
Only Boolean - Search only active applications.
- include
Non BooleanDeleted - 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.
- label
Prefix String - Searches for applications whose label or name property begins with this value.
- use
Optimization 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<Get
Apps App> - The list of applications that match the search criteria.
- Id string
- The provider-assigned unique ID for this managed resource.
- Active
Only bool - Search only active applications.
- Include
Non boolDeleted - 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.
- Label
Prefix string - Searches for applications whose label or name property begins with this 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
[]Get
Apps App - The list of applications that match the search criteria.
- Id string
- The provider-assigned unique ID for this managed resource.
- Active
Only bool - Search only active applications.
- Include
Non boolDeleted - 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.
- Label
Prefix string - Searches for applications whose label or name property begins with this 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<Get
Apps App> - The list of applications that match the search criteria.
- id String
- The provider-assigned unique ID for this managed resource.
- active
Only Boolean - Search only active applications.
- include
Non BooleanDeleted - 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.
- label
Prefix String - Searches for applications whose label or name property begins with this value.
- use
Optimization 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
Get
Apps App[] - The list of applications that match the search criteria.
- id string
- The provider-assigned unique ID for this managed resource.
- active
Only boolean - Search only active applications.
- include
Non booleanDeleted - 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.
- label
Prefix string - Searches for applications whose label or name property begins with this value.
- use
Optimization 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[Get
Apps App] - 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_ booldeleted - 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.
- 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.
- active
Only Boolean - Search only active applications.
- include
Non BooleanDeleted - 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.
- label
Prefix String - Searches for applications whose label or name property begins with this value.
- use
Optimization 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.
Supporting Types
GetAppsApp
- Admin
Note string - Created string
- Enduser
Note string - Features List<string>
- Id string
- Label string
- Last
Updated string - Name string
- Sign
On stringMode - Status string
- Visibility
Get
Apps App Visibility
- Admin
Note string - Created string
- Enduser
Note string - Features []string
- Id string
- Label string
- Last
Updated string - Name string
- Sign
On stringMode - Status string
- Visibility
Get
Apps App Visibility
- admin
Note String - created String
- enduser
Note String - features List<String>
- id String
- label String
- last
Updated String - name String
- sign
On StringMode - status String
- visibility
Get
Apps App Visibility
- admin
Note string - created string
- enduser
Note string - features string[]
- id string
- label string
- last
Updated string - name string
- sign
On stringMode - status string
- visibility
Get
Apps App Visibility
- admin_
note str - created str
- enduser_
note str - features Sequence[str]
- id str
- label str
- last_
updated str - name str
- sign_
on_ strmode - status str
- visibility
Get
Apps App Visibility
- admin
Note String - created String
- enduser
Note String - features List<String>
- id String
- label String
- last
Updated String - name String
- sign
On StringMode - status String
- visibility Property Map
GetAppsAppVisibility
- auto
Launch Boolean - auto
Submit BooleanToolbar - hide
Get
Apps App Visibility Hide
- auto
Launch boolean - auto
Submit booleanToolbar - hide
Get
Apps App Visibility Hide
- auto
Launch Boolean - auto
Submit BooleanToolbar - hide Property Map
GetAppsAppVisibilityHide
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
okta
Terraform Provider.