internal/New-JcSdkInternalAuthenticationPolicy.ps1
|
# ---------------------------------------------------------------------------------- # Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.6.6, generator: @autorest/powershell@3.0.463) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis Create an authentication policy.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Sample Policy\",\n \"disabled\": false,\n \"effect\": {\n \"action\": \"allow\"\n },\n \"targets\": {\n \"users\": {\n \"inclusions\": [\"ALL\"]\n },\n \"userGroups\": {\n \"exclusions\": [{USER_GROUP_ID}]\n },\n \"resources\": [ {\"type\": \"user_portal\" } ]\n },\n \"conditions\":{\n \"ipAddressIn\": [{IP_LIST_ID}]\n }\n }'\n``` .Description Create an authentication policy.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/authn/policies \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Sample Policy\",\n \"disabled\": false,\n \"effect\": {\n \"action\": \"allow\"\n },\n \"targets\": {\n \"users\": {\n \"inclusions\": [\"ALL\"]\n },\n \"userGroups\": {\n \"exclusions\": [{USER_GROUP_ID}]\n },\n \"resources\": [ {\"type\": \"user_portal\" } ]\n },\n \"conditions\":{\n \"ipAddressIn\": [{IP_LIST_ID}]\n }\n }'\n``` .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IAuthnPolicyInput .Outputs JumpCloud.SDK.V2.Models.IAuthnPolicy .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <IAuthnPolicyInput>: AuthnPolicyInput [Conditions <IAuthnPolicyInputConditions>]: Dictionary of <any> [(Any) <Object>]: This indicates any property can be added to this object. [Description <String>]: [Disabled <Boolean?>]: [EffectAction <String>]: [MfaRequired <Boolean?>]: [Name <String>]: [TargetResources <IAuthnPolicyResourceTarget[]>]: Type <String>: [Id <String>]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. [Type <String>]: AuthnPolicyType [UserAttributeExclusions <IAuthnPolicyUserAttributeFilter[]>]: [Field <String>]: The only field that is currently supported is ldap_binding_user [Operator <String>]: [Value <IAny>]: Any object [UserAttributeInclusions <IAuthnPolicyUserAttributeFilter[]>]: [UserGroupExclusions <String[]>]: [UserGroupInclusions <String[]>]: [UserInclusions <String[]>]: TARGETRESOURCES <IAuthnPolicyResourceTarget[]>: . Type <String>: [Id <String>]: Object ID of the resource target. If undefined, then all resources of the given type are targeted. USERATTRIBUTEEXCLUSIONS <IAuthnPolicyUserAttributeFilter[]>: . [Field <String>]: The only field that is currently supported is ldap_binding_user [Operator <String>]: [Value <IAny>]: Any object USERATTRIBUTEINCLUSIONS <IAuthnPolicyUserAttributeFilter[]>: . [Field <String>]: The only field that is currently supported is ldap_binding_user [Operator <String>]: [Value <IAny>]: Any object .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkInternalAuthenticationPolicy.md #> function New-JcSdkInternalAuthenticationPolicy { [OutputType([JumpCloud.SDK.V2.Models.IAuthnPolicy])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Create', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IAuthnPolicyInput] # AuthnPolicyInput # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Runtime.Info(PossibleTypes=([JumpCloud.SDK.V2.Models.IAuthnPolicyInputConditions]))] [System.Collections.Hashtable] # Dictionary of <any> ${Conditions}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Description}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${Disabled}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${EffectAction}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${MfaRequired}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Name}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IAuthnPolicyResourceTarget[]] # . # To construct, see NOTES section for TARGETRESOURCES properties and create a hash table. ${TargetResources}, [Parameter(ParameterSetName='CreateExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # AuthnPolicyType ${Type}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[]] # . # To construct, see NOTES section for USERATTRIBUTEEXCLUSIONS properties and create a hash table. ${UserAttributeExclusions}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IAuthnPolicyUserAttributeFilter[]] # . # To construct, see NOTES section for USERATTRIBUTEINCLUSIONS properties and create a hash table. ${UserAttributeInclusions}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [System.String[]] # . ${UserGroupExclusions}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [System.String[]] # . ${UserGroupInclusions}, [Parameter(ParameterSetName='CreateExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [System.String[]] # . ${UserInclusions}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Create = 'JumpCloud.SDK.V2.private\New-JcSdkInternalAuthenticationPolicy_Create'; CreateExpanded = 'JumpCloud.SDK.V2.private\New-JcSdkInternalAuthenticationPolicy_CreateExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |