Skip to main content
POST
/
v1
/
user
/
create
Create user
curl --request POST \
  --url https://staging.api.us.aptlydone.com/auth/v1/user/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Torrey",
  "lastName": "Oberbrunner",
  "tenantId": "15ec13d1-a974-4324-9665-6747de598d98",
  "email": "[email protected]",
  "roleIds": [
    "f79e3041-9c1b-496d-a29a-047c0be53f97"
  ],
  "displayName": "Bert Gottlieb",
  "mobilePhone": "+1 (555) 123-4567",
  "groups": [
    {
      "groupId": "1556c12a-ad9d-41b8-98b8-f0440e2df71c",
      "isPrimaryOrg": true
    }
  ],
  "managerId": "ff395df6-a667-4382-8ba8-5c275353bce3",
  "positionIds": [
    "5008c1fc-968b-45da-b69e-5f522da4b40c"
  ],
  "employeeId": "5BiMH8Jk0g",
  "employeeNumber": "o8ufovd5CB",
  "employeeType": "Full-time",
  "employmentType": "Permanent",
  "sourceId": "SRC12345",
  "actorType": "Human",
  "aiAgentType": "Assistant",
  "startDate": "2024-01-01",
  "terminationDate": "2025-12-31",
  "customAttributes": {
    "department": "Engineering",
    "level": "Senior"
  },
  "externalId": "EXT12345",
  "instanceId": "059c5913-5ede-4c74-a788-e6117988092d",
  "systemIntegrationId": "f327fb4b-8b6b-4fb9-9be9-3095d5dc9964",
  "inviteViaEmail": true
}
'
{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:10:12.337Z",
  "message": "Success",
  "data": {
    "id": "d4b8eae5-02dc-4a9a-9afe-b2f72e006ebb",
    "userId": "10001",
    "loginId": "[email protected]",
    "descopeUserId": "7eOCsfn938mPjGwc5IZu4m5QAQWZS0xy",
    "activeTenantId": "3d4c3b64-f52d-4890-aa26-ea2e52eb5a4d",
    "email": "[email protected]",
    "name": "Vera Wolf",
    "displayName": "Brooke Rohan",
    "isSAML": false,
    "mobilePhone": "1-491-503-1712 x7659",
    "firstName": "Jolie",
    "lastName": "Morissette-Spencer",
    "profileImageUrl": "https://loremflickr.com/807/3278?lock=727001695474930",
    "currencyName": "Euro",
    "currencyCode": "EUR",
    "accountType": "h",
    "autoProvisioned": false,
    "employeeId": "f",
    "employeeNumber": "h",
    "employeeType": "D",
    "employmentType": "j",
    "userType": "z",
    "sourceId": "LaTdLstQ4lRlowebEqMq",
    "actorType": "khOhlolFNb",
    "aiAgentType": "XwUPLzjRvaLBsCG",
    "startDate": "2025-11-19T05:27:09.941Z",
    "terminationDate": "2026-10-16T18:32:34.796Z",
    "customAttributes": {
      "department": "Engineering",
      "level": "Senior"
    },
    "externalId": "EXT12345",
    "instanceId": "6a5dd288-ec68-44ff-a1ce-b0128347b3b6",
    "systemIntegrationId": "6e94c7f7-576d-48ed-8cc0-b8b09f56cba8",
    "displayLanguage": "en-US",
    "columnViewSettings": {
      "columns": [
        "name",
        "email",
        "status"
      ]
    },
    "searchData": [
      "Directives",
      "Liaison"
    ],
    "managerSync": true,
    "manager": {
      "id": "f99a50c1-f10a-47ee-a20d-8792e1a41be8",
      "userId": "10001",
      "descopeUserId": "NAe2gVjONZqYRgtvliF3pyKmPchGcHXg",
      "name": "Mr. Ivan Thiel",
      "email": "[email protected]",
      "firstName": "Adan",
      "lastName": "Johnston",
      "displayName": "Lucia Mayert",
      "mobilePhone": "(270) 663-0245 x3376",
      "profileImageUrl": "https://picsum.photos/seed/46GUUknbGJ/2329/2262",
      "createdOn": "2026-01-12T05:07:05.101Z",
      "updatedOn": "2026-01-12T03:30:03.871Z",
      "userPositions": [
        {
          "id": "64648e27-e093-44c3-b5a1-49154a0a1660",
          "userId": "898bf847-18c5-4022-b4be-6035aa06877f",
          "tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
          "positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
          "autoProvisioned": true,
          "instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
          "isEditable": false,
          "isDeleted": true,
          "deletedOn": "2025-08-19T23:46:35.207Z",
          "createdOn": "2026-01-11T12:03:07.517Z",
          "updatedOn": "2026-01-11T19:28:18.878Z",
          "positionName": "Senior Developer",
          "isSCIMProvisioned": false,
          "externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
        }
      ],
      "primaryOrganization": {
        "groupName": "Aplty Inc.",
        "displayName": "Aplty Incorporated",
        "tenantGroupTypeId": "03cf8779-7be8-4ea9-a02e-99aa4454e94a",
        "tenantGroupTypeName": "Organization"
      },
      "managerName": "Doris Brakus",
      "managerProfileImageUrl": "https://loremflickr.com/567/2473?lock=5385426157985712"
    },
    "isDeleted": true,
    "isExpirePassword": true,
    "createdOn": "2026-01-12T04:59:38.064Z",
    "lastLoginDate": "2026-01-11T09:45:20.832Z",
    "createdBy": "56dbdb67-fdb4-478c-bb02-cea7b3e899ec",
    "updatedOn": "2026-01-11T11:57:54.376Z",
    "updatedBy": "f6267b64-ddad-4db5-ab64-b587d49af1b6",
    "deletedOn": "2025-01-27T10:51:41.196Z",
    "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": "320bf21d-7b31-4b31-93ef-1a2e9f93f8a9",
        "tenantId": "8fcca66f-5b95-4f54-a8fd-b1c27dd092ef",
        "tenantRoleId": "9c9bd186-23f1-4f5f-877f-b25aad685652",
        "roleName": "pine begonia",
        "autoProvisioned": false,
        "instanceId": "5863ab84-7099-4ac2-8b48-f24f1b21b4a3",
        "createdOn": "2026-01-11T22:33:40.204Z",
        "deletedOn": "2025-05-31T10:27:33.998Z",
        "updatedOn": "2026-01-12T03:25:36.185Z"
      }
    ],
    "userPositions": [
      {
        "id": "64648e27-e093-44c3-b5a1-49154a0a1660",
        "userId": "898bf847-18c5-4022-b4be-6035aa06877f",
        "tenantId": "4f1cd86e-c077-4acc-b242-09478ad3ec79",
        "positionsId": "d2e8b360-686c-4e2c-a788-5ca9d7fc3daa",
        "autoProvisioned": true,
        "instanceId": "14120202-09d5-4b50-b522-b41d0821f7d0",
        "isEditable": false,
        "isDeleted": true,
        "deletedOn": "2025-08-19T23:46:35.207Z",
        "createdOn": "2026-01-11T12:03:07.517Z",
        "updatedOn": "2026-01-11T19:28:18.878Z",
        "positionName": "Senior Developer",
        "isSCIMProvisioned": false,
        "externalId": "f143825c-798e-43bb-8f88-da1ff0d8b399"
      }
    ],
    "userGroups": [
      {
        "id": "77827dfa-cf21-4fec-a5bd-c568d9583431",
        "tenantId": "277ab493-cb1d-40f3-8d61-6432cc78df9a",
        "userId": "0e2a3c9d-3210-4e98-9dcc-67e8f63305c1",
        "groupId": "2b0e14b4-2d70-4517-afc3-9ba10bb890c2",
        "groupTypeId": "40471fbe-5866-486d-9f76-c96482e42277",
        "groupName": "Engineering Team",
        "groupTypeName": "Department",
        "displayName": "Engineering Department",
        "isPrimaryOrg": false,
        "externalId": "0802fdf7-09f2-4445-9e7c-3fc145cbf544",
        "instanceId": "c024da14-f39b-4aa5-9be8-6003132f6c71",
        "primaryOrgSetOn": "2026-01-11T23:45:02.944Z",
        "autoProvisioned": true,
        "isDeleted": true,
        "deletedOn": "2025-06-16T09:06:25.957Z",
        "createdOn": "2026-01-11T10:22:54.670Z",
        "updatedOn": "2026-01-11T18:31:52.005Z"
      }
    ],
    "status": "ACTIVE",
    "dateFormat": "MM/DD/YYYY",
    "isImpersonated": true
  }
}

Authorizations

ā€‹
Authorization
string
header
required

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

Body

application/json
ā€‹
firstName
string
required

User first name

Maximum string length: 50
Example:

"Torrey"

ā€‹
lastName
string
required

User last name

Maximum string length: 50
Example:

"Oberbrunner"

ā€‹
tenantId
string
required

Tenant ID

Example:

"15ec13d1-a974-4324-9665-6747de598d98"

ā€‹
email
string<email>
required

User email address

Example:

"[email protected]"

ā€‹
roleIds
string[]
required

Array of role IDs

Example:
["f79e3041-9c1b-496d-a29a-047c0be53f97"]
ā€‹
displayName
string

Display name

Maximum string length: 50
Example:

"Bert Gottlieb"

ā€‹
mobilePhone
string

Mobile phone

Maximum string length: 25
Pattern: /^[+()0-9.\s-]{7,25}$/
Example:

"+1 (555) 123-4567"

ā€‹
groups
object[]

User groups

Example:
[
  {
    "groupId": "1556c12a-ad9d-41b8-98b8-f0440e2df71c",
    "isPrimaryOrg": true
  }
]
ā€‹
managerId
string<uuid>

Manager ID

Example:

"ff395df6-a667-4382-8ba8-5c275353bce3"

ā€‹
positionIds
string<uuid>[]

Array of position IDs

Example:
["5008c1fc-968b-45da-b69e-5f522da4b40c"]
ā€‹
employeeId
string

Employee ID

Maximum string length: 50
Example:

"5BiMH8Jk0g"

ā€‹
employeeNumber
string

Employee Number

Maximum string length: 50
Example:

"o8ufovd5CB"

ā€‹
employeeType
string

Employee Type

Maximum string length: 20
Example:

"Full-time"

ā€‹
employmentType
string

Employment Type

Maximum string length: 20
Example:

"Permanent"

ā€‹
sourceId
string

Source ID

Maximum string length: 100
Example:

"SRC12345"

ā€‹
actorType
string

Actor type

Maximum string length: 50
Example:

"Human"

ā€‹
aiAgentType
string

AI agent type

Maximum string length: 50
Example:

"Assistant"

ā€‹
startDate
string<date-time>

Start date

Example:

"2024-01-01"

ā€‹
terminationDate
string<date-time>

Termination date

Example:

"2025-12-31"

ā€‹
customAttributes
object

Custom attributes

Example:
{
  "department": "Engineering",
  "level": "Senior"
}
ā€‹
externalId
string

External ID

Maximum string length: 100
Example:

"EXT12345"

ā€‹
instanceId
string

Instance ID

Example:

"059c5913-5ede-4c74-a788-e6117988092d"

ā€‹
systemIntegrationId
string<uuid>

System Integration ID

Example:

"f327fb4b-8b6b-4fb9-9be9-3095d5dc9964"

ā€‹
inviteViaEmail
boolean

Whether to send invitation email

Example:

true

Response

201 - application/json

User created successfully

ā€‹
statusCode
number
required

HTTP Status code

Example:

200

ā€‹
timestamp
string
required

Timestamp of the response

Example:

"2026-01-12T09:10:12.337Z"

ā€‹
message
string
required

Response message

Example:

"Success"

ā€‹
data
object
required

Response data