---
title: "Create user"
method: POST
path: "/scim/{connection_id}/users"
tags: ["scim", "user"]
---

# Create user

`POST /scim/{connection_id}/users`

## Path parameters

- `connection_id` string, required

## Query parameters

- `filter` string
- `sortBy` string
- `sortOrder` string
- `startIndex` number
- `count` number

## Request body

- ScimUser
  - `id` string
  - `schemas` string[]
  - `externalId` string
  - `userType` string
  - `userName` string
  - `meta` PropertyScimUserMeta
    - `resourceType` 'User' | 'Group'
    - `created` string
    - `lastModified` string
    - `location` string
    - `version` string
  - `name` PropertyScimUserName
    - `formatted` string
    - `familyName` string
    - `givenName` string
    - `middleName` string
    - `honorificPrefix` string
    - `honorificSuffix` string
  - `displayName` string
  - `nickName` string
  - `profileUrl` string
  - `title` string
  - `preferredLanguage` string
  - `locale` string
  - `timezone` string
  - `active` boolean
  - `password` string
  - `phoneNumbers` ScimPhoneNumber[]
    - `type` 'work' | 'home' | 'other' | 'mobile' | 'fax' | 'pager'
    - `value` string
    - `display` string
    - `primary` boolean
  - `emails` ScimEmail[]
    - `type` 'work' | 'home' | 'other', required
    - `value` string
    - `primary` boolean
    - `display` string
  - `ims` ScimIms[]
    - `type` 'aim' | 'qtalk' | 'icq' | 'xmpp' | 'msn' | 'skype' | 'qq' | 'yahoo'
    - `value` string
    - `display` string
    - `primary` boolean
  - `photos` ScimPhoto[]
    - `value` string
    - `display` string
    - `type` 'photo' | 'thumbnail'
    - `primary` boolean
  - `addresses` ScimAddress[]
    - `formatted` string
    - `streetAddress` string
    - `locality` string
    - `region` string
    - `postalCode` string
    - `country` string
    - `type` 'work' | 'home' | 'other'
  - `groups` ScimUserGroups[]
    - `value` string, required
    - `$ref` string
    - `display` string
    - `type` 'direct' | 'indirect'
  - `entitlements` ScimEntitlement[]
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `roles` ScimRole[] — Student, Faculty, ...
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `x509Certificates` ScimRole[]
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionEnterprise20User — an organization.
    - `employeeNumber` string
    - `costCenter` string
    - `organization` string
    - `division` string
    - `department` string
    - `manager` PropertyScimUserUrnIetfParamsScimSchemasExtensionEnterprise20UserManager — "id" attribute of another User.
      - `value` string
      - `managerId` string
      - `$ref` string
      - `displayName` string
      - `type` 'direct' | 'indirect'
    - `additionalManagers` ScimManager[]
      - `value` string
      - `managerId` string
      - `$ref` string
      - `displayName` string
      - `type` 'direct' | 'indirect'
    - `level` string
    - `startDate` string, date-time
    - `endDate` string, date-time
    - `birthday` string, date-time
    - `gender` 'male' | 'female'
    - `location` string
    - `currency` string
  - `urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionLatticeAttributes10User
    - `startDate` string, date-time
    - `birthDate` string, date-time
    - `gender` 'male' | 'female'
    - `sexualOrientation` 'Queer' | 'Heterosexual' | 'Straight'
    - `ethnicity` 'Caucasian' | 'East Asian' | 'Middle Eastern' | 'Black' | 'Biracial (South Asian & Caucasian)' | 'Filipino' | 'South Asian' | 'Indian' | 'White' | 'Asian'
    - `People Manager (Reviews)` string
    - `Salary Information` string
    - `Remote Work - Location` string
    - `Job Level` string
    - `Sub Departments` string
  - `urn:ietf:params:scim:schemas:extension:peakon:2.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionPeakon20User
    - `Gender` 'Female' | 'Male'
    - `Team` string
    - `Manager` string
    - `Date of Birth` string, date-time

## Response `200`

Successful

- ScimUser
  - `id` string
  - `schemas` string[]
  - `externalId` string
  - `userType` string
  - `userName` string
  - `meta` PropertyScimUserMeta
    - `resourceType` 'User' | 'Group'
    - `created` string
    - `lastModified` string
    - `location` string
    - `version` string
  - `name` PropertyScimUserName
    - `formatted` string
    - `familyName` string
    - `givenName` string
    - `middleName` string
    - `honorificPrefix` string
    - `honorificSuffix` string
  - `displayName` string
  - `nickName` string
  - `profileUrl` string
  - `title` string
  - `preferredLanguage` string
  - `locale` string
  - `timezone` string
  - `active` boolean
  - `password` string
  - `phoneNumbers` ScimPhoneNumber[]
    - `type` 'work' | 'home' | 'other' | 'mobile' | 'fax' | 'pager'
    - `value` string
    - `display` string
    - `primary` boolean
  - `emails` ScimEmail[]
    - `type` 'work' | 'home' | 'other', required
    - `value` string
    - `primary` boolean
    - `display` string
  - `ims` ScimIms[]
    - `type` 'aim' | 'qtalk' | 'icq' | 'xmpp' | 'msn' | 'skype' | 'qq' | 'yahoo'
    - `value` string
    - `display` string
    - `primary` boolean
  - `photos` ScimPhoto[]
    - `value` string
    - `display` string
    - `type` 'photo' | 'thumbnail'
    - `primary` boolean
  - `addresses` ScimAddress[]
    - `formatted` string
    - `streetAddress` string
    - `locality` string
    - `region` string
    - `postalCode` string
    - `country` string
    - `type` 'work' | 'home' | 'other'
  - `groups` ScimUserGroups[]
    - `value` string, required
    - `$ref` string
    - `display` string
    - `type` 'direct' | 'indirect'
  - `entitlements` ScimEntitlement[]
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `roles` ScimRole[] — Student, Faculty, ...
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `x509Certificates` ScimRole[]
    - `value` string, required
    - `display` string
    - `type` string
    - `primary` boolean
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionEnterprise20User — an organization.
    - `employeeNumber` string
    - `costCenter` string
    - `organization` string
    - `division` string
    - `department` string
    - `manager` PropertyScimUserUrnIetfParamsScimSchemasExtensionEnterprise20UserManager — "id" attribute of another User.
      - `value` string
      - `managerId` string
      - `$ref` string
      - `displayName` string
      - `type` 'direct' | 'indirect'
    - `additionalManagers` ScimManager[]
      - `value` string
      - `managerId` string
      - `$ref` string
      - `displayName` string
      - `type` 'direct' | 'indirect'
    - `level` string
    - `startDate` string, date-time
    - `endDate` string, date-time
    - `birthday` string, date-time
    - `gender` 'male' | 'female'
    - `location` string
    - `currency` string
  - `urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionLatticeAttributes10User
    - `startDate` string, date-time
    - `birthDate` string, date-time
    - `gender` 'male' | 'female'
    - `sexualOrientation` 'Queer' | 'Heterosexual' | 'Straight'
    - `ethnicity` 'Caucasian' | 'East Asian' | 'Middle Eastern' | 'Black' | 'Biracial (South Asian & Caucasian)' | 'Filipino' | 'South Asian' | 'Indian' | 'White' | 'Asian'
    - `People Manager (Reviews)` string
    - `Salary Information` string
    - `Remote Work - Location` string
    - `Job Level` string
    - `Sub Departments` string
  - `urn:ietf:params:scim:schemas:extension:peakon:2.0:User` PropertyScimUserUrnIetfParamsScimSchemasExtensionPeakon20User
    - `Gender` 'Female' | 'Male'
    - `Team` string
    - `Manager` string
    - `Date of Birth` string, date-time

---

[API](https://skmtc.net/unified/apis/unified-to-api.md) · [All operations](https://skmtc.net/unified/apis/unified-to-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unified/unified-to-api/versions/1f72720916e4/schema)