en-US/Okta.PS.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-Okta</command:name> <command:verb>Connect</command:verb> <command:noun>Okta</command:noun> <maml:description> <maml:para>Create a connection to your Okta org.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a persistent connection to your Okta org. This connection will persist as long as your PowerShell is open or until you remove or re-import the Okta module, or until you run the Disconnect-Okta command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-Okta</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>OktaDomain</maml:name> <maml:Description> <maml:para>The full URL of your Okta org. This must use the "https://" prefix.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiToken</maml:name> <maml:Description> <maml:para>Your Okta API token. This token can be generated in the Okta admin console, and should be protected as a privileged credential. Be aware that API permissions for the token are the same as the permissions for the user who created the token.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiToken</maml:name> <maml:Description> <maml:para>Your Okta API token. This token can be generated in the Okta admin console, and should be protected as a privileged credential. Be aware that API permissions for the token are the same as the permissions for the user who created the token.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>OktaDomain</maml:name> <maml:Description> <maml:para>The full URL of your Okta org. This must use the "https://" prefix.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Configuration.OktaClientConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Connect-Okta -OktaDomain https://myorg.okta.com -ApiToken "00wc414Z6FMkJyLnXTPfQTl3JpeiFniYa8j4avjVPe"</dev:code> <dev:remarks> <maml:para>This example demonstrates connecting to an Okta org "MyOrg."</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>API Tokens</maml:linkText> <maml:uri>https://developer.okta.com/docs/guides/create-an-api-token/overview/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-Okta</command:name> <command:verb>Disconnect</command:verb> <command:noun>Okta</command:noun> <maml:description> <maml:para>Remove a connection to an Okta org.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an existing connection to an Okta org. Use this command to make sure your API token is removed from memory in your current PowerShell session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Okta</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Disconnect-Okta</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaApp</command:name> <command:verb>Get</command:verb> <command:noun>OktaApp</command:noun> <maml:description> <maml:para>Gets one or more Okta apps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OktaApp cmdlet returns one or more Okta applications, either specified by Id or by supplying a filter string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all apps from the Okta org.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>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:</maml:para> <maml:para>status user.id group.id credentials.signing.kid</maml:para> <maml:para>Refer to Okta's API documentation to learn more about creating a filter string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Specifies an Okta group and will retrieve the apps assigned to that group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Id of the application to be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies an Okta user and will retrieve the apps assigned to that user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all apps from the Okta org.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>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:</maml:para> <maml:para>status user.id group.id credentials.signing.kid</maml:para> <maml:para>Refer to Okta's API documentation to learn more about creating a filter string.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Specifies an Okta group and will retrieve the apps assigned to that group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Id of the application to be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies an Okta user and will retrieve the apps assigned to that user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Okta.Sdk.Group</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Application</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Id "0oam0ns76yDLwm7t60h7"</dev:code> <dev:remarks> <maml:para>This examples retrieves an Okta application by its Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -All</dev:code> <dev:remarks> <maml:para>This example retrieves all Okta apps from connected org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Filter 'status eq "ACTIVE"'</dev:code> <dev:remarks> <maml:para>This example demonstrates using the filter parameter to retrieve applications that are active.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity matt | Get-OktaApp</dev:code> <dev:remarks> <maml:para>This example shows how you can retrieve apps that are assigned to the user "matt" using the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaGroup -Identity "00g1emaKYZTWRYYRRTSK" | Get-OktaApp</dev:code> <dev:remarks> <maml:para>This example shows how you can retrieve apps that are assigned to a group using the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Apps</maml:linkText> <maml:uri>https://developer.okta.com/docs/reference/api/apps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaAppGroupAssignment</command:name> <command:verb>Get</command:verb> <command:noun>OktaAppGroupAssignment</command:noun> <maml:description> <maml:para>Gets group assignments for an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a group assignment object for an app. This object can be used to retrieve the group objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaAppGroupAssignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>The app to return group assignments for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>The app to return group assignments for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.Application</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.ApplicationGroupAssignment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Identity "0oam0ns76yDLwm7t60h7" | Get-OktaAppGroupAssignment</dev:code> <dev:remarks> <maml:para>Get the group assignments for an app.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaConnection</command:name> <command:verb>Get</command:verb> <command:noun>OktaConnection</command:noun> <maml:description> <maml:para>Gets details of the current Okta connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the current Okta connection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaConnection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Configuration.OktaClientConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaConnection</dev:code> <dev:remarks> <maml:para>Get the Okta connection details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaFactor</command:name> <command:verb>Get</command:verb> <command:noun>OktaFactor</command:noun> <maml:description> <maml:para>Gets all of a user's enrolled factors.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all of a user's enrolled factors.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaFactor</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Okta user to return factors for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Okta user to return factors for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Factor</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity "matt" | Get-OktaFactor</dev:code> <dev:remarks> <maml:para>Get the factors a user has enrolled.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Factors</maml:linkText> <maml:uri>https://developer.okta.com/docs/reference/api/factors</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaGroup</command:name> <command:verb>Get</command:verb> <command:noun>OktaGroup</command:noun> <maml:description> <maml:para>Gets one or more Okta groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or more Okta groups by specifying the group Id, or searches based on a filter string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Will return all groups in the Okta org.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Specifies a filter string to return a subset of groups.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies the Id of the group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies a user to return group membership for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>Specifies an Okta app, and will return all groups assigned to that app.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>Will return all groups in the Okta org.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Specifies a filter string to return a subset of groups.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies the Id of the group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies a user to return group membership for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>Specifies an Okta app, and will return all groups assigned to that app.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Group</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaGroup -Identity "00gb3syzldEpE5JNj0h7"</dev:code> <dev:remarks> <maml:para>Get a single group by its Id property.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaGroup -All</dev:code> <dev:remarks> <maml:para>Get all the groups in your Okta org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaGroup -Filter 'type eq "OKTA_GROUP"'</dev:code> <dev:remarks> <maml:para>Get any groups of type OKTA_GROUP by specifying a filter string.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity "matt" | Get-OktaGroup</dev:code> <dev:remarks> <maml:para>Get groups with user matt as a member.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Identity "00hh2hjrlgEpE5JNj8h9" | Get-OktaGroup</dev:code> <dev:remarks> <maml:para>Get groups assigned to a particular application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Groups</maml:linkText> <maml:uri>https://developer.okta.com/docs/reference/api/groups</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaLogEvent</command:name> <command:verb>Get</command:verb> <command:noun>OktaLogEvent</command:noun> <maml:description> <maml:para>Gets one or more Okta system log events entries.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or more Okta system log events entries. These events can be filtered by type, by target objects and by using date/time ranges.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaLogEvent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all events in the given time range.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>The end of the time range you'd like to retrieve events for. If not specified, the default value is now. -EndDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>The beginning date of the time range you'd like retrieve events for. If -StartDate isn't specified, the default value is 7 days prior to the current date and time. -StartDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaLogEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>The end of the time range you'd like to retrieve events for. If not specified, the default value is now. -EndDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Specifies a filter string to perform an event log search. Most properties of events are supported for filtering, including nested properties. See the Okta API System Log document link to learn more about how to compose these filter strings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>The beginning date of the time range you'd like retrieve events for. If -StartDate isn't specified, the default value is 7 days prior to the current date and time. -StartDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaLogEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>The end of the time range you'd like to retrieve events for. If not specified, the default value is now. -EndDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Keywords</maml:name> <maml:Description> <maml:para>Specifies keywords to perform an exact match search for log events. These keywords should be specified as a single string and separated by spaces. A total of 10 keywords is supported, each with a maximum length of 40 characters. Keywords are not case-sensitive. See the System Log API reference page to learn more about keyword searches for log events.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>The beginning date of the time range you'd like retrieve events for. If -StartDate isn't specified, the default value is 7 days prior to the current date and time. -StartDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaLogEvent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>The end of the time range you'd like to retrieve events for. If not specified, the default value is now. -EndDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>The beginning date of the time range you'd like retrieve events for. If -StartDate isn't specified, the default value is 7 days prior to the current date and time. -StartDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Id"> <maml:name>TargetId</maml:name> <maml:Description> <maml:para>The Id of the Okta object to retrieve events for. This can be nearly any Okta object type such as a user, group or app. -TargetId accepts input via the pipeline, so go ahead and pipe in a user or group object and see what happens!</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all events in the given time range.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:Description> <maml:para>The end of the time range you'd like to retrieve events for. If not specified, the default value is now. -EndDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Specifies a filter string to perform an event log search. Most properties of events are supported for filtering, including nested properties. See the Okta API System Log document link to learn more about how to compose these filter strings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Keywords</maml:name> <maml:Description> <maml:para>Specifies keywords to perform an exact match search for log events. These keywords should be specified as a single string and separated by spaces. A total of 10 keywords is supported, each with a maximum length of 40 characters. Keywords are not case-sensitive. See the System Log API reference page to learn more about keyword searches for log events.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para>The beginning date of the time range you'd like retrieve events for. If -StartDate isn't specified, the default value is 7 days prior to the current date and time. -StartDate can always be used to limit the time range of events returned, regardless of the parameter set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Id"> <maml:name>TargetId</maml:name> <maml:Description> <maml:para>The Id of the Okta object to retrieve events for. This can be nearly any Okta object type such as a user, group or app. -TargetId accepts input via the pipeline, so go ahead and pipe in a user or group object and see what happens!</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.LogEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaLogEvent -Filter 'eventType eq "user.session.start"'</dev:code> <dev:remarks> <maml:para>Get events by event type.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity "matt" | Get-OktaLogEvent</dev:code> <dev:remarks> <maml:para>Get events for a specified user. This command is equivalent to clicking on the system log link from a user's page in the Okta admin console.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Identity "0oa1gjh63g214q0Hq0g4" | Get-OktaLogEvent</dev:code> <dev:remarks> <maml:para>Get events for a specified app. This will return any events where the app was the target of the operation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaGroup -Identity "0oa1gjh63g214q0Hq0g4" | Get-OktaLogEvent</dev:code> <dev:remarks> <maml:para>Get events for a specified group. This will return any events where the group was the target of the operation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaLogEvent -All -StartDate 1/1/2019 -EndDate 2/1/2019</dev:code> <dev:remarks> <maml:para>Get all events in a specified time range.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>System Log</maml:linkText> <maml:uri>https://developer.okta.com/docs/reference/api/system-log</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaPolicy</command:name> <command:verb>Get</command:verb> <command:noun>OktaPolicy</command:noun> <maml:description> <maml:para>Gets Okta sign on and password policies.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Okta sign on and password policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Id of the policy to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of policies you'd like to retrieve. Can be either Password or OktaSignOn.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Id of the policy to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of policies you'd like to retrieve. Can be either Password or OktaSignOn.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Policy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaPolicy -Identity "00pmw1mgtiHPRsYJH0h7"</dev:code> <dev:remarks> <maml:para>Get a policy by its Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaPolicy -Type OktaSignOn</dev:code> <dev:remarks> <maml:para>Get all policies of type OktaSignOn.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaPolicy -Type Password</dev:code> <dev:remarks> <maml:para>Get all policies of type Password.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaPolicyRule</command:name> <command:verb>Get</command:verb> <command:noun>OktaPolicyRule</command:noun> <maml:description> <maml:para>Gets one or more Okta policy rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or more Okta policy rules. Accepts a policy If via the pipeline and a rule Id can also be supplied to retrieve only a particular rule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaPolicyRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PolicyId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Id of the policy to retrieve rules for. This can be specified as a string, or by passing one or more policy objects via the pipeline.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleId</maml:name> <maml:Description> <maml:para>The Id of the rule you'd like to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PolicyId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The Id of the policy to retrieve rules for. This can be specified as a string, or by passing one or more policy objects via the pipeline.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RuleId</maml:name> <maml:Description> <maml:para>The Id of the rule you'd like to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.PolicyRule</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaPolicy -Identity "00pmw1mgtiHPRsYJH0h7" | Get-OktaPolicyRule</dev:code> <dev:remarks> <maml:para>Get all rules for a policy.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaPolicy -Identity "00pmw1mgtiHPRsYJH0h7" | Get-OktaPolicyRule -RuleId "0prmw1on9kK5Yr6aW0h7"</dev:code> <dev:remarks> <maml:para>Get a specific policy rule.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaUser</command:name> <command:verb>Get</command:verb> <command:noun>OktaUser</command:noun> <maml:description> <maml:para>Gets one or more Okta users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all users in the Okta org.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>If specified, will return all users assigned to the app.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>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:</maml:para> <maml:para>status lastUpdated id profile.login profile.firstName</maml:para> <maml:para>To learn more about user filters, see the API User document link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Specifies an Okta group for which you'd like to return the members.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-OktaUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:Description> <maml:para>If specified, will return all users in the Okta org.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>App</maml:name> <maml:Description> <maml:para>If specified, will return all users assigned to the app.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Application</command:parameterValue> <dev:type> <maml:name>Application</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>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:</maml:para> <maml:para>status lastUpdated id profile.login profile.firstName</maml:para> <maml:para>To learn more about user filters, see the API User document link.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:Description> <maml:para>Specifies an Okta group for which you'd like to return the members.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Group</command:parameterValue> <dev:type> <maml:name>Group</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.Group</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Okta.Sdk.Application</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity "matt"</dev:code> <dev:remarks> <maml:para>Get a single Okta user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Filter 'status eq "ACTIVE"'</dev:code> <dev:remarks> <maml:para>Get any active users by specifying a filter string.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -All</dev:code> <dev:remarks> <maml:para>Get all users in the current Okta org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Identity "0oam0ns76yDLwm7t60h7" | Get-OktaUser</dev:code> <dev:remarks> <maml:para>Get all users assigned to a particular app.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaApp -Identity "00gb3syzldEpE5JNj0h7" | Get-OktaUser</dev:code> <dev:remarks> <maml:para>Get all users that are members of a particular group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Users</maml:linkText> <maml:uri>https://developer.okta.com/docs/reference/api/users</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-OktaUserAdminRole</command:name> <command:verb>Get</command:verb> <command:noun>OktaUserAdminRole</command:noun> <maml:description> <maml:para>Returns the administrative roles assigned to an Okta user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the administrative roles assigned to an Okta user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OktaUserAdminRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Okta user to retrieve administrative roles for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Okta user to retrieve administrative roles for.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Okta.Sdk.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Okta.Sdk.Role</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-OktaUser -Identity matt | Get-OktaUserAdminRole</dev:code> <dev:remarks> <maml:para>Get the administrative roles assigned to the user "matt."</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |