Jump to

• Request
• Response

View a User

get

/api/restapi/user/{userId}

This endpoint returns users that meet the following requirements:

• The object is associated with a user with an ID value that matches the value of the {userId} path parameter.

Request

Path Parameters

• userId(required): integer(int64)
  The system-generated identifier of a user.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityExternallySourcedUser

Type: object

Title: ApiEntityExternallySourcedUser

Show Source

• companyId: integer (int64)
  The company the user is associated with.
• email(required): string
  Maximum Length: 320

  The email address of a user.
• firstName(required): string
  Maximum Length: 100

  The first name of a user.
• lastLogInTime: string (date-time)
  The date and time the user last logged into the application.
• lastName(required): string
  Maximum Length: 100

  The last name of a user.
• ldapGuid: string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier in the external authentication system (LDAP or IDCS).
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• mobile: string
  Maximum Length: 100

  The mobile phone number of a user.
• phone: string
  Maximum Length: 100

  The phone number of a user.
• restrictedUser: boolean
  Indicates that the user can only access records associated with the assigned company.
• status: string
  Maximum Length: 20

  Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE.
• title: string
  Maximum Length: 25

  The title of a user.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• userId: integer (int64)
  The system-generated identifier of a user.
• userName: string
  Minimum Length: 1

  Maximum Length: 255

  The identification used by a user to log in to the system.
• userProducts: array userProducts
  A list of all user product fields and values in the form of key value pairs.
• userSettings: array userSettings
  A list of all user setting fields and values in the form of key value pairs.

{
    "title":"ApiEntityExternallySourcedUser",
    "required":[
        "email",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastName":{
            "maxLength":"100",
            "type":"string",
            "description":"The last name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "mobile":{
            "maxLength":"100",
            "type":"string",
            "description":"The mobile phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "title":{
            "maxLength":"25",
            "type":"string",
            "description":"The title of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "phone":{
            "maxLength":"100",
            "type":"string",
            "description":"The phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "email":{
            "maxLength":"320",
            "type":"string",
            "description":"The email address of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "firstName":{
            "maxLength":"100",
            "type":"string",
            "description":"The first name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "maxLength":"20",
            "type":"string",
            "description":"Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The identification used by a user to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userSettings":{
            "type":"array",
            "description":"A list of all user setting fields and values in the form of key value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityApplicationUserSetting",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "userProducts":{
            "type":"array",
            "description":"A list of all user product fields and values in the form of key value pairs. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityUserProduct",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ldapGuid":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier in the external authentication system (LDAP or IDCS).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastLogInTime":{
            "type":"string",
            "description":"The date and time the user last logged into the application.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The company the user is associated with.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "restrictedUser":{
            "type":"boolean",
            "description":"Indicates that the user can only access records associated with the assigned company.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : userProducts

Type: array

A list of all user product fields and values in the form of key value pairs.

Show Source

• Array of: object ApiEntityUserProduct
  Title: ApiEntityUserProduct

{
    "type":"array",
    "description":"A list of all user product fields and values in the form of key value pairs. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserProduct",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : userSettings

Type: array

A list of all user setting fields and values in the form of key value pairs.

Show Source

• Array of: object ApiEntityApplicationUserSetting
  Title: ApiEntityApplicationUserSetting

{
    "type":"array",
    "description":"A list of all user setting fields and values in the form of key value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityApplicationUserSetting",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserProduct

Type: object

Title: ApiEntityUserProduct

Show Source

• applicationUserId: integer (int64)
  The system-generated unique identifier of a user.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• productId: integer (int64)
  The system-generated unique identifier of a license.
• productName: string
  Allowed Values: [ "SCHEDULE", "FIELD", "PORTFOLIO", "IDEA", "TASKS", "RISK", "PROGRESS" ]

  The name of the license.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• userProductId: integer (int64)
  The system-generated identifier for the user product.

{
    "title":"ApiEntityUserProduct",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "userProductId":{
            "type":"integer",
            "description":"The system-generated identifier for the user product.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "productId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a license.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "productName":{
            "type":"string",
            "description":"The name of the license.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SCHEDULE",
                "FIELD",
                "PORTFOLIO",
                "IDEA",
                "TASKS",
                "RISK",
                "PROGRESS"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityApplicationUserSetting

Type: object

Title: ApiEntityApplicationUserSetting

Show Source

• applicationUserId: integer (int64)
  The system-generated identifier of a user.
• applicationUserSettingId: integer (int64)
  The unique identifier of a user's settings.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• namespace: string
  Minimum Length: 1

  Maximum Length: 255

  The namespace to which a user is assigned.
• settingName: string
  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", "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.
• settingValue: string
  Minimum Length: 1

  Maximum Length: 4000

  The value of a user setting.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityApplicationUserSetting",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "namespace":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The namespace to which a user is assigned.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserSettingId":{
            "type":"integer",
            "description":"The unique identifier of a user's settings.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "type":"string",
            "description":"The name of a user setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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",
                "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"
            ]
        },
        "settingValue":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string",
            "description":"The value of a user setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested user does not exist, or you do not have access to it.

Back to Top