# 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. Requires API key scope: `admin` 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`](https://devportal.demo.winkpg.io/docs/api/models/IdentityUserCreateDto.md) Properties: - `userName` (string) required: (min length 3, max length 256, pattern ^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$) - `name` (string): The user's first name. Optional. (nullable, min length 0, max length 64) - `surname` (string): The user's last name. Optional. (nullable, min length 0, max length 64) - `email` (string(email)) required: (min length 0, max length 256) - `phoneNumber` (string): The user's phone number. Optional. (nullable, min length 0, max length 16) - `isActive` (boolean) - `shouldChangePasswordOnNextLogin` (boolean) - `lockoutEnabled` (boolean) - `roleNames` (array): The names of the roles to assign to the user. Optional. (nullable) - `organizationUnitIds` (array): The ids of the organization units the user belongs to. Optional. (nullable) - `userType` ([UserType](https://devportal.demo.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `password` (string) required: (min length 0, max length 128) - `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`](https://devportal.demo.winkpg.io/docs/api/models/IdentityUserCreateDto.md) Properties: - `userName` (string) required: (min length 3, max length 256, pattern ^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$) - `name` (string): The user's first name. Optional. (nullable, min length 0, max length 64) - `surname` (string): The user's last name. Optional. (nullable, min length 0, max length 64) - `email` (string(email)) required: (min length 0, max length 256) - `phoneNumber` (string): The user's phone number. Optional. (nullable, min length 0, max length 16) - `isActive` (boolean) - `shouldChangePasswordOnNextLogin` (boolean) - `lockoutEnabled` (boolean) - `roleNames` (array): The names of the roles to assign to the user. Optional. (nullable) - `organizationUnitIds` (array): The ids of the organization units the user belongs to. Optional. (nullable) - `userType` ([UserType](https://devportal.demo.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `password` (string) required: (min length 0, max length 128) - `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`](https://devportal.demo.winkpg.io/docs/api/models/IdentityUserCreateDto.md) Properties: - `userName` (string) required: (min length 3, max length 256, pattern ^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$) - `name` (string): The user's first name. Optional. (nullable, min length 0, max length 64) - `surname` (string): The user's last name. Optional. (nullable, min length 0, max length 64) - `email` (string(email)) required: (min length 0, max length 256) - `phoneNumber` (string): The user's phone number. Optional. (nullable, min length 0, max length 16) - `isActive` (boolean) - `shouldChangePasswordOnNextLogin` (boolean) - `lockoutEnabled` (boolean) - `roleNames` (array): The names of the roles to assign to the user. Optional. (nullable) - `organizationUnitIds` (array): The ids of the organization units the user belongs to. Optional. (nullable) - `userType` ([UserType](https://devportal.demo.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `password` (string) required: (min length 0, max length 128) - `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`](https://devportal.demo.winkpg.io/docs/api/models/IdentityUserDto.md) Properties: - `extraProperties` (object): (nullable, read only) - `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. (nullable) - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable) - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable) - `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. (nullable) - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable) - `tenantId` (string(uuid)): (nullable) - `userName` (string) required: (nullable) - `email` (string) required: (nullable) - `name` (string) required: (nullable) - `surname` (string) required: (nullable) - `emailConfirmed` (boolean) - `phoneNumber` (string): (nullable) - `phoneNumberConfirmed` (boolean) - `supportTwoFactor` (boolean) - `twoFactorEnabled` (boolean) - `isActive` (boolean) - `lockoutEnabled` (boolean) - `isLockedOut` (boolean) - `lockoutEnd` (string(date-time)): (nullable) - `shouldChangePasswordOnNextLogin` (boolean) - `concurrencyStamp` (string): (nullable) - `roleNames` (array): (nullable) - `accessFailedCount` (integer(int32)) - `lastPasswordChangeTime` (string(date-time)): (nullable) - `isExternal` (boolean) - `userType` ([UserType](https://devportal.demo.winkpg.io/docs/api/models/UserType.md)): (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. These blocks send the Reseller User example. The other examples follow under Other request examples. 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. ### 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(""" { "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() ``` ## Other request examples Each example below is one request, shown in every language with the same placeholders. ### 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. #### 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": "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" ] }' ``` #### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "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" ] } '@ $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": "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" ] }); ``` #### 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": "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" ] }), }); 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(""" { "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" ] } """); 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": "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" ] } """, 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": "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" ] }) 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": "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" ] } response = requests.request( "POST", "{{BASE_URL}}/api/identity/users", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ### 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. #### 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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] }' ``` #### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "password": "P@ssw0rd!ChangeMe", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] } '@ $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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] }); ``` #### 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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] }), }); 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(""" { "password": "P@ssw0rd!ChangeMe", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] } """); 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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": true, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] } """, 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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": True, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] }) 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", "userName": "merchant.minimal", "email": "merchant.minimal@example.com", "isActive": True, "userType": "Merchant", "merchantIds": [ "00000000-0000-0000-0000-000000000001" ] } 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.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.