custom/generated/Update-JcSdkBulkUser.ps1
|
<# .Synopsis The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ \t{ \t \"id\":\"5be9fb4ddb01290001e85109\", \t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", \t\t\"department\":\"{UPDATED_DEPARTMENT}\", \t\t\"attributes\":[ \t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} \t\t] \t}, \t{ \t \"id\":\"5be9fb4ddb01290001e85109\", \t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", \t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", \t\t\"phoneNumbers\":[ \t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, \t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} \t\t] \t} ] ``` .Description The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ \t{ \t \"id\":\"5be9fb4ddb01290001e85109\", \t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", \t\t\"department\":\"{UPDATED_DEPARTMENT}\", \t\t\"attributes\":[ \t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} \t\t] \t}, \t{ \t \"id\":\"5be9fb4ddb01290001e85109\", \t\t\"firstname\":\"{UPDATED_FIRSTNAME}\", \t\t\"costCenter\":\"{UPDATED_COST_CENTER}\", \t\t\"phoneNumbers\":[ \t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, \t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} \t\t] \t} ] ``` .Example PS C:\> Update-JcSdkBulkUser .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IBulkUserUpdate[] .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 <IBulkUserUpdate[]>: [AccountLocked <Boolean?>]: [Addresses <IBulkUserUpdateAddressesItem[]>]: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country [Country <String>]: [ExtendedAddress <String>]: [Locality <String>]: [PoBox <String>]: [PostalCode <String>]: [Region <String>]: [StreetAddress <String>]: [Type <String>]: [AllowPublicKey <Boolean?>]: [AlternateEmail <String>]: [Attributes <IBulkUserUpdateAttributesItem[]>]: [Name <String>]: [Value <String>]: [Company <String>]: [CostCenter <String>]: [Department <String>]: [Description <String>]: [DisableDeviceMaxLoginAttempts <Boolean?>]: [Displayname <String>]: [Email <String>]: [EmployeeIdentifier <String>]: Must be unique per user. [EmployeeType <String>]: [EnableManagedUid <Boolean?>]: [EnableUserPortalMultifactor <Boolean?>]: [ExternalDn <String>]: [ExternalPasswordExpirationDate <String>]: [ExternalSourceType <String>]: [ExternallyManaged <Boolean?>]: [Firstname <String>]: [Id <String>]: Object ID of the user being updated [JobTitle <String>]: [Lastname <String>]: [LdapBindingUser <Boolean?>]: [Location <String>]: [ManagedAppleId <String>]: [Manager <String>]: Relation with another systemuser to identify the last as a manager. [MfaConfigured <Boolean?>]: [MfaExclusion <Boolean?>]: [MfaExclusionDays <Int32?>]: [MfaExclusionUntil <DateTime?>]: [Middlename <String>]: [Organization <String>]: Organization object id of the user [Password <String>]: [PasswordNeverExpires <Boolean?>]: [PasswordlessSudo <Boolean?>]: [PhoneNumbers <IBulkUserUpdatePhoneNumbersItem[]>]: [Number <String>]: [Type <String>]: [PublicKey <String>]: [Relationships <IBulkUserUpdateRelationshipsItem[]>]: [Type <String>]: [Value <String>]: [SambaServiceUser <Boolean?>]: [SshKeys <IBulkUserUpdateSshKeysItem[]>]: Name <String>: The name of the SSH key. PublicKey <String>: The Public SSH key. [State <String>]: [Sudo <Boolean?>]: [Suspended <Boolean?>]: [UnixGuid <Int32?>]: [UnixUid <Int32?>]: [Username <String>]: .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Update-JcSdkBulkUser.md #> Function Update-JcSdkBulkUser { [OutputType([System.String])] [CmdletBinding(DefaultParameterSetName='Update', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter()] [JumpCloud.SDK.V2.Category('Query')] [System.Management.Automation.SwitchParameter] # An option indicating whether to suppress the job results email that will # otherwise be sent to the Administrator who created the job. # If true, the # email won't be sent. # If omitted or false, the email will be sent. ${SuppressEmail}, [Parameter(Mandatory, ValueFromPipeline)] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IBulkUserUpdate[]] # Array of bulk-user-update # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [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 { $Results = @() $PSBoundParameters.Add('HttpPipelineAppend', { param($req, $callback, $next) # call the next step in the Pipeline $ResponseTask = $next.SendAsync($req, $callback) $global:JCHttpRequest = $req # $global:JCHttpRequestContent = If (-not [System.String]::IsNullOrEmpty($req.Content)) { $req.Content.ReadAsStringAsync() } $global:JCHttpResponse = $ResponseTask # $global:JCHttpResponseContent = If (-not [System.String]::IsNullOrEmpty($ResponseTask.Result.Content)) { $ResponseTask.Result.Content.ReadAsStringAsync() } Return $ResponseTask } ) } Process { $maxRetries = 4 $resultCounter = 0 :retryLoop do { $resultCounter++ $Results = JumpCloud.SDK.V2.internal\Update-JcSdkInternalBulkUser @PSBoundParameters -errorAction SilentlyContinue -errorVariable sdkError If ($sdkError){ If ($resultCounter -eq $maxRetries){ throw $sdkError } If ($JCHttpResponse.Result.StatusCode -eq "503") { Write-Warning ("503: Service Unavailable - retrying in " + ($resultCounter * 5) + " seconds.") } else { throw $sdkError } } else { break retryLoop } Start-Sleep -Seconds ($resultCounter * 5) } while ($resultCounter -lt $maxRetries) } End { Write-Debug ('HttpRequest: ' + $JCHttpRequest); # Write-Debug ('HttpRequestContent: ' + $JCHttpRequestContent.Result); Write-Debug ('HttpResponse: ' + $JCHttpResponse.Result); # Write-Debug ('HttpResponseContent: ' + $JCHttpResponseContent.Result); # Clean up global variables $GlobalVars = @('JCHttpRequest', 'JCHttpRequestContent', 'JCHttpResponse', 'JCHttpResponseContent') $GlobalVars | ForEach-Object { If ((Get-Variable -Scope:('Global')).Where( { $_.Name -eq $_ })) { Remove-Variable -Name:($_) -Scope:('Global') } } Return $Results } } |