nocscienceat.vmware.ADFSOAuth

1.0.2

en-US/nocscienceat.vmware.ADFSOAuth.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
     
    <!-- All Commands-->
    <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-->
        <command:details>
            <command:name>New-ADFSOAuthSecurityContext</command:name>
            <maml:description>
                <maml:para>Creates an Oauth2 security context derived from the GenericOAuth2SecurityContext class, which is also used by the VMware PowerCli's New-OAuthSecurityContext commandlet as the base class of the return value. New-ADFSOAuthSecurityContext internally uses the Microsoft Authentication Library (MSAL) embedded browser and is intended for environments with an MS ADFS server (2016 and later). Unlike New-OAuthSecurityContext, no browser window remains open during authentication and New-ADFSOAuthSecurityContext also does not require a free port for the redirect after authentication. Besides authentication using the embedded browser (IWA is supported), the authentication can be done using a certificate (User- or LocalMachine-Store).</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>New</command:verb>
            <command:noun>ADFSOAuthSecurityContext</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para>The commandlet's configuration parameters for the OIDC/OAuth request are either taken from a configuration file in JSON format whose path is specified via the -AuthenticationConfig parameter, or are passed to the commandlet via the pipeline as an object (nocscienceat.vmware.ADFSOAuth.Models.OAuthRequestSettings) created using the New-OAuthRequestSettings commandlet.</maml:para>
            <maml:para></maml:para>
            <maml:para />
        </maml:description>
        <command:syntax>
            <!-- Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>New-ADFSOAuthSecurityContext</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>AuthenticationConfig</maml:name>
                    <maml:description>
                        <maml:para>Path of the configuration file that specifies the OAuth request.</maml:para>
                        <maml:para>Syntax of the configuration file:
{
  "OAuthRequestSettings": {
    "AdfsAuthority": "https://&lt;adfs-fqdn&gt;/adfs",
    "ClientId": "&lt;Clientidentifier&gt;",
    "RedirectUri": "&lt;yourdomain&gt;.&lt;service&gt;://auth", // omit if UseCertificate or UseCertificateLocalMachine are set to true
    "ResourceId": "&lt;ResourceId&gt;",
    "UseCertificate": false|true, // false: interactive authentication(or IWA); true: certificate based authentication
    "UseCertificateLocalMachine": false|true, // optional: specify this parameter and set it to true if the certificate should be taken from the LocalMachine store (instead of CurrentUser)
    "CertificateThumbprint": "&lt;CertificateThumbprint&gt;" // omit in case of interactive authentication
  }
}</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></dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!-- All Parameters-->
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named">
                <maml:name>AuthenticationConfig</maml:name>
                <maml:description>
                    <maml:para>Path of the configuration file that specifies the OAuth request.</maml:para>
                    <maml:para>Syntax of the configuration file:
{
  "OAuthRequestSettings": {
    "AdfsAuthority": "https://&lt;adfs-fqdn&gt;/adfs",
    "ClientId": "&lt;Clientidentifier&gt;",
    "RedirectUri": "&lt;yourdomain&gt;.&lt;service&gt;://auth", // omit if UseCertificate or UseCertificateLocalMachine are set to true
    "ResourceId": "&lt;ResourceId&gt;",
    "UseCertificate": false|true, // false: interactive authentication(or IWA); true: certificate based authentication
    "UseCertificateLocalMachine": false|true, // optional: specify this parameter and set it to true if the certificate should be taken from the LocalMachine store (instead of CurrentUser)
    "CertificateThumbprint": "&lt;CertificateThumbprint&gt;" // omit in case of interactive authentication
  }
}</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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True" position="named">
                <maml:name>OAuthRequestSettings</maml:name>
                <maml:description>
                    <maml:para>Object that specifies the OAuth request. Passed to the commandlet via the pipeline - usually created using the New-OAuthRequestSettings commandlet</maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">OAuthRequestSettings</command:parameterValue>
                <dev:type>
                    <maml:name>OAuthRequestSettings</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!-- Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>nocscienceat.vmware.ADFSOAuth.Models.OAuthRequestSettings</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para>Configuration Object received via pipeline - usually created using the New-OAuthRequestSettings commandlet</maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!-- Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>nocscienceat.vmware.ADFSOAuth.GenericOAuth2SecurityContextImplementation
</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
    </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">
        <!--TAG: HASCOMMONPARAMETERS-->
        <!-- Command-->
        <command:details>
            <command:name>New-OAuthRequestSettings</command:name>
            <maml:description>
                <maml:para>Creates an nocscienceat.vmware.ADFSOAuth.Models.OAuthRequestSettings Object which is usually passed to the commandlet New-ADFSOAuthSecurityContext as a description of the OAuth request via pipeline. For the parameters of this commandlet please refer to the description of the configuration file of New-ADFSOAuthSecurityContext.</maml:para>
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>New</command:verb>
            <command:noun>OAuthRequestSettings</command:noun>
            <dev:version />
        </command:details>
        <maml:description>
            <maml:para></maml:para>
        </maml:description>
        <command:syntax>
            <!-- Parameter Sets-->
            <command:syntaxItem parametersetname="__AllParameterSets">
                <!--NAME: __AllParameterSets-->
                <maml:name>New-OAuthRequestSettings</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>AdfsAuthority</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ClientId</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>RedirectUri</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>ResourceId</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>UseCertificate</maml:name>
                    <maml:description>
                        <maml:para></maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
                    <dev:type>
                        <maml:name>Boolean</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue></dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>UseCertificateLocalMachine</maml:name>
                    <maml:description>
                        <maml:para></maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
                    <dev:type>
                        <maml:name>Boolean</maml:name>
                        <maml:uri />
                    </dev:type>
                    <dev:defaultValue></dev:defaultValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                    <maml:name>CertificateThumbprint</maml:name>
                    <maml:description>
                        <maml:para></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></dev:defaultValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <!-- All Parameters-->
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>AdfsAuthority</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ClientId</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>RedirectUri</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>ResourceId</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>UseCertificate</maml:name>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
                <dev:type>
                    <maml:name>Boolean</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>UseCertificateLocalMachine</maml:name>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
                <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
                <dev:type>
                    <maml:name>Boolean</maml:name>
                    <maml:uri />
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
                <maml:name>CertificateThumbprint</maml:name>
                <maml:description>
                    <maml:para></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></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <command:inputTypes>
            <!-- Inputs-->
            <command:inputType>
                <dev:type>
                    <maml:name>None
</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:inputType>
        </command:inputTypes>
        <command:returnValues>
            <!-- Outputs-->
            <command:returnValue>
                <dev:type>
                    <maml:name>nocscienceat.vmware.ADFSOAuth.Models.OAuthRequestSettings
</maml:name>
                    <maml:uri></maml:uri>
                </dev:type>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </command:returnValue>
        </command:returnValues>
        <command:examples>
            <!-- Examples-->
            <command:example>
                <maml:title>OIDC Request Configuration</maml:title>
                <maml:introduction>
                    <maml:para />
                </maml:introduction>
                <dev:code>C:\PS&gt; New-OAuthRequestSettings -AdfsAuthority "https://&lt;adfs-fqdn&gt;/adfs" -ResourceId &lt;ResourceId&gt; -RedirectUri "&lt;yourdomain&gt;.&lt;service&gt;://auth" -ClientId &lt;ClientId&gt; -UseCertificate $false | New-ADFSOAuthSecurityContext</dev:code>
                <dev:remarks>
                    <maml:para />
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <!-- Generated by: SAPIEN PowerShell HelpWriter 2022 v2.3.54-->
</helpItems>