Skip to main content
PATCH
/
v1
/
user
/
update-entities
/
{id}
Update user entities
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/auth/v1/user/update-entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "6b18cf9a-be1e-4e24-863a-63d8ab01a9f2",
  "managerId": "58f167b8-3b2d-490c-842c-8dae12eef6dc",
  "roleIds": [
    "42142fc6-a273-454e-a1e4-d59f91c70511",
    "ecbe50b4-ad21-4a37-8272-4d29d002669c"
  ],
  "positionIds": [
    "3d322c46-b754-4ea9-9887-056252a1fc36",
    "f2f4c945-92a7-4d79-988d-97c4f8c7d42c"
  ],
  "groups": [
    {
      "groupId": "524c647d-339d-4189-aebd-b978b563d3dc",
      "isPrimaryOrg": true
    }
  ],
  "email": "[email protected]",
  "name": "Myra Kessler",
  "firstName": "Guadalupe",
  "lastName": "Okuneva",
  "accountType": "L",
  "userType": "s",
  "employeeId": "z",
  "employeeType": "IKMdzuJWxl",
  "mobilePhone": "+1 (555) 123-4567",
  "profileImageUrl": "https://picsum.photos/seed/9IjLKcx6D/2969/1924",
  "currencyCode": "USD",
  "currencyName": "US Dollars",
  "status": "ACTIVE",
  "dateFormat": "MM/DD/YYYY"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-25T06:16:48.664Z",
  "message": "Success",
  "data": {
    "id": "6a7d8103-8d39-4fb4-a45e-f4607b5b8476",
    "userId": "10001",
    "loginId": "[email protected]",
    "descopeUserId": "vSGCt98kT7cX2Gawb2dWFkpgQ6VZaxrI",
    "activeTenantId": "2f97d5b9-1736-4b04-b2cf-18d7314c2c6d",
    "email": "[email protected]",
    "name": "Donna Hermiston III",
    "isSAML": false,
    "mobilePhone": "272-535-5085",
    "firstName": "Chelsea",
    "lastName": "Witting",
    "profileImageUrl": "https://picsum.photos/seed/ixDck/3063/974",
    "currencyName": "Euro",
    "currencyCode": "EUR",
    "status": "ACTIVE",
    "accountType": "C",
    "autoProvisioned": false,
    "employeeId": "Q",
    "employeeType": "U",
    "dateFormat": "MM/DD/YYYY",
    "userType": "y",
    "searchData": [
      "Usability",
      "Developer"
    ],
    "managerSync": true,
    "manager": {
      "id": "d5dc4dd9-bf15-4992-b6ef-4372a3ff3ed3",
      "userId": "10001",
      "descopeUserId": "HGPusnGo7LY225bob0Tg2sNbVPBFLO8T",
      "name": "Jaime Wiza",
      "email": "[email protected]",
      "firstName": "Elian",
      "lastName": "Reinger",
      "mobilePhone": "859-503-6233 x95670",
      "profileImageUrl": "https://loremflickr.com/429/3636?lock=5343508147167765",
      "createdOn": "2025-06-25T04:31:23.563Z",
      "updatedOn": "2025-06-24T17:20:32.235Z",
      "userPositions": [
        {
          "id": "1b639583-b421-439f-9bbc-e909aa78126e",
          "userId": "86e26861-524b-4d36-94c6-70a70726add9",
          "tenantId": "62c0e2b7-259d-4692-9f3d-3655665366c2",
          "positionsId": "54256ae5-3c62-4447-adf8-3e3cc6612a99",
          "autoProvisioned": false,
          "isEditable": false,
          "isDeleted": true,
          "deletedOn": "2024-10-28T09:18:34.656Z",
          "createdOn": "2025-06-24T15:29:46.577Z",
          "updatedOn": "2025-06-24T20:18:43.389Z",
          "positionName": "Senior Developer",
          "isSCIMProvisioned": false
        }
      ],
      "primaryOrganization": {
        "groupName": "Aplty Inc.",
        "tenantGroupTypeId": "b135555e-0520-482b-bfbf-8429c293c268",
        "tenantGroupTypeName": "Organization"
      },
      "managerName": "Fannie Lueilwitz",
      "managerProfileImageUrl": "https://loremflickr.com/1810/1701?lock=3094412370077509"
    },
    "isDeleted": false,
    "isExpirePassword": false,
    "createdOn": "2025-06-25T01:27:29.403Z",
    "lastLoginDate": "2025-06-24T15:29:15.070Z",
    "createdBy": "5ec51c50-09c5-4bd3-9a4e-240903b20e68",
    "updatedOn": "2025-06-24T07:10:37.466Z",
    "updatedBy": "2480599d-bd76-4c73-a107-e6513bf8b54f",
    "deletedOn": "2024-10-01T20:34:39.873Z",
    "delegationsReceived": 1,
    "delegationsIssued": 1,
    "dashboardData": [
      {
        "x": 0,
        "y": 0,
        "w": 2,
        "h": 1,
        "i": "0"
      },
      {
        "x": 0,
        "y": 1,
        "w": 2,
        "h": 4,
        "i": "1"
      },
      {
        "x": 0,
        "y": 5,
        "w": 1,
        "h": 4,
        "i": "2"
      },
      {
        "x": 1,
        "y": 5,
        "w": 1,
        "h": 4,
        "i": "3"
      }
    ],
    "userRoles": [
      {
        "id": "340314db-0571-4a85-9296-8ccea2d5ff90",
        "tenantId": "a2f84c63-2056-46c8-a975-5fc22efa5060",
        "tenantRoleId": "a1729a44-15d6-4976-b3a5-c4dceff45835",
        "roleName": "heartache harmful",
        "autoProvisioned": true,
        "createdOn": "2025-06-25T04:31:42.785Z",
        "deletedOn": "2025-05-05T01:45:20.777Z",
        "updatedOn": "2025-06-25T02:53:18.799Z"
      }
    ],
    "userPositions": [
      {
        "id": "1b639583-b421-439f-9bbc-e909aa78126e",
        "userId": "86e26861-524b-4d36-94c6-70a70726add9",
        "tenantId": "62c0e2b7-259d-4692-9f3d-3655665366c2",
        "positionsId": "54256ae5-3c62-4447-adf8-3e3cc6612a99",
        "autoProvisioned": false,
        "isEditable": false,
        "isDeleted": true,
        "deletedOn": "2024-10-28T09:18:34.656Z",
        "createdOn": "2025-06-24T15:29:46.577Z",
        "updatedOn": "2025-06-24T20:18:43.389Z",
        "positionName": "Senior Developer",
        "isSCIMProvisioned": false
      }
    ],
    "userGroups": [
      {
        "id": "0babd381-2af5-4bf7-ac1c-0230f25cf088",
        "tenantId": "1eb866a0-2a81-4d3f-9831-6b4e9f4e633d",
        "userId": "0e1b099f-2e52-4307-8860-89314ef97dbb",
        "groupId": "3cad0e27-f8f0-4a96-9bbb-1fae4f9fb04f",
        "groupTypeId": "9a366bfc-7810-4d0f-a482-ed0cd09c6c15",
        "groupName": "Engineering Team",
        "groupTypeName": "Department",
        "isPrimaryOrg": false,
        "primaryOrgSetOn": "2025-06-24T11:18:20.853Z",
        "autoProvisioned": true,
        "isDeleted": true,
        "deletedOn": "2025-05-17T06:57:51.956Z",
        "createdOn": "2025-06-24T10:25:28.539Z",
        "updatedOn": "2025-06-24T21:38:00.944Z"
      }
    ],
    "isImpersonated": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
tenantId
string<uuid>
required

Tenant ID

Example:

"6b18cf9a-be1e-4e24-863a-63d8ab01a9f2"

​
managerId
string<uuid>

User manager ID

Example:

"58f167b8-3b2d-490c-842c-8dae12eef6dc"

​
roleIds
string<uuid>[]

User roles IDs

Example:
[
  "42142fc6-a273-454e-a1e4-d59f91c70511",
  "ecbe50b4-ad21-4a37-8272-4d29d002669c"
]
​
positionIds
string<uuid>[]

User positions IDs

Example:
[
  "3d322c46-b754-4ea9-9887-056252a1fc36",
  "f2f4c945-92a7-4d79-988d-97c4f8c7d42c"
]
​
groups
object[]

User groups

Example:
[
  {
    "groupId": "524c647d-339d-4189-aebd-b978b563d3dc",
    "isPrimaryOrg": true
  }
]
​
email
string<email>

Email address

Maximum length: 100
Example:

"[email protected]"

​
name
string

Full name

Maximum length: 50
Example:

"Myra Kessler"

​
firstName
string

First name

Maximum length: 50
Example:

"Guadalupe"

​
lastName
string

Last name

Maximum length: 20
Example:

"Okuneva"

​
accountType
string

Type of account

Maximum length: 20
Example:

"L"

​
userType
string

Type of user

Maximum length: 20
Example:

"s"

​
employeeId
string

Employee ID

Example:

"z"

​
employeeType
string

Type of employment

Maximum length: 20
Example:

"IKMdzuJWxl"

​
mobilePhone
string

Mobile phone

Maximum length: 25
Example:

"+1 (555) 123-4567"

​
profileImageUrl
string

User profile image URL

Maximum length: 50
Example:

"https://picsum.photos/seed/9IjLKcx6D/2969/1924"

​
currencyCode
string

Display currency Code

Example:

"USD"

​
currencyName
string

Display currency Name

Example:

"US Dollars"

​
status
enum<string>

User status

Available options:
ACTIVE,
INACTIVE,
INVITED,
DELETED
Example:

"ACTIVE"

​
dateFormat
string

Date format preference

Example:

"MM/DD/YYYY"

Response

200 - application/json

User details and entities updated successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-25T06:16:48.664Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data