Create a User

post

/api/restapi/user

Send a request to this endpoint to create a user.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ApiEntityUserInput
Type: object
Title: ApiEntityUserInput
Show Source
Nested Schema : officeIds
Type: array
The list of unique identifiers for the offices.
Show Source
Nested Schema : productNames
Type: array
The list of license names.
Allowed Values: [ "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ]
Show Source
Examples

Back to Top

Response

Supported Media Types

201 Response

The object was successfully created.
Body ()
Root Schema : ApiEntityUser
Type: object
Title: ApiEntityUser
Show Source
Nested Schema : officeIds
Type: array
The list of unique identifiers for the offices.
Show Source
Nested Schema : userProducts
Type: array
A list of all user product fields and values in the form of key value pairs.
Show Source
Nested Schema : userSettings
Type: array
A list of all user setting fields and values in the form of key value pairs.
Show Source
Nested Schema : ApiEntityUserProduct
Type: object
Title: ApiEntityUserProduct
Show Source
Nested Schema : ApiEntityApplicationUserSetting
Type: object
Title: ApiEntityApplicationUserSetting
Show Source
  • The system-generated identifier of a user.
  • The unique identifier of a user's settings.
  • Minimum Length: 1
    Maximum Length: 255
    The namespace to which a user is assigned.
  • Allowed Values: [ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ]
    The name of a user setting.
  • Minimum Length: 1
    Maximum Length: 4000
    The value of a user setting.
  • Date when the record was last updated.

400 Response

Invalid input for the user group service.
Back to Top