JumpCloud.SDK.V1

0.0.6

exports/Set-JcSdkSystemUser.ps1

                                <#

.Synopsis

This endpoint allows you to update a system user.\n\n#### Sample Request\n\n```\ncurl -X PUT https://console.jumpcloud.com/api/systemusers/{UserID} \\\n  -H 'Accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -H 'x-api-key: {API_KEY}' \\\n  -d '{\n\t\"email\":\"{email_address}\",\n\t\"firstname\":\"{Name}\",\n\t\"lastname\":\"{Name}\"\n}'\n```

.Description

This endpoint allows you to update a system user.\n\n#### Sample Request\n\n```\ncurl -X PUT https://console.jumpcloud.com/api/systemusers/{UserID} \\\n  -H 'Accept: application/json' \\\n  -H 'Content-Type: application/json' \\\n  -H 'x-api-key: {API_KEY}' \\\n  -d '{\n\t\"email\":\"{email_address}\",\n\t\"firstname\":\"{Name}\",\n\t\"lastname\":\"{Name}\"\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.v1/set-jcsdksystemuser

.Inputs

JumpCloud.SDK.V1.Models.IJumpCloudApIsIdentity

.Inputs

JumpCloud.SDK.V1.Models.ISystemuserput

.Outputs

JumpCloud.SDK.V1.Models.ISystemuserreturn

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

ADDRESSES <ISystemuserputAddressesItem[]>: type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country

  [Country <String>]: 

  [ExtendedAddress <String>]: 

  [Locality <String>]: 

  [PoBox <String>]: 

  [PostalCode <String>]: 

  [Region <String>]: 

  [StreetAddress <String>]: 

  [Type <String>]: 

BODY <ISystemuserput>: SystemUserPut

  [AccountLocked <Boolean?>]: 

  [Addresses <ISystemuserputAddressesItem[]>]: 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?>]: 

  [Attributes <ISystemuserputAttributesItem[]>]: 

  [Company <String>]: 

  [CostCenter <String>]: 

  [Department <String>]: 

  [Description <String>]: 

  [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>]: 

  [JobTitle <String>]: 

  [Lastname <String>]: 

  [LdapBindingUser <Boolean?>]: 

  [Location <String>]: 

  [MfaConfigured <Boolean?>]: 

  [MfaExclusion <Boolean?>]: 

  [MfaExclusionUntil <DateTime?>]: 

  [Middlename <String>]: 

  [Password <String>]: 

  [PasswordNeverExpires <Boolean?>]: 

  [PhoneNumbers <ISystemuserputPhoneNumbersItem[]>]: 

    [Number <String>]: 

    [Type <String>]: 

  [PublicKey <String>]: 

  [Relationships <ISystemuserputRelationshipsItem[]>]: 

  [SambaServiceUser <Boolean?>]: 

  [SshKeys <ISshkeypost[]>]: 

    Name <String>: The name of the SSH key.

    PublicKey <String>: The Public SSH key.

  [Sudo <Boolean?>]: 

  [Suspended <Boolean?>]: 

  [Tags <String[]>]: 

  [UnixGuid <Int32?>]: 

  [UnixUid <Int32?>]: 

  [Username <String>]: 

INPUTOBJECT <IJumpCloudApIsIdentity>: Identity Parameter

  [Id <String>]: 

  [SystemuserId <String>]: 

  [Triggername <String>]: 

PHONENUMBERS <ISystemuserputPhoneNumbersItem[]>: HELP MESSAGE MISSING

  [Number <String>]: 

  [Type <String>]: 

SSHKEYS <ISshkeypost[]>: HELP MESSAGE MISSING

  Name <String>: The name of the SSH key.

  PublicKey <String>: The Public SSH key.

.Link

https://docs.microsoft.com/en-us/powershell/module/jumpcloud.sdk.v1/set-jcsdksystemuser

#>

function Set-JcSdkSystemUser {

[OutputType([JumpCloud.SDK.V1.Models.ISystemuserreturn])]

[CmdletBinding(DefaultParameterSetName='PutExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

param(

    [Parameter(ParameterSetName='Put', Mandatory)]

    [Parameter(ParameterSetName='PutExpanded', Mandatory)]

    [JumpCloud.SDK.V1.Category('Path')]

    [System.String]

    # HELP MESSAGE MISSING

    ${Id},

    [Parameter(ParameterSetName='PutViaIdentity', Mandatory, ValueFromPipeline)]

    [Parameter(ParameterSetName='PutViaIdentityExpanded', Mandatory, ValueFromPipeline)]

    [JumpCloud.SDK.V1.Category('Path')]

    [JumpCloud.SDK.V1.Models.IJumpCloudApIsIdentity]

    # Identity Parameter

    # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

    ${InputObject},

    [Parameter(ParameterSetName='Put', Mandatory, ValueFromPipeline)]

    [Parameter(ParameterSetName='PutViaIdentity', Mandatory, ValueFromPipeline)]

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

    [JumpCloud.SDK.V1.Models.ISystemuserput]

    # SystemUserPut

    # To construct, see NOTES section for BODY properties and create a hash table.

    ${Body},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${AccountLocked},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [JumpCloud.SDK.V1.Models.ISystemuserputAddressesItem[]]

    # type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country

    # To construct, see NOTES section for ADDRESSES properties and create a hash table.

    ${Addresses},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${AllowPublicKey},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [JumpCloud.SDK.V1.Models.ISystemuserputAttributesItem[]]

    # HELP MESSAGE MISSING

    ${Attributes},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Company},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${CostCenter},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Department},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Description},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Displayname},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Email},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # Must be unique per user.

    ${EmployeeIdentifier},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${EmployeeType},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${EnableManagedUid},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${EnableUserPortalMultifactor},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${ExternalDn},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${ExternalPasswordExpirationDate},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${ExternalSourceType},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${ExternallyManaged},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Firstname},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${JobTitle},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Lastname},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${LdapBindingUser},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Location},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${MfaConfigured},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${MfaExclusion},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.DateTime]

    # HELP MESSAGE MISSING

    ${MfaExclusionUntil},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Middlename},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Password},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${PasswordNeverExpires},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [JumpCloud.SDK.V1.Models.ISystemuserputPhoneNumbersItem[]]

    # HELP MESSAGE MISSING

    # To construct, see NOTES section for PHONENUMBERS properties and create a hash table.

    ${PhoneNumbers},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${PublicKey},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [JumpCloud.SDK.V1.Models.ISystemuserputRelationshipsItem[]]

    # HELP MESSAGE MISSING

    ${Relationships},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${SambaServiceUser},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [JumpCloud.SDK.V1.Models.ISshkeypost[]]

    # HELP MESSAGE MISSING

    # To construct, see NOTES section for SSHKEYS properties and create a hash table.

    ${SshKeys},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${Sudo},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Management.Automation.SwitchParameter]

    # HELP MESSAGE MISSING

    ${Suspended},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String[]]

    # HELP MESSAGE MISSING

    ${Tags},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Int32]

    # HELP MESSAGE MISSING

    ${UnixGuid},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.Int32]

    # HELP MESSAGE MISSING

    ${UnixUid},

    [Parameter(ParameterSetName='PutExpanded')]

    [Parameter(ParameterSetName='PutViaIdentityExpanded')]

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

    [System.String]

    # HELP MESSAGE MISSING

    ${Username},

    [Parameter(DontShow)]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [System.Management.Automation.SwitchParameter]

    # Wait for .NET debugger to attach

    ${Break},

    [Parameter(DontShow)]

    [ValidateNotNull()]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [JumpCloud.SDK.V1.Runtime.SendAsyncStep[]]

    # SendAsync Pipeline Steps to be appended to the front of the pipeline

    ${HttpPipelineAppend},

    [Parameter(DontShow)]

    [ValidateNotNull()]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [JumpCloud.SDK.V1.Runtime.SendAsyncStep[]]

    # SendAsync Pipeline Steps to be prepended to the front of the pipeline

    ${HttpPipelinePrepend},

    [Parameter()]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [System.Management.Automation.SwitchParameter]

    # Returns true when the command succeeds

    ${PassThru},

    [Parameter(DontShow)]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [System.Uri]

    # The URI for the proxy server to use

    ${Proxy},

    [Parameter(DontShow)]

    [ValidateNotNull()]

    [JumpCloud.SDK.V1.Category('Runtime')]

    [System.Management.Automation.PSCredential]

    # Credentials for a proxy server to use for the remote call

    ${ProxyCredential},

    [Parameter(DontShow)]

    [JumpCloud.SDK.V1.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 = @{

            Put = 'JumpCloud.SDK.V1.private\Set-JcSdkSystemUser_Put';

            PutExpanded = 'JumpCloud.SDK.V1.private\Set-JcSdkSystemUser_PutExpanded';

            PutViaIdentity = 'JumpCloud.SDK.V1.private\Set-JcSdkSystemUser_PutViaIdentity';

            PutViaIdentityExpanded = 'JumpCloud.SDK.V1.private\Set-JcSdkSystemUser_PutViaIdentityExpanded';

        }

        $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

    }

}

}