# POST /api/identity/users

Create new user

Creates a new user account with the specified details and roles.

**Operation ID:** `userCreate`

## Authorization

Requires: AbpIdentity.Users, AbpIdentity.Users.Create, host scope.

Required permissions:
- `AbpIdentity.Users`
- `AbpIdentity.Users.Create`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The input parameters for the new user.

**Content type:** `application/json`

Schema: `IdentityUserCreateDto`

Properties:
- `userName` (string) required
- `name` (string): The user's first name. Optional.
- `surname` (string): The user's last name. Optional.
- `email` (string(email)) required
- `phoneNumber` (string): The user's phone number. Optional.
- `isActive` (boolean)
- `shouldChangePasswordOnNextLogin` (boolean)
- `lockoutEnabled` (boolean)
- `roleNames` (array<string>): The names of the roles to assign to the user. Optional.
- `organizationUnitIds` (array<string(uuid)>): The ids of the organization units the user belongs to. Optional.
- `userType` (object) required
- `resellerId` (string(uuid))
- `merchantIds` (array<string(uuid)>)
- `password` (string) required
- `sendConfirmationEmail` (boolean)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `createFacadeApiKey` (boolean): When true, mints a standing API key for the new user as part of creating them.

_Example: Reseller User_

Reseller-scope user bound to a specific reseller via the ResellerId extra property. Can manage merchants under that reseller hierarchy. Replace ResellerId with the real id from your reseller create response.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [ ],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}
```

_Example: Merchant User (Multi-Merchant Access)_

Merchant-scope user bound to one or more merchants via the MerchantIds extra property. Use a single-element array for single-merchant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "merchant-user"
  ],
  "organizationUnitIds": [ ],
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001",
    "00000000-0000-0000-0000-000000000002"
  ]
}
```

_Example: Merchant User (Required Fields Only)_

The smallest create the endpoint accepts: user name, email, password, user type, and the merchant the user is scoped to. Name, surname, phone number, roleNames and organizationUnitIds are omitted, so the user is stored with no first or last name, no phone number, no roles and no organization unit memberships. Update the user with roleNames to grant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "userName": "merchant.minimal",
  "email": "merchant.minimal@example.com",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

**Content type:** `text/json`

Schema: `IdentityUserCreateDto`

Properties:
- `userName` (string) required
- `name` (string): The user's first name. Optional.
- `surname` (string): The user's last name. Optional.
- `email` (string(email)) required
- `phoneNumber` (string): The user's phone number. Optional.
- `isActive` (boolean)
- `shouldChangePasswordOnNextLogin` (boolean)
- `lockoutEnabled` (boolean)
- `roleNames` (array<string>): The names of the roles to assign to the user. Optional.
- `organizationUnitIds` (array<string(uuid)>): The ids of the organization units the user belongs to. Optional.
- `userType` (object) required
- `resellerId` (string(uuid))
- `merchantIds` (array<string(uuid)>)
- `password` (string) required
- `sendConfirmationEmail` (boolean)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `createFacadeApiKey` (boolean): When true, mints a standing API key for the new user as part of creating them.

_Example: Reseller User_

Reseller-scope user bound to a specific reseller via the ResellerId extra property. Can manage merchants under that reseller hierarchy. Replace ResellerId with the real id from your reseller create response.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [ ],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}
```

_Example: Merchant User (Multi-Merchant Access)_

Merchant-scope user bound to one or more merchants via the MerchantIds extra property. Use a single-element array for single-merchant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "merchant-user"
  ],
  "organizationUnitIds": [ ],
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001",
    "00000000-0000-0000-0000-000000000002"
  ]
}
```

_Example: Merchant User (Required Fields Only)_

The smallest create the endpoint accepts: user name, email, password, user type, and the merchant the user is scoped to. Name, surname, phone number, roleNames and organizationUnitIds are omitted, so the user is stored with no first or last name, no phone number, no roles and no organization unit memberships. Update the user with roleNames to grant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "userName": "merchant.minimal",
  "email": "merchant.minimal@example.com",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

**Content type:** `application/*+json`

Schema: `IdentityUserCreateDto`

Properties:
- `userName` (string) required
- `name` (string): The user's first name. Optional.
- `surname` (string): The user's last name. Optional.
- `email` (string(email)) required
- `phoneNumber` (string): The user's phone number. Optional.
- `isActive` (boolean)
- `shouldChangePasswordOnNextLogin` (boolean)
- `lockoutEnabled` (boolean)
- `roleNames` (array<string>): The names of the roles to assign to the user. Optional.
- `organizationUnitIds` (array<string(uuid)>): The ids of the organization units the user belongs to. Optional.
- `userType` (object) required
- `resellerId` (string(uuid))
- `merchantIds` (array<string(uuid)>)
- `password` (string) required
- `sendConfirmationEmail` (boolean)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `createFacadeApiKey` (boolean): When true, mints a standing API key for the new user as part of creating them.

_Example: Reseller User_

Reseller-scope user bound to a specific reseller via the ResellerId extra property. Can manage merchants under that reseller hierarchy. Replace ResellerId with the real id from your reseller create response.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [ ],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}
```

_Example: Merchant User (Multi-Merchant Access)_

Merchant-scope user bound to one or more merchants via the MerchantIds extra property. Use a single-element array for single-merchant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "merchant-user"
  ],
  "organizationUnitIds": [ ],
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001",
    "00000000-0000-0000-0000-000000000002"
  ]
}
```

_Example: Merchant User (Required Fields Only)_

The smallest create the endpoint accepts: user name, email, password, user type, and the merchant the user is scoped to. Name, surname, phone number, roleNames and organizationUnitIds are omitted, so the user is stored with no first or last name, no phone number, no roles and no organization unit memberships. Update the user with roleNames to grant access.

```json
{
  "password": "P@ssw0rd!ChangeMe",
  "userName": "merchant.minimal",
  "email": "merchant.minimal@example.com",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `IdentityUserDto`

Properties:
- `extraProperties` (object)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity.
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified.
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity.
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted.
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted.
- `tenantId` (string(uuid))
- `userName` (string) required
- `email` (string) required
- `name` (string) required
- `surname` (string) required
- `emailConfirmed` (boolean)
- `phoneNumber` (string)
- `phoneNumberConfirmed` (boolean)
- `supportTwoFactor` (boolean)
- `twoFactorEnabled` (boolean)
- `isActive` (boolean)
- `lockoutEnabled` (boolean)
- `isLockedOut` (boolean)
- `lockoutEnd` (string(date-time))
- `shouldChangePasswordOnNextLogin` (boolean)
- `concurrencyStamp` (string)
- `roleNames` (array<string>)
- `accessFailedCount` (integer(int32))
- `lastPasswordChangeTime` (string(date-time))
- `isExternal` (boolean)
- `userType` (object)
- `resellerId` (string(uuid))
- `merchantIds` (array<string(uuid)>)

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a IdentityUserCreateDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/identity/users" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/identity/users' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, UsersApi } from '@winkpg/winkpg-api';

const api = new UsersApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.userCreate({
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": true,
  "emailConfirmed": true,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": true,
  "shouldChangePasswordOnNextLogin": true,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/identity/users', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "password": "P@ssw0rd!ChangeMe",
    "sendConfirmationEmail": true,
    "emailConfirmed": true,
    "userName": "reseller.user",
    "name": "Reseller",
    "surname": "Manager",
    "email": "reseller.user@example.com",
    "phoneNumber": "555-555-1001",
    "isActive": true,
    "shouldChangePasswordOnNextLogin": true,
    "roleNames": [
      "reseller-admin"
    ],
    "organizationUnitIds": [],
    "userType": "Reseller",
    "resellerId": "00000000-0000-0000-0000-000000000010"
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new UsersApi(config);
var body = JsonSerializer.Deserialize<IdentityUserCreateDto>("""
    {
      "password": "P@ssw0rd!ChangeMe",
      "sendConfirmationEmail": true,
      "emailConfirmed": true,
      "userName": "reseller.user",
      "name": "Reseller",
      "surname": "Manager",
      "email": "reseller.user@example.com",
      "phoneNumber": "555-555-1001",
      "isActive": true,
      "shouldChangePasswordOnNextLogin": true,
      "roleNames": [
        "reseller-admin"
      ],
      "organizationUnitIds": [],
      "userType": "Reseller",
      "resellerId": "00000000-0000-0000-0000-000000000010"
    }
    """);

var result = await api.UserCreateAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/identity/users");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "password": "P@ssw0rd!ChangeMe",
      "sendConfirmationEmail": true,
      "emailConfirmed": true,
      "userName": "reseller.user",
      "name": "Reseller",
      "surname": "Manager",
      "email": "reseller.user@example.com",
      "phoneNumber": "555-555-1001",
      "isActive": true,
      "shouldChangePasswordOnNextLogin": true,
      "roleNames": [
        "reseller-admin"
      ],
      "organizationUnitIds": [],
      "userType": "Reseller",
      "resellerId": "00000000-0000-0000-0000-000000000010"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.UsersApi(client)
    body = winkpg_api.IdentityUserCreateDto.from_dict({
      "password": "P@ssw0rd!ChangeMe",
      "sendConfirmationEmail": True,
      "emailConfirmed": True,
      "userName": "reseller.user",
      "name": "Reseller",
      "surname": "Manager",
      "email": "reseller.user@example.com",
      "phoneNumber": "555-555-1001",
      "isActive": True,
      "shouldChangePasswordOnNextLogin": True,
      "roleNames": [
        "reseller-admin"
      ],
      "organizationUnitIds": [],
      "userType": "Reseller",
      "resellerId": "00000000-0000-0000-0000-000000000010"
    })
    result = api.user_create(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "password": "P@ssw0rd!ChangeMe",
  "sendConfirmationEmail": True,
  "emailConfirmed": True,
  "userName": "reseller.user",
  "name": "Reseller",
  "surname": "Manager",
  "email": "reseller.user@example.com",
  "phoneNumber": "555-555-1001",
  "isActive": True,
  "shouldChangePasswordOnNextLogin": True,
  "roleNames": [
    "reseller-admin"
  ],
  "organizationUnitIds": [],
  "userType": "Reseller",
  "resellerId": "00000000-0000-0000-0000-000000000010"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/identity/users",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.