Skip to main content

Update Plan Users​

Select

SaaS
Customer Managed

This operation updates associations for users and user groups to a plan.

Path Parameters
  • PlanId string required
Request Body required
  • userOperationType int32 required
  • users object[] required
  • sendInvite boolean required
  • user object required
  • userId int32 required
  • userName string required
Responses

OK

Schema
  • plan object
  • summary object
  • slaInMinutes integer
  • restrictions integer
  • type integer
  • slaInterval integer
  • planStatusFlag integer
  • numDevices integer
  • rpoInMinutes integer
  • subtype integer
  • numUsers integer
  • permissions object[]
  • permissionId integer
  • planOwner object
  • _type_ integer
  • userName string
  • userId integer
  • plan object
  • planSubtype integer
  • _type_ integer
  • planType integer
  • planName string
  • planId integer
  • definesStorage object
  • definesEntity boolean
  • overrideEntity integer
  • securityAssociations object
  • associations object[]
  • userOrGroup object[]
  • userId integer
  • _type_ integer
  • userName string
  • properties object
  • isCreatorAssociation boolean
  • role object
  • _type_ integer
  • roleId integer
  • roleName string
  • ownerAssociations object
  • featureInfo object
  • edgedriveInfo object
  • indexServer object
  • clientId integer
  • clientName string
  • _type_ integer
  • clientEntity object
  • clientId integer
  • clientName string
  • _type_ integer
  • definesEdgeDriveInfo object
  • definesEntity boolean
  • overrideEntity integer
  • inheritance object
  • isSealed boolean
  • storage object
  • storagePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • copy object[]
  • copyType integer
  • active integer
  • isDefault integer
  • copyPrecedence integer
  • retentionRules object
  • retainBackupDataForCycles integer
  • jobs integer
  • retainArchiverDataForDays integer
  • retainBackupDataForDays integer
  • StoragePolicyCopy object
  • copyId integer
  • copyName string
  • drivePool object
  • drivePoolName string
  • drivePoolId integer
  • library object
  • libraryName string
  • libraryId integer
  • useGlobalPolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • definesSchedule object
  • definesEntity boolean
  • overrideEntity integer
  • laptop object
  • features object
  • role object
  • roleId integer
  • roleName string
  • categoryPermission object
  • categoriesPermissionList object[]
  • permissionId integer
  • permissionName string
  • accessPolicies object
  • categoryPermission object
  • definesAccessPolicies object
  • definesEntity boolean
  • overrideEntity integer
  • content object
  • backupContent object[]
  • idatype integer
  • subClientPolicy object
  • backupSetEntity object
  • backupsetId integer
  • _type_ integer
  • backupsetName string
  • subClientList object[]
  • hcSubclientProp object
  • impersonateUser object
  • proxyClient object
  • subClientEntity object
  • clientName string
  • instanceName string
  • backupsetId integer
  • _type_ integer
  • instanceId integer
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • dfsSubclientProp object
  • distributedDataAccessNodes object
  • fsSubClientProp object
  • catalogACL boolean
  • useGlobalFilters integer
  • forcedArchiving boolean
  • useVSSForSystemState boolean
  • olderFileVersionsMode integer
  • backupRetentionMode integer
  • unixCtime boolean
  • keepVersions integer
  • backupRetention boolean
  • scanOption integer
  • backupSystemState boolean
  • afterDeletionKeepItemsForNDays integer
  • unixMtime boolean
  • runTrueUpJobAfterJobsForFS integer
  • catalogAdditional boolean
  • oneTouchSubclient boolean
  • extendRetentionForNDays integer
  • customSubclientFlag boolean
  • isTrueUpOptionEnabledForFS boolean
  • enableContentIndexing boolean
  • retentionPolicy integer
  • contentIndexingPolicy integer
  • archiverRetentionMode integer
  • enableOnePass boolean
  • runTrueUpJobAfterDaysForFS integer
  • useVSS boolean
  • isSynthfullRunAfterOnePassEnabledOnSubclient boolean
  • extendStoragePolicyRetention boolean
  • keepOlderVersionsForNDays integer
  • ibmiSubclientprop object
  • backupConfiguration object
  • oneTouchServer object
  • _type_ integer
  • ddbPath string[]
  • backupFilesOnOrAfterDate object
  • _type_ integer
  • diskCleanupRules object
  • fileModifiedTimeOlderThan integer
  • fileSizeGreaterThan integer
  • stubPruningOptions integer
  • afterArchivingRule integer
  • stubRetentionDaysOld integer
  • fileCreatedTimeOlderThan integer
  • maximumFileSize integer
  • fileAccessTimeOlderThan integer
  • startCleaningIfLessThan integer
  • patternMatch string
  • stopCleaningIfupto integer
  • rulesToSatisfy integer
  • entityMatch string
  • diskCleanupFileTypes object
  • ocsUserName object
  • checkArchiveBit boolean
  • planEntity object
  • nfsSubclientProp object
  • serverInfo object
  • nfsServer object
  • cassandraProps object
  • content object[]
  • path string
  • excludePath string
  • includePath string
  • commonProperties object
  • numberOfBackupStreams integer
  • nextBackupTime integer
  • isTurboSubclient boolean
  • isKeepItemPastExpiryTime boolean
  • runTrueUpJobAfterDays integer
  • totalBackupSize integer
  • isAdAppAwareSubclient boolean
  • isDefaultSubclient boolean
  • lastBackupTime integer
  • indexingBackupSubClient boolean
  • isTrueUpOptionEnabled boolean
  • subClientPropertiesFlag integer
  • lastBackupSize integer
  • allowVssForSnapbackup boolean
  • enableBackupAfterDelay boolean
  • runAs integer
  • enableBackup boolean
  • securityAssociations object
  • ownerAssociations object
  • enableBackupAtDateTime object
  • TimeZoneID integer
  • time integer
  • turboNASClient object
  • _type_ integer
  • associatedSnapShotSCId object
  • _type_ integer
  • snapCopyInfo object
  • backupCopyInterface integer
  • IsOracleSposDriverEnabled boolean
  • isRMANEnableForTapeMovement boolean
  • useProxyForSQLIntegrity object
  • sybaseUser object
  • snapToTapeSelectedEngine object
  • _type_ integer
  • sqlUser object
  • vmApplicationUser object
  • snapToTapeProxyToUse object
  • _type_ integer
  • quiesceImpersonateUser object
  • separateProxyForSnapToTape object
  • _type_ integer
  • sshKey object
  • configuredSybaseInstance object
  • _type_ integer
  • prepostProcess object
  • runPostScan integer
  • runPostBackup integer
  • runPostLog integer
  • prepostUserName object
  • security object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • storageDevice object
  • networkAgents integer
  • softwareCompression integer
  • throttleNetworkBandwidth integer
  • dataBackupStoragePolicy object
  • _type_ integer
  • storagePolicyName string
  • storagePolicyId integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature integer
  • logBackupStoragePolicy object
  • _type_ integer
  • performanceMode object
  • perfSPName string
  • multiplexingValid boolean
  • enableMultiplexing boolean
  • perfCopyName string
  • perfClientName string
  • streamsOverMux boolean
  • pipelineBufferSize integer
  • numOfPipelineBuffers integer
  • muxFactor integer
  • lookAheadReaderSlots integer
  • perfCRCDetails object[]
  • crcOverMedia boolean
  • perfMaId integer
  • crcOverNetwork boolean
  • perfMa string
  • prepostCredentialinfo object
  • credentialId integer
  • credentialName string
  • associatedPolicy object
  • subclientPolicyId integer
  • impersonateUserCredentialinfo object
  • credentialId integer
  • credentialName string
  • analyticsSubclientProp object
  • definesSubclientWin object
  • definesEntity boolean
  • overrideEntity integer
  • definesSubclientMac object
  • definesEntity boolean
  • overrideEntity integer
  • definesSubclientLin object
  • definesEntity boolean
  • overrideEntity integer
  • users object
  • users object[]
  • email string
  • user object
  • userName string
  • userId integer
  • externalUserGroup object
  • externalGroupName string
  • providerId integer
  • groupId integer
  • providerDomainName string
  • definesFeatures object
  • definesEntity boolean
  • overrideEntity integer
  • definesDCPolicy object
  • definesEntity boolean
  • overrideEntity integer
  • operationWindow object
  • ruleId integer
  • alerts object
  • alerts object[]
  • alertName string
  • alertId integer
  • replicationTargets object
  • schedule object
  • associations object[]
  • srmReportSet integer
  • srmTemplateId integer
  • subclientId integer
  • clientGroupId integer
  • storagePolicyId integer
  • copyId integer
  • applicationId integer
  • backupsetId integer
  • instanceId integer
  • sidbStoreId integer
  • clientId integer
  • srmTemplateName string
  • agentlessPolicyId integer
  • mediaAgentId integer
  • workflowId integer
  • clientGroupName string
  • _type_ integer
  • trackingPolicyId integer
  • flags object
  • exclude boolean
  • task object
  • description string
  • ownerId integer
  • runUserId integer
  • taskType integer
  • ownerName string
  • alertId integer
  • GUID string
  • policyType integer
  • associatedObjects integer
  • taskName string
  • taskId integer
  • securityAssociations object
  • associations object[]
  • userOrGroup object[]
  • userId integer
  • _type_ integer
  • userName string
  • properties object
  • isCreatorAssociation boolean
  • role object
  • _type_ integer
  • roleId integer
  • roleName string
  • ownerAssociations object
  • originalCC object
  • commCellId integer
  • taskSecurity object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • createAs object
  • user object
  • user object
  • userName string
  • userId integer
  • taskFlags object
  • isEdgeDrive boolean
  • isEZOperation boolean
  • forDDB boolean
  • uninstalled boolean
  • isSystem boolean
  • disabled boolean
  • task object
  • taskName string
  • taskId integer
  • appGroup object
  • subTasks object[]
  • subTask object
  • subTaskOrder integer
  • subTaskName string
  • subTaskType integer
  • flags integer
  • operationType integer
  • subTaskId integer
  • subTask object
  • subtaskId integer
  • subtaskName string
  • pattern object
  • active_end_occurence integer
  • freq_subday_interval integer
  • freq_type integer
  • patternId integer
  • flags integer
  • description string
  • active_end_time integer
  • active_end_date integer
  • skipOccurence integer
  • skipDayNumber integer
  • active_start_time integer
  • freq_restart_interval integer
  • active_start_date integer
  • freq_interval integer
  • freq_relative_interval integer
  • name string
  • freq_recurrence_factor integer
  • calendar object
  • calendarName string
  • calendarId integer
  • timeZone object
  • TimeZoneID integer
  • options object
  • backupOpts object
  • backupLevel integer
  • incLevel integer
  • runIncrementalBackup boolean
  • cdrOptions object
  • incremental boolean
  • dataOpt object
  • useCatalogServer boolean
  • followMountPoints boolean
  • daysBetweenSyntheticBackup integer
  • enforceTransactionLogUsage boolean
  • skipConsistencyCheck boolean
  • createNewIndex boolean
  • autoCopy boolean
  • truncateLogsOnSource boolean
  • doNotTruncateLog boolean
  • vsaBackupOptions object
  • backupFailedVMsOnly boolean
  • commonOpts object
  • automaticSchedulePattern object
  • maxBackupInterval integer
  • ignoreOpWindowPastMaxInterval boolean
  • minBackupIntervalMinutes integer
  • maxBackupIntervalMinutes integer
  • minSyncInterval integer
  • minBackupInterval integer
  • minSyncIntervalMinutes integer
  • stopIfOnBattery object
  • enabled boolean
  • acPower object
  • enabled boolean
  • specfificNetwork object
  • enabled boolean
  • ipAddress object
  • subnet integer
  • address string
  • stopSleepIfBackUp object
  • enabled boolean
  • newOrModifiedFile object
  • enabled boolean
  • wiredNetworkConnection object
  • enabled boolean
  • minNetworkBandwidth object
  • enabled boolean
  • database object
  • slaInMinutes integer
  • rpoInMinutes integer
  • scheduleLog object
  • task object
  • storageLog object
  • storagePolicy object
  • definesScheduleLog object
  • definesEntity boolean
  • overrideEntity integer
  • definesStorageLog object
  • definesEntity boolean
  • overrideEntity integer
  • autoCreatedEntities object
  • clientGroup object
  • clientGroupId integer
  • clientGroupName string
  • localUserGroup object
  • userGroupId integer
  • userGroupName string
  • eDiscoveryInfo object
  • definesContentAnalyzerCloud object
  • definesEntity boolean
  • overrideEntity integer
  • definesAnalyticsIndexServer object
  • definesEntity boolean
  • overrideEntity integer
  • options object
  • edgeDriveQuota integer
  • forcedArchiving boolean
  • quota integer
  • exchange object
  • definesMBRetention object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBCleanup object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBArchiving object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBJournal object
  • definesEntity boolean
  • overrideEntity integer
  • definition object
  • possible integer[]
  • required integer[]
  • errors object[]
  • entity object
  • status object
  • errorMessage string
  • errorCode integer
Loading...