WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:09 UTC.

API reference Users

Create new user

POST /api/identity/users deprecated

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

Requires API key scope: admin (Administration)

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

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Each example below is one request, shown in every language. Choose an example and a language, then 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.

Code sample language
Request example

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

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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)

pip install requests

Python (raw HTTP)

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()

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

cURL

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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": "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)

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();

pip install winkpg-api

Python (SDK)

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)

pip install requests

Python (raw HTTP)

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()

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

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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",
      "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)

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();

pip install winkpg-api

Python (SDK)

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)

pip install requests

Python (raw HTTP)

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()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null values.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description
userName required string min length 3max length 256pattern ^[a-zA-Z0-9]([a-zA-Z0-9._-]*[a-zA-Z0-9])?$
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
name required string The user's first name. Optional. nullablemin length 0max length 64
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
surname required string The user's last name. Optional. nullablemin length 0max length 64
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
email required string (email) min length 0max length 256
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
phoneNumber required string The user's phone number. Optional. nullablemin length 0max length 16
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActive required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shouldChangePasswordOnNextLogin required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lockoutEnabled required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
roleNames required array of string array of The names of the roles to assign to the user. Optional. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
organizationUnitIds required array of string (uuid) array of The ids of the organization units the user belongs to. Optional. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
userType required UserType UserType nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Admin
Merchant
Reseller
resellerId required string (uuid) nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantIds required array of string (uuid) array of nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
password required string min length 0max length 128
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
sendConfirmationEmail required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailConfirmed required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
phoneNumberConfirmed required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
createFacadeApiKey required boolean When true, mints a standing API key for the new user as part of creating them.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

Body: IdentityUserDto IdentityUserDto Each item has these fields.

Field Type Description
extraProperties required object nullableread only
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
id required string (uuid)
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creationTime required string (date-time) The date and time when this entity was created.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creatorId required string (uuid) The ID of the user who created this entity. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModificationTime required string (date-time) The date and time when this entity was last modified. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModifierId required string (uuid) The ID of the user who last modified this entity. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isDeleted required boolean Indicates whether this entity has been deleted.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
deleterId required string (uuid) The ID of the user who deleted this entity, if it is deleted. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
deletionTime required string (date-time) The date and time when this entity was deleted, if it is deleted. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
tenantId required string (uuid) nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
userName required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
email required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
name required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
surname required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailConfirmed required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
phoneNumber required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
phoneNumberConfirmed required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
supportTwoFactor required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
twoFactorEnabled required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActive required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lockoutEnabled required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isLockedOut required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lockoutEnd required string (date-time) nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
shouldChangePasswordOnNextLogin required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
concurrencyStamp required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
roleNames required array of string array of nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
accessFailedCount required integer (int32)
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastPasswordChangeTime required string (date-time) nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isExternal required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
userType required UserType UserType nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Admin
Merchant
Reseller
resellerId required string (uuid) nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantIds required array of string (uuid) array of nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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 lists the values `error.code` can take. 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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.