netcoreapp3.1/VMware.Vcf.Sso.Commands.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>New-VcfOAuthSecurityContext</command:name> <command:verb>New</command:verb> <command:noun>VcfOAuthSecurityContext</command:noun> <maml:description> <maml:para>Creates an OAuth2 security context object that you can use to authenticate to any system that is configured with VCF SSO.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an OAuth2 security context object that you can use to authenticate to any system that is configured with VCF SSO.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VcfOAuthSecurityContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentityBrokerHostname</maml:name> <maml:description> <maml:para>Specifies the hostname of the VCF Identity Broker where the token exchange will be performed.</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>ApiToken</maml:name> <maml:description> <maml:para>Specifies the API token which will be used to obtain a bearer token. API tokens can only be created on VCF 9.1 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</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>Tenant</maml:name> <maml:description> <maml:para>Specifies the VCF Identity Broker tenant.</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>CUSTOMER</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>IdentityBrokerHostname</maml:name> <maml:description> <maml:para>Specifies the hostname of the VCF Identity Broker where the token exchange will be performed.</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>ApiToken</maml:name> <maml:description> <maml:para>Specifies the API token which will be used to obtain a bearer token. API tokens can only be created on VCF 9.1 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</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>Tenant</maml:name> <maml:description> <maml:para>Specifies the VCF Identity Broker tenant.</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>CUSTOMER</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>VMware.Vcf.Sso.Types.VcfOAuthSecurityContext</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>$oauthCtx = New-VcfOAuthSecurityContext ` -IdentityBrokerHostname "<VCF Identity Broker hostname>" ` -ApiToken "..." `</dev:code> <dev:remarks> <maml:para>Creates an OAuth2 security context object by authenticating against the specified VCF Identity Broker and the default tenant.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$oauthCtx = New-VcfOAuthSecurityContext ` -IdentityBrokerHostname "<VCF Identity Broker hostname>" ` -ApiToken "..." ` -Tenant "<Custom Tenant></dev:code> <dev:remarks> <maml:para>Creates an OAuth2 security context object by authenticating against the specified VCF Identity Broker and tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/powercli/latest/vmware.vcf.sso/commands/new-vcfoauthsecuritycontext</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |