< Back
Get-OktaUser
Post
NAME Get-OktaUser
SYNOPSIS
Gets one or more Okta users.
SYNTAX
Get-OktaUser -All [<CommonParameters>]
Get-OktaUser -App <Application> [<CommonParameters>]
Get-OktaUser -Filter <String> [<CommonParameters>]
Get-OktaUser -Group <Group> [<CommonParameters>]
Get-OktaUser [-Identity] <String> [<CommonParameters>]
DESCRIPTION
Gets one or more Okta users. Users can be specified by Id, searched for using a filter, or enumerated by app
assignment or group membership.
PARAMETERS
-All [<SwitchParameter>]
If specified, will return all users in the Okta org.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-App <Application>
If specified, will return all users assigned to the app.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Filter <String>
Specifies a filter string to perform a search of users with. Any users that match the conditions of the filter
string will be returned. Many user properties are supported for filtering such as:
status lastUpdated id profile.login profile.firstName
To learn more about user filters, see the API User document link.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Group <Group>
Specifies an Okta group for which you'd like to return the members.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Identity <String>
The unique identifier of the user to retrieve. This can be the Id or Login value, or can be the login
shortname if its unambiguous. To retrieve the currently connected user, use "me" instead of an Id.
Required? true
Position? 0
Default value None
Accept pipeline input? False
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.Group
Okta.Sdk.Application
OUTPUTS
Okta.Sdk.User
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-OktaUser -Identity "matt"
Get a single Okta user.
-------------------------- Example 2 --------------------------
PS C:\\> Get-OktaUser -Filter 'status eq "ACTIVE"'
Get any active users by specifying a filter string.
-------------------------- Example 3 --------------------------
PS C:\\> Get-OktaUser -All
Get all users in the current Okta org.
-------------------------- Example 4 --------------------------
PS C:\\> Get-OktaApp -Identity "0oam0ns76yDLwm7t60h7" | Get-OktaUser
Get all users assigned to a particular app.
-------------------------- Example 4 --------------------------
PS C:\\> Get-OktaApp -Identity "00gb3syzldEpE5JNj0h7" | Get-OktaUser
Get all users that are members of a particular group.
RELATED LINKS
Users https://developer.okta.com/docs/reference/api/users
SYNOPSIS
Gets one or more Okta users.
SYNTAX
Get-OktaUser -All [<CommonParameters>]
Get-OktaUser -App <Application> [<CommonParameters>]
Get-OktaUser -Filter <String> [<CommonParameters>]
Get-OktaUser -Group <Group> [<CommonParameters>]
Get-OktaUser [-Identity] <String> [<CommonParameters>]
DESCRIPTION
Gets one or more Okta users. Users can be specified by Id, searched for using a filter, or enumerated by app
assignment or group membership.
PARAMETERS
-All [<SwitchParameter>]
If specified, will return all users in the Okta org.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-App <Application>
If specified, will return all users assigned to the app.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Filter <String>
Specifies a filter string to perform a search of users with. Any users that match the conditions of the filter
string will be returned. Many user properties are supported for filtering such as:
status lastUpdated id profile.login profile.firstName
To learn more about user filters, see the API User document link.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Group <Group>
Specifies an Okta group for which you'd like to return the members.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Identity <String>
The unique identifier of the user to retrieve. This can be the Id or Login value, or can be the login
shortname if its unambiguous. To retrieve the currently connected user, use "me" instead of an Id.
Required? true
Position? 0
Default value None
Accept pipeline input? False
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.Group
Okta.Sdk.Application
OUTPUTS
Okta.Sdk.User
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-OktaUser -Identity "matt"
Get a single Okta user.
-------------------------- Example 2 --------------------------
PS C:\\> Get-OktaUser -Filter 'status eq "ACTIVE"'
Get any active users by specifying a filter string.
-------------------------- Example 3 --------------------------
PS C:\\> Get-OktaUser -All
Get all users in the current Okta org.
-------------------------- Example 4 --------------------------
PS C:\\> Get-OktaApp -Identity "0oam0ns76yDLwm7t60h7" | Get-OktaUser
Get all users assigned to a particular app.
-------------------------- Example 4 --------------------------
PS C:\\> Get-OktaApp -Identity "00gb3syzldEpE5JNj0h7" | Get-OktaUser
Get all users that are members of a particular group.
RELATED LINKS
Users https://developer.okta.com/docs/reference/api/users