---
title: "Create user"
method: POST
path: "/Users"
tags: ["Users"]
---

# Create user

`POST /Users`

## Request

- Base URL: `https://api.peakon.com/api/scim/v2`
- URL: `https://api.peakon.com/api/scim/v2/Users`
- Auth: none declared

## Request body

- User
  - `active` boolean: user status
  - `addresses` Address[]
    - `country` string
    - `locality` string
    - `postalCode` string
    - `region` string
    - `streetAddress` string
    - `type` 'work', required
  - `emails` Email[], required
    - `type` 'work', required
    - `value` string, required
  - `externalId` string: external unique resource id defined by provisioning client
  - `id` string: unique resource id
  - `name` Name, required
    - `familyName` string, required
    - `givenName` string, required
  - `phoneNumbers` PhoneNumber[]
    - `type` 'work' | 'mobile' | 'other', required
    - `value` string, required
  - `photos` Photo[]
    - `type` 'photo', required
    - `value` string, required
  - `schemas` string[], required
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` EnterpriseUser
    - `department` string
  - `userName` string, required: MUST be same as work type email address

## Response `201`

successfully created user

- UserResponse
  - `active` boolean: user status
  - `addresses` Address[]
    - `country` string
    - `locality` string
    - `postalCode` string
    - `region` string
    - `streetAddress` string
    - `type` 'work', required
  - `emails` Email[], required
    - `type` 'work', required
    - `value` string, required
  - `externalId` string: external unique resource id defined by provisioning client
  - `id` string: unique resource id
  - `name` Name, required
    - `familyName` string, required
    - `givenName` string, required
  - `phoneNumbers` PhoneNumber[]
    - `type` 'work' | 'mobile' | 'other', required
    - `value` string, required
  - `photos` Photo[]
    - `type` 'photo', required
    - `value` string, required
  - `schemas` string[], required
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` EnterpriseUser
    - `department` string
  - `userName` string, required: MUST be same as work type email address
  - `meta` Meta: resource metadata
    - `created` string, date-time
    - `lastModified` string, date-time
    - `location` string: resource location URI
    - `resourceType` 'User' | 'Group'

## Other responses

- `400`: bad request
- `401`: authorization failure
- `403`: permissions denied
- `404`: not found
- `409`: duplicate email
- `429`: too many requests
- `500`: internal server error

---

[API](https://skmtc.dev/peakon/apis/scim-2-0-api.md) - [All operations](https://skmtc.dev/peakon/apis/scim-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/peakon/apis/scim-2-0-api/revisions/4bddb3795891?raw)