# PUT /api/identity/users/{id}

Update user

Updates an existing user's information including personal details and roles.

**Operation ID:** `userUpdate`

## Authorization

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

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

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The unique identifier of the user to update. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The updated user details.

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

Schema: `IdentityUserUpdateDto`

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)>)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required.

_Example: Update Profile, Keep Roles and Organization Units_

Updates a merchant user's profile and leaves role and organization unit assignment alone. roleNames and organizationUnitIds are omitted, so the user keeps exactly the roles and organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

_Example: Set Roles, Keep Organization Units_

Sets a merchant user's roles from roleNames and leaves organization unit membership alone. organizationUnitIds is omitted, so the user keeps exactly the organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "roleNames": [
    "merchant-user"
  ],
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

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

Schema: `IdentityUserUpdateDto`

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)>)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required.

_Example: Update Profile, Keep Roles and Organization Units_

Updates a merchant user's profile and leaves role and organization unit assignment alone. roleNames and organizationUnitIds are omitted, so the user keeps exactly the roles and organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

_Example: Set Roles, Keep Organization Units_

Sets a merchant user's roles from roleNames and leaves organization unit membership alone. organizationUnitIds is omitted, so the user keeps exactly the organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "roleNames": [
    "merchant-user"
  ],
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

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

Schema: `IdentityUserUpdateDto`

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)>)
- `emailConfirmed` (boolean)
- `phoneNumberConfirmed` (boolean)
- `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required.

_Example: Update Profile, Keep Roles and Organization Units_

Updates a merchant user's profile and leaves role and organization unit assignment alone. roleNames and organizationUnitIds are omitted, so the user keeps exactly the roles and organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
```

_Example: Set Roles, Keep Organization Units_

Sets a merchant user's roles from roleNames and leaves organization unit membership alone. organizationUnitIds is omitted, so the user keeps exactly the organization unit memberships already stored. Send concurrencyStamp as returned by your last read of the user.

```json
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "roleNames": [
    "merchant-user"
  ],
  "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 IdentityUserUpdateDto. See the Request body section below for its fields.

### cURL

```bash
curl -X PUT "{{BASE_URL}}/api/identity/users/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}'
```

### PowerShell

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

$body = @'
{
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/identity/users/{id}' `
    -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.userUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "emailConfirmed": true,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": true,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/identity/users/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "emailConfirmed": true,
    "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
    "userName": "merchant.user",
    "name": "Merchant",
    "surname": "Operator",
    "email": "merchant.user@example.com",
    "phoneNumber": "555-555-2001",
    "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<IdentityUserUpdateDto>("""
    {
      "emailConfirmed": true,
      "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
      "userName": "merchant.user",
      "name": "Merchant",
      "surname": "Operator",
      "email": "merchant.user@example.com",
      "phoneNumber": "555-555-2001",
      "isActive": true,
      "userType": "Merchant",
      "merchantIds": [
        "00000000-0000-0000-0000-000000000001"
      ]
    }
    """);

var result = await api.UserUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

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

request.Content = new StringContent("""
    {
      "emailConfirmed": true,
      "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
      "userName": "merchant.user",
      "name": "Merchant",
      "surname": "Operator",
      "email": "merchant.user@example.com",
      "phoneNumber": "555-555-2001",
      "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.IdentityUserUpdateDto.from_dict({
      "emailConfirmed": True,
      "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
      "userName": "merchant.user",
      "name": "Merchant",
      "surname": "Operator",
      "email": "merchant.user@example.com",
      "phoneNumber": "555-555-2001",
      "isActive": True,
      "userType": "Merchant",
      "merchantIds": [
        "00000000-0000-0000-0000-000000000001"
      ]
    })
    result = api.user_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "emailConfirmed": True,
  "concurrencyStamp": "3f1c2b7e9a4d4c6e8b0a1d2e3f4a5b6c",
  "userName": "merchant.user",
  "name": "Merchant",
  "surname": "Operator",
  "email": "merchant.user@example.com",
  "phoneNumber": "555-555-2001",
  "isActive": True,
  "userType": "Merchant",
  "merchantIds": [
    "00000000-0000-0000-0000-000000000001"
  ]
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/identity/users/{id}",
    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.