dbc_acc

24.1.0

en-US/DBC_ACC.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Get-APSToken -->
  <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">
    <command:details>
      <command:name>Get-APSToken</command:name>
      <command:verb>Get</command:verb>
      <command:noun>APSToken</command:noun>
      <maml:description>
        <maml:para>Get an ADSK Platform Services token.</maml:para>
      </maml:description>
    </command:details>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Get-APSToken</maml:name>
        <!-- Parameter: Scopes -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>Scopes</maml:name>
          <maml:description>
            <maml:para>Access Scopes. Defaults to "data:read data:write data:create"</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>data:read data:write account:read account:write data:create</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: ClientID -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="1">
          <maml:name>ClientID</maml:name>
          <maml:description>
            <maml:para>ClientID. Defaults to value in the APS_APP_CLIENT_ID environment variable."</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ForceError -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="10">
          <maml:name>ForceError</maml:name>
          <maml:description>
            <maml:para>For testing unattended scripts.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: ClientSecret -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="11">
          <maml:name>ClientSecret</maml:name>
          <maml:description>
            <maml:para>ClientSecret. Defaults to value in the APS_APP_SECRET environment variable."</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: RedirectCallback -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
          <maml:name>RedirectCallback</maml:name>
          <maml:description>
            <maml:para>Defaults to http://localhost:8055/. Needs to match the Redirect URL as defined in the app definition.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>http://localhost:8055/</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: UseWebPage -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="4">
          <maml:name>UseWebPage</maml:name>
          <maml:description>
            <maml:para>Use web page instead of built-in dialog.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>True</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: UseCacheIfAvailable -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="5">
          <maml:name>UseCacheIfAvailable</maml:name>
          <maml:description>
            <maml:para>Use cached token if available.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: NewToken -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="6">
          <maml:name>NewToken</maml:name>
          <maml:description>
            <maml:para>Bypass values cached in registry and force new token generation.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: SuppressLoginPrompt -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="7">
          <maml:name>SuppressLoginPrompt</maml:name>
          <maml:description>
            <maml:para>Changes the login address.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: UnattendedMode -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="8">
          <maml:name>UnattendedMode</maml:name>
          <maml:description>
            <maml:para>Suppresses interactive form and throws exception on failure.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: PreserveRegistryValues -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="9">
          <maml:name>PreserveRegistryValues</maml:name>
          <maml:description>
            <maml:para>Don't overwrite registry entries when refresh fails.</maml:para>
          </maml:description>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: Scopes -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>Scopes</maml:name>
        <maml:description>
          <maml:para>Access Scopes. Defaults to "data:read data:write data:create"</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>data:read data:write account:read account:write data:create</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: ClientID -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="1">
        <maml:name>ClientID</maml:name>
        <maml:description>
          <maml:para>ClientID. Defaults to value in the APS_APP_CLIENT_ID environment variable."</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ClientSecret -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="11">
        <maml:name>ClientSecret</maml:name>
        <maml:description>
          <maml:para>ClientSecret. Defaults to value in the APS_APP_SECRET environment variable."</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: RedirectCallback -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
        <maml:name>RedirectCallback</maml:name>
        <maml:description>
          <maml:para>Defaults to http://localhost:8055/. Needs to match the Redirect URL as defined in the app definition.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>http://localhost:8055/</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: UseWebPage -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="4">
        <maml:name>UseWebPage</maml:name>
        <maml:description>
          <maml:para>Use web page instead of built-in dialog.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>True</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: UseCacheIfAvailable -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="5">
        <maml:name>UseCacheIfAvailable</maml:name>
        <maml:description>
          <maml:para>Use cached token if available.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: NewToken -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="6">
        <maml:name>NewToken</maml:name>
        <maml:description>
          <maml:para>Bypass values cached in registry and force new token generation.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: SuppressLoginPrompt -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="7">
        <maml:name>SuppressLoginPrompt</maml:name>
        <maml:description>
          <maml:para>Changes the login address.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: UnattendedMode -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="8">
        <maml:name>UnattendedMode</maml:name>
        <maml:description>
          <maml:para>Suppresses interactive form and throws exception on failure.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: PreserveRegistryValues -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="9">
        <maml:name>PreserveRegistryValues</maml:name>
        <maml:description>
          <maml:para>Don't overwrite registry entries when refresh fails.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: ForceError -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="10">
        <maml:name>ForceError</maml:name>
        <maml:description>
          <maml:para>For testing unattended scripts.</maml:para>
        </maml:description>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <dev:code>Get-APSToken -ClientID 'native-j9uh78Bv6S8fITCRxHkXdYaos' -RedirectCallback 'http://localhost:8055' -Scopes 'data:read data:write data:create' -ClientSecret 'XXXX'</dev:code>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>