OCI.PSModules.Identitydataplane

50.0.0

OCI.PSModules.Identitydataplane.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<!--Copyright (c) 2020, 2023, Oracle and/or its affiliates.

This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.-->

<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>New-OCIIdentitydataplaneScopedAccessToken</command:name>

      <command:verb>New</command:verb>

      <command:noun>OCIIdentitydataplaneScopedAccessToken</command:noun>

      <maml:description>

        <maml:para>Invokes Dataplane service - GenerateScopedAccessToken operation.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Based on the calling principal and the input payload, derive the claims and create a security token.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-OCIIdentitydataplaneScopedAccessToken</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">

          <maml:name>GenerateScopedAccessTokenDetails</maml:name>

          <maml:Description>

            <maml:para>Scoped Access token request</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Oci.IdentitydataplaneService.Models.GenerateScopedAccessTokenDetails</command:parameterValue>

          <dev:type>

            <maml:name>GenerateScopedAccessTokenDetails</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>ConfigFile</maml:name>

          <maml:Description>

            <maml:para>The path to the config file.</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>Endpoint</maml:name>

          <maml:Description>

            <maml:para>The value to use as the service endpoint, including any required API version path.</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>NoRetry</maml:name>

          <maml:Description>

            <maml:para>Disable retry logic for calls to services.</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>Profile</maml:name>

          <maml:Description>

            <maml:para>The profile in the config file to load.</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>Region</maml:name>

          <maml:Description>

            <maml:para>Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1</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>FullResponse</maml:name>

          <maml:Description>

            <maml:para>Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.</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>TimeOutInMillis</maml:name>

          <maml:Description>

            <maml:para>Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).</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="False" position="named" aliases="none">

          <maml:name>AuthType</maml:name>

          <maml:Description>

            <maml:para>Type of authentication to use for making API requests. Default is Key based Authentication.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">AuthenticationType</command:parameterValue>

          <dev:type>

            <maml:name>AuthenticationType</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>AuthType</maml:name>

        <maml:Description>

          <maml:para>Type of authentication to use for making API requests. Default is Key based Authentication.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">AuthenticationType</command:parameterValue>

        <dev:type>

          <maml:name>AuthenticationType</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>ConfigFile</maml:name>

        <maml:Description>

          <maml:para>The path to the config file.</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>Endpoint</maml:name>

        <maml:Description>

          <maml:para>The value to use as the service endpoint, including any required API version path.</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>FullResponse</maml:name>

        <maml:Description>

          <maml:para>Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.</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 (ByPropertyName)" position="named" aliases="none">

        <maml:name>GenerateScopedAccessTokenDetails</maml:name>

        <maml:Description>

          <maml:para>Scoped Access token request</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Oci.IdentitydataplaneService.Models.GenerateScopedAccessTokenDetails</command:parameterValue>

        <dev:type>

          <maml:name>GenerateScopedAccessTokenDetails</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>NoRetry</maml:name>

        <maml:Description>

          <maml:para>Disable retry logic for calls to services.</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>Profile</maml:name>

        <maml:Description>

          <maml:para>The profile in the config file to load.</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>Region</maml:name>

        <maml:Description>

          <maml:para>Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1</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>TimeOutInMillis</maml:name>

        <maml:Description>

          <maml:para>Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).</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:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Oci.IdentitydataplaneService.Models.SecurityToken</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>

          </maml:para>

        </maml:description>

      </command:returnValue>

      <command:returnValue>

        <dev:type>

          <maml:name>Oci.IdentitydataplaneService.Responses.GenerateScopedAccessTokenResponse</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>

          </maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert />

    </maml:alertSet>

    <command:examples />

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>APIReference</maml:linkText>

        <maml:uri>https://docs.cloud.oracle.com/en-us/iaas/api/</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>DotnetSDKAPI</maml:linkText>

        <maml:uri>https://docs.cloud.oracle.com/en-us/iaas/tools/dotnet/latest/api/index.html</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>OCIModulesDocs</maml:linkText>

        <maml:uri>https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/powershell.htm</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>OCIServiceConcepts</maml:linkText>

        <maml:uri>https://docs.cloud.oracle.com/en-us/iaas/Content/services.htm</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Examples</maml:linkText>

        <maml:uri>https://github.com/oracle/oci-powershell-modules/tree/master/Examples</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>