REST API - Accessing Users

Version 2

    The REST API provides retrieve operations for accessing users in your install.

     

    Accessing Users

    • GET  /system/user/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "User",
      "id": "9",
      "createdAt": "1260902519",
      "createdBy": "8",
      "depth": "complete",
      "description": "Fred.Sakr",
      "name": "Fred.Sakr",
      "updatedAt": "1353524228",
      "updatedBy": "9",
      "betaAccess": [
        "chatter_inside",
        "sfdc_sso",
        "sfdcidp",
      ],
      "capabilities": [
        "manageStrictWebTracking",
        "mailer.updateContacts"
      ],
      "company": "OrionTest",
      "defaultAccountViewId": "100124",
      "defaultContactViewId": "100084",
      "emailAddress": "fred.sakr@eloqua.com",
      "interfacePermissions": [
        {
          "type": "InterfacePermission",
          "interfaceCode": "campaigns",
          "nestedInterfacePermissions": [
            {
              "type": "InterfacePermission",
              "interfaceCode": "campaigns",
              "nestedInterfacePermissions": [
                {
                  "type": "InterfacePermission",
                  "interfaceCode": "campaigns"
                }
              ]
            }
          ]
        },
      ],
      "loggedInAt": "1354542075",
      "loginName": "Orion.Full",
      "preferences": {
        "type": "UserPreferences",
        "isMasterViewDocked": "false",
        "timezoneId": "64"
      },
      "productPermissions": [
        {
          "type": "ProductPermission",
          "productCode": "EngageiPad"
        },
        {
          "type": "ProductPermission",
          "productCode": "EngageWeb"
        }
      ],
      "typePermissions": [
        {
          "type": "TypePermission",
          "objectType": "Campaign",
          "permissions": {
            "type": "TypePermissions",
            "create": "true",
            "read": "true"
          }
        },
        {
          "type": "TypePermission",
          "objectType": "Email",
          "permissions": {
            "type": "TypePermissions",
            "create": "true",
            "read": "true"
          }
        }
      ]
    }
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"User"
    betaAccessList of string
    capabilitiesList of string
    companystring
    defaultAccountViewIdintegerIdRequirement
    defaultContactViewIdintegerIdRequirement
    emailAddressstringEmailAddress
    Requirement
    interfacePermissionsList of Interface
    Permission
    loggedInAtstring
    loginNamestring
    preferencesUserPreferences
    productPermissionsList of Product
    Permission
    typePermissionsList of TypePermission
    accessedAtintegerDateRequirement
    createdAtintegerRead
    Only
    DateRequirement
    createdByintegerRead
    Only
    IdRequirement
    currentStatusstring
    depthRequestDepthEnumRequirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique identifier for this userIdRequirement
    namestring
    permissionsInstance
    Permissions
    EnumRequirement
    scheduledForintegerDateRequirement
    sourceTemplateIdstring
    updatedAtintegerRead
    Only
    DateRequirement
    updatedByintegerRead
    Only
    IdRequirement

     

    Related Operations

    • GET  /system/users?search={search}&depth={depth}&page={page}&count={count}&orderBy={orderBy}