custom/Import-JcSdkWorkdayImportWorkday.ps1
<# .Synopsis The endpoint allows you to create a Workday Import request.\n\n#### Sample Request \n```\ncurl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '[\n\t{\n\t\t\"email\":\"{email}\",\n\t\t\"firstname\":\"{firstname}\",\n\t\t\"lastname\":\"{firstname}\",\n\t\t\"username\":\"{username}\",\n\t\t\"attributes\":[\n\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"},\n\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"}\n\t\t\t]\n\t\t\n\t}\n]\n``` .Description The endpoint allows you to create a Workday Import request.\n\n#### Sample Request \n```\ncurl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '[\n\t{\n\t\t\"email\":\"{email}\",\n\t\t\"firstname\":\"{firstname}\",\n\t\t\"lastname\":\"{firstname}\",\n\t\t\"username\":\"{username}\",\n\t\t\"attributes\":[\n\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"},\n\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"}\n\t\t\t]\n\t\t\n\t}\n]\n``` .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs JumpCloud.SDK.V2.Models.IBulkUserCreate[] .Inputs JumpCloud.SDK.V2.Models.IJumpCloudApIsIdentity .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 <IBulkUserCreate[]>: [Attributes <IBulkUserCreateAttributesItem[]>]: Map of additional attributes. [Email <String>]: [Firstname <String>]: [Lastname <String>]: [Username <String>]: INPUTOBJECT <IJumpCloudApIsIdentity>: [AccountId <String>]: [ActivedirectoryId <String>]: [AppleMdmId <String>]: [ApplicationId <String>]: ObjectID of the Application. [CommandId <String>]: ObjectID of the Command. [DeviceId <String>]: [GroupId <String>]: ObjectID of the System Group. [GsuiteId <String>]: ObjectID of the G Suite instance. [Id <String>]: ObjectID of the System Group. [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>]: [RadiusserverId <String>]: ObjectID of the Radius Server. [SystemId <String>]: ObjectID of the System. [UserId <String>]: ObjectID of the User. [WorkdayId <String>]: .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/jumpcloud.sdk.v2/import-jcsdkworkdayimportworkday #> Function Import-JcSdkWorkdayImportWorkday { [OutputType([System.String])] [CmdletBinding(DefaultParameterSetName='Import', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] Param( [Parameter(ParameterSetName='Import', Mandatory)] [JumpCloud.SDK.V2.Category('Path')] [System.String] # . ${WorkdayId}, [Parameter(ParameterSetName='ImportViaIdentity', 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(Mandatory, ValueFromPipeline)] [JumpCloud.SDK.V2.Category('Body')] [JumpCloud.SDK.V2.Models.IBulkUserCreate[]] # . # To construct, see NOTES section for BODY properties and create a hash table. ${Body} ) Begin { $Results = @() } Process { $Results = JumpCloud.SDK.V2.internal\Import-JcSdkInternalWorkdayImportWorkday @PSBoundParameters } End { Return $Results } } |