custom/generated/Set-JcSdkApprovalFlow.ps1
|
<# .Synopsis Endpoint for updating a new access workflow .Description Endpoint for updating a new access workflow .Example PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:(<string>) -ApprovalType:(<string>) -ApproverRequirement:(<string>) -ApproverResources:(<JumpCloud.SDK.V2.Models.JumpcloudIngressoApproverResource[]>) -Description:(<string>) -FixedDuration:(<string>) -IconColor:(<string>) -IconUrl:(<string>) -MultiSelectDuration:(<string[]>) -Name:(<string>) -NonAdminApproval:(<switch>) -OrganizationObjectIdInputFile:(<string>) -ResourceId:(<string>) -SlackConfig:(<JumpCloud.SDK.V2.Models.JumpcloudIngressoSlackConfig[]>) -SlackEnabled:(<switch>) -Status:(<string>) -TimeBasedAccess:(<switch>) -TtlConfig:(<string>) -VisibleTo:(<string[]>) .Example PS C:\> Set-JcSdkApprovalFlow -ApprovalFlowId:(<string>) -Body:(<JumpCloud.SDK.V2.Models.Paths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema>) .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity .Inputs JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema .Outputs JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse .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. APPROVERRESOURCES <IJumpcloudIngressoApproverResource[]>: [RequireAll <Boolean?>]: [ResourceId <String>]: [ResourceName <String>]: [ResourceOrder <Int32?>]: [ResourceType <String>]: BODY <IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema>: [ApprovalType <String>]: [ApproverRequirement <String>]: [ApproverResources <List<IJumpcloudIngressoApproverResource>>]: [RequireAll <Boolean?>]: [ResourceId <String>]: [ResourceName <String>]: [ResourceOrder <Int32?>]: [ResourceType <String>]: [Description <String>]: [FixedDuration <String>]: [IconColor <String>]: [IconUrl <String>]: [MultiSelectDuration <List<String>>]: [Name <String>]: [NonAdminApproval <Boolean?>]: [OrganizationObjectId <Byte[]>]: [ResourceId <String>]: [SlackConfig <List<IJumpcloudIngressoSlackConfig>>]: [SlackResourceId <String>]: [SlackEnabled <Boolean?>]: [Status <String>]: [TimeBasedAccess <Boolean?>]: [TtlConfig <String>]: [VisibleTo <List<String>>]: INPUTOBJECT <IJumpCloudApiIdentity>: [AccountId <String>]: [ActivedirectoryId <String>]: [AdministratorId <String>]: [AgentId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [ApprovalFlowId <String>]: [CommandId <String>]: ObjectID of the Command. [CustomEmailType <String>]: [DeviceId <String>]: [GroupId <String>]: ObjectID of the Policy Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of this Active Directory instance. [JobId <String>]: [LdapserverId <String>]: ObjectID of the LDAP Server. [Office365Id <String>]: ObjectID of the Office 365 instance. [PolicyId <String>]: ObjectID of the Policy. [ProviderId <String>]: [PushEndpointId <String>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SoftwareAppId <String>]: ObjectID of the Software App. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: SLACKCONFIG <IJumpcloudIngressoSlackConfig[]>: [SlackResourceId <String>]: .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Set-JcSdkApprovalFlow.md #> Function Set-JcSdkApprovalFlow { [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoUpdateAccessWorkflowResponse])] [CmdletBinding(DefaultParameterSetName='SetExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(Mandatory)] [JumpCloud.SDK.V2.Category('Uri')] [System.String] # Region for JumpCloud API host. # Use 'console' for US or 'console.eu' for EU. ${ConsoleHost}, [Parameter(ParameterSetName='Set', Mandatory)] [Parameter(ParameterSetName='SetExpanded', Mandatory)] [JumpCloud.SDK.V2.Category('Path')] [System.String] # . ${ApprovalFlowId}, [Parameter(ParameterSetName='SetViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SetViaIdentityExpanded', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Path')] [JumpCloud.SDK.V2.Models.IJumpCloudApiIdentity] # Identity Parameter ${InputObject}, [Parameter(ParameterSetName='Set', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='SetViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IPaths14Hfh8UApprovalflowsApprovalflowidPutRequestbodyContentApplicationJsonSchema] # . ${Body}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${ApprovalType}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${ApproverRequirement}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[]] # . ${ApproverResources}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Description}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${FixedDuration}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${IconColor}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${IconUrl}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [System.String[]] # . ${MultiSelectDuration}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Name}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${NonAdminApproval}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # Input File for OrganizationObjectId (.) ${OrganizationObjectIdInputFile}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${ResourceId}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[]] # . ${SlackConfig}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${SlackEnabled}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${Status}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${TimeBasedAccess}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [JumpCloud.SDK.V2.Category('Body')] [System.String] # . ${TtlConfig}, [Parameter(ParameterSetName='SetExpanded')] [Parameter(ParameterSetName='SetViaIdentityExpanded')] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Body')] [System.String[]] # . ${VisibleTo}, [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\Set-JcSdkInternalApprovalFlow @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 } } |