exports/Update-JcSdkLdapServer.ps1
|
<# .Synopsis This endpoint allows updating some attributes of an LDAP server.\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"remove\",\n \"userPasswordExpirationAction\": \"disable\"\n }'\n``` .Description This endpoint allows updating some attributes of an LDAP server.\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"remove\",\n \"userPasswordExpirationAction\": \"disable\"\n }'\n``` .Example To view examples, please use the -Online parameter with Get-Help or navigate to: https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v2/update-jcsdkldapserver .Inputs JumpCloud.SDK.V2.Models.IBodyParameterLdapServerPatchRequestBody .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .Outputs JumpCloud.SDK.V2.Models.IPathsLdapserversIdPatchResponses200ContentApplicationJsonSchema .Outputs System.String .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 <IBodyParameterLdapServerPatchRequestBody>: HELP MESSAGE MISSING [Id <String>]: [UserLockoutAction <String>]: LDAP Server Action [UserPasswordExpirationAction <String>]: LDAP Server Action INPUTOBJECT <IJumpCloudApIsIdentity>: Identity Parameter [AccountId <String>]: [ActivedirectoryId <String>]: ObjectID of the Active Directory instance. [ApplicationId <String>]: [CommandId <String>]: ObjectID of the Command. [GroupId <String>]: ObjectID of the User Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of the User Group. [JobId <String>]: [LdapserverId <String>]: ObjectID of the LDAP Server. [Office365Id <String>]: ObjectID of the Office 365 instance. [PolicyId <String>]: [ProviderId <String>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v2/update-jcsdkldapserver #> function Update-JcSdkLdapServer { [OutputType([JumpCloud.SDK.V2.Models.IPathsLdapserversIdPatchResponses200ContentApplicationJsonSchema], [System.String])] [CmdletBinding(DefaultParameterSetName='PatchExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Patch', Mandatory)] [Parameter(ParameterSetName='PatchExpanded', Mandatory)] [Parameter(ParameterSetName='PatchViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Path')] [System.String] # HELP MESSAGE MISSING ${Id}, [Parameter(ParameterSetName='PatchViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='PatchViaIdentityExpanded', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Path')] [JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [JumpCloud.SDK.V2.Category('Header')] [System.String] # HELP MESSAGE MISSING ${XApiKey}, [Parameter()] [JumpCloud.SDK.V2.Category('Header')] [System.String] # HELP MESSAGE MISSING ${XOrgId}, [Parameter(ParameterSetName='Patch', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='PatchViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IBodyParameterLdapServerPatchRequestBody] # HELP MESSAGE MISSING # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='PatchExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # HELP MESSAGE MISSING ${Id1}, [Parameter(ParameterSetName='PatchExpanded')] [Parameter(ParameterSetName='PatchViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # LDAP Server Action ${UserLockoutAction}, [Parameter(ParameterSetName='PatchExpanded')] [Parameter(ParameterSetName='PatchViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # LDAP Server Action ${UserPasswordExpirationAction}, [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 = @{ Patch = 'JumpCloud.SDK.V2.private\Update-JcSdkLdapServer_Patch'; PatchExpanded = 'JumpCloud.SDK.V2.private\Update-JcSdkLdapServer_PatchExpanded'; PatchViaIdentity = 'JumpCloud.SDK.V2.private\Update-JcSdkLdapServer_PatchViaIdentity'; PatchViaIdentityExpanded = 'JumpCloud.SDK.V2.private\Update-JcSdkLdapServer_PatchViaIdentityExpanded'; } $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 } } } |