JumpCloud.SDK.V2

0.2.0

custom/generated/New-JcSdkApprovalFlow.ps1

                                <#

.Synopsis

Endpoint for adding a new access workflow

.Description

Endpoint for adding a new access workflow

.Example

New-JcSdkApprovalFlow -ApprovalType 'manual' -Category "Application" -Description "A new workflow" -MultiSelectDuration @("P5D") -Name "New Workflow" -ResourceId 5d67fd481da3c52aa1faa883 -ResourceType "user_group" -Status "active" -TimeBasedAccess -TtlConfig "TTL_CONFIG_MULTI_SELECT_DURATIONS" -VisibleTo @('6148cd739d38866f0814e874')

.Inputs

JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest

.Outputs

JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse

.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 <IJumpcloudIngressoCreateAccessWorkflowRequest>:

  [ApprovalType <String>]:

  [ApproverRequirement <String>]:

  [ApproverResources <List<IJumpcloudIngressoApproverResource>>]:

    [RequireAll <Boolean?>]:

    [ResourceId <String>]:

    [ResourceName <String>]:

    [ResourceOrder <Int32?>]:

    [ResourceType <String>]:

  [Category <String>]:

  [Description <String>]:

  [FixedDuration <String>]:

  [IconColor <String>]:

  [IconUrl <String>]:

  [MultiSelectDuration <List<String>>]:

  [Name <String>]:

  [NonAdminApproval <Boolean?>]:

  [OrganizationObjectId <Byte[]>]:

  [ResourceId <String>]:

  [ResourceType <String>]:

  [SlackConfig <List<IJumpcloudIngressoSlackConfig>>]:

    [SlackResourceId <String>]:

  [SlackEnabled <Boolean?>]:

  [Status <String>]:

  [TimeBasedAccess <Boolean?>]:

  [TtlConfig <String>]:

  [VisibleTo <List<String>>]:

SLACKCONFIG <IJumpcloudIngressoSlackConfig[]>:

  [SlackResourceId <String>]:

.Link

https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/New-JcSdkApprovalFlow.md

#>

 Function New-JcSdkApprovalFlow

{

    [OutputType([JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowResponse])]

    [CmdletBinding(DefaultParameterSetName='CreateExpanded', 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='Create', Mandatory, ValueFromPipeline)]

    [JumpCloud.SDK.V2.Category('Body')]

    [JumpCloud.SDK.V2.Models.IJumpcloudIngressoCreateAccessWorkflowRequest]

    # .

    ${Body}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${ApprovalType}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${ApproverRequirement}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [AllowEmptyCollection()]

    [JumpCloud.SDK.V2.Category('Body')]

    [JumpCloud.SDK.V2.Models.IJumpcloudIngressoApproverResource[]]

    # .

    ${ApproverResources}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${Category}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${Description}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${FixedDuration}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${IconColor}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${IconUrl}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [AllowEmptyCollection()]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String[]]

    # .

    ${MultiSelectDuration}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${Name}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.Management.Automation.SwitchParameter]

    # .

    ${NonAdminApproval}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # Input File for OrganizationObjectId (.)

    ${OrganizationObjectIdInputFile}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${ResourceId}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${ResourceType}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [AllowEmptyCollection()]

    [JumpCloud.SDK.V2.Category('Body')]

    [JumpCloud.SDK.V2.Models.IJumpcloudIngressoSlackConfig[]]

    # .

    ${SlackConfig}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.Management.Automation.SwitchParameter]

    # .

    ${SlackEnabled}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${Status}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.Management.Automation.SwitchParameter]

    # .

    ${TimeBasedAccess}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [JumpCloud.SDK.V2.Category('Body')]

    [System.String]

    # .

    ${TtlConfig}, 

    [Parameter(ParameterSetName='CreateExpanded')]

    [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\New-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

    }

}