Get-OktaApp

NAME Get-OktaApp



SYNOPSIS

Gets one or more Okta apps.





SYNTAX

Get-OktaApp -All [<CommonParameters>]



Get-OktaApp -Filter <String> [<CommonParameters>]



Get-OktaApp -Group <Group> [<CommonParameters>]



Get-OktaApp [-Identity] <String> [<CommonParameters>]



Get-OktaApp -User <User> [<CommonParameters>]





DESCRIPTION

The Get-OktaApp cmdlet returns one or more Okta applications, either specified by Id or by supplying a filter

string.





PARAMETERS

-All [<SwitchParameter>]

If specified, will return all apps from the Okta org.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Filter <String>

The -Filter parameter can be used to return a subset of apps that match the filter string. Only a subset of

properties are supported for filtering:



status user.id group.id credentials.signing.kid



Refer to Okta's API documentation to learn more about creating a filter string.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Group <Group>

Specifies an Okta group and will retrieve the apps assigned to that group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Identity <String>

The Id of the application to be returned.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-User <User>

Specifies an Okta user and will retrieve the apps assigned to that user.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Okta.Sdk.User





Okta.Sdk.Group







OUTPUTS

Okta.Sdk.Application







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-OktaApp -Id "0oam0ns76yDLwm7t60h7"



This examples retrieves an Okta application by its Id.

-------------------------- Example 2 --------------------------



PS C:\\> Get-OktaApp -All



This example retrieves all Okta apps from connected org.

-------------------------- Example 3 --------------------------



PS C:\\> Get-OktaApp -Filter 'status eq "ACTIVE"'



This example demonstrates using the filter parameter to retrieve applications that are active.

-------------------------- Example 4 --------------------------



PS C:\\> Get-OktaUser -Identity matt | Get-OktaApp



This example shows how you can retrieve apps that are assigned to the user "matt" using the pipeline.

-------------------------- Example 5 --------------------------



PS C:\\> Get-OktaGroup -Identity "00g1emaKYZTWRYYRRTSK" | Get-OktaApp



This example shows how you can retrieve apps that are assigned to a group using the pipeline.



RELATED LINKS

Apps https://developer.okta.com/docs/reference/api/apps