IdentityCommand.UserPortal

0.2.0

en-US/IdentityCommand.UserPortal-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>Get-UPAsset</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UPAsset</command:noun>
      <maml:description>
        <maml:para>Lists the assets available to you in the Access space</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Lists all assets available to the authenticated user across the sources the Access space aggregates - infrastructure targets and Identity applications.</maml:para>
      <maml:para>When the service cannot reach every source it returns the assets it did find and reports a partial success, which this command surfaces as a warning so a short list is not mistaken for a complete one.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UPAsset</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
          <maml:name>accessMethod</maml:name>
          <maml:description>
            <maml:para>Return only infrastructure assets using the specified access method - `vaulted` for vaulted credentials, `zsp` for zero standing privileges.</maml:para>
          </maml:description>
          <command:parameterValueGroup>
            <command:parameterValue required="false" command:variableLength="false">vaulted</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">zsp</command:parameterValue>
          </command:parameterValueGroup>
          <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="True (ByPropertyName)" position="1" aliases="none">
          <maml:name>limit</maml:name>
          <maml:description>
            <maml:para>The maximum number of assets to return, between 1 and 1000. The service returns 1000 when not specified.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
          <dev:type>
            <maml:name>Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
          <maml:name>search</maml:name>
          <maml:description>
            <maml:para>Search assets with the contains operator, against the `address`, `platformId` or `username` field, for example `address contains 1.2.3.4`.</maml:para>
            <maml:para>The reserved field name `all` applies the search across every supported field, for example `all contains somevalue`.</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="True (ByPropertyName)" position="3" aliases="none">
          <maml:name>sort</maml:name>
          <maml:description>
            <maml:para>Sort the results by `address`, `platformId` or `username`, ascending or descending, for example `address.asc` or `username.desc`. The service sorts ascending when no direction is given.</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="True (ByPropertyName)" position="named" aliases="none">
          <maml:name>favoritesOnly</maml:name>
          <maml:description>
            <maml:para>Return only the assets marked as favourites.</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="True (ByPropertyName)" position="named" aliases="none">
          <maml:name>recentsOnly</maml:name>
          <maml:description>
            <maml:para>Return only recently used assets.</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:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none">
        <maml:name>accessMethod</maml:name>
        <maml:description>
          <maml:para>Return only infrastructure assets using the specified access method - `vaulted` for vaulted credentials, `zsp` for zero standing privileges.</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="True (ByPropertyName)" position="named" aliases="none">
        <maml:name>favoritesOnly</maml:name>
        <maml:description>
          <maml:para>Return only the assets marked as favourites.</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="True (ByPropertyName)" position="named" aliases="none">
        <maml:name>recentsOnly</maml:name>
        <maml:description>
          <maml:para>Return only recently used assets.</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="True (ByPropertyName)" position="1" aliases="none">
        <maml:name>limit</maml:name>
        <maml:description>
          <maml:para>The maximum number of assets to return, between 1 and 1000. The service returns 1000 when not specified.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
        <dev:type>
          <maml:name>Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">
        <maml:name>search</maml:name>
        <maml:description>
          <maml:para>Search assets with the contains operator, against the `address`, `platformId` or `username` field, for example `address contains 1.2.3.4`.</maml:para>
          <maml:para>The reserved field name `all` applies the search across every supported field, for example `all contains somevalue`.</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="True (ByPropertyName)" position="3" aliases="none">
        <maml:name>sort</maml:name>
        <maml:description>
          <maml:para>Sort the results by `address`, `platformId` or `username`, ascending or descending, for example `address.asc` or `username.desc`. The service sorts ascending when no direction is given.</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: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>Get-UPAsset</dev:code>
        <dev:remarks>
          <maml:para>Lists all assets available to you</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>Get-UPAsset -favoritesOnly</dev:code>
        <dev:remarks>
          <maml:para>Lists only the assets you have marked as favourites</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>Get-UPAsset -accessMethod zsp -search 'address contains 10.0.0'</dev:code>
        <dev:remarks>
          <maml:para>Lists assets accessed with zero standing privileges whose address contains 10.0.0</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
        <dev:code>Get-UPAsset -sort username.desc -limit 50</dev:code>
        <dev:remarks>
          <maml:para>Lists up to 50 assets, sorted by username in descending order</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-UPAssetSecret</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UPAssetSecret</command:noun>
      <maml:description>
        <maml:para>Retrieves the secret of an asset</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Retrieves the secret of an asset, by asset identifier, optionally recording a reason for the retrieval.</maml:para>
      <maml:para>Asset identifiers come from `Get-UPAsset`, and pipe into this command.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UPAssetSecret</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="id">
          <maml:name>assetId</maml:name>
          <maml:description>
            <maml:para>The identifier of the asset whose secret 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="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">
          <maml:name>reason</maml:name>
          <maml:description>
            <maml:para>The reason for retrieving the secret.</maml:para>
            <maml:para>Required when the asset's workflowStatus.require_reason is true.</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="True (ByPropertyName)" position="2" aliases="none">
          <maml:name>workflowStatus</maml:name>
          <maml:description>
            <maml:para>The workflow status of the asset, as output by Get-UPAsset.</maml:para>
            <maml:para>An error is written when require_reason is true and -reason is not specified.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
          <dev:type>
            <maml:name>PSObject</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="0" aliases="id">
        <maml:name>assetId</maml:name>
        <maml:description>
          <maml:para>The identifier of the asset whose secret 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="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">
        <maml:name>reason</maml:name>
        <maml:description>
          <maml:para>The reason for retrieving the secret.</maml:para>
          <maml:para>Required when the asset's workflowStatus.require_reason is true.</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="True (ByPropertyName)" position="2" aliases="none">
        <maml:name>workflowStatus</maml:name>
        <maml:description>
          <maml:para>The workflow status of the asset, as output by Get-UPAsset.</maml:para>
          <maml:para>An error is written when require_reason is true and -reason is not specified.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
        <dev:type>
          <maml:name>PSObject</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <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>Get-UPAssetSecret -assetId 12_34</dev:code>
        <dev:remarks>
          <maml:para>Retrieves the secret of the specified asset</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>Get-UPAssetSecret -assetId 12_34 -reason 'Investigating incident INC-1234'</dev:code>
        <dev:remarks>
          <maml:para>Retrieves the secret of the specified asset, recording the reason for the retrieval</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>Get-UPAsset -favoritesOnly | Get-UPAssetSecret -reason 'Scheduled configuration audit'</dev:code>
        <dev:remarks>
          <maml:para>Retrieves the secret of every asset marked as a favourite</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-UPModuleData</command:name>
      <command:verb>Get</command:verb>
      <command:noun>UPModuleData</command:noun>
      <maml:description>
        <maml:para>Get details of the current user portal session</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Returns values of variables from the script scope of the IdentityCommand.UserPortal module.</maml:para>
      <maml:para>This command can be used to examine details usually contained in the script scope of the module.</maml:para>
      <maml:para>Useful data like the last command, last command results and session elapsed time are returned by the command.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-UPModuleData</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>System.Object</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>Get-UPModuleData</dev:code>
        <dev:remarks>
          <maml:para>Returns details relating to the module session from the script scope.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>