# 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. Requires API key scope: `admin` 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`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/IdentityUserUpdateDto.md) Properties: - `userName` (string) required: (min length 0, max length 256) - `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.signapay-sbx.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `emailConfirmed` (boolean) - `phoneNumberConfirmed` (boolean) - `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required. (nullable) _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`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/IdentityUserUpdateDto.md) Properties: - `userName` (string) required: (min length 0, max length 256) - `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.signapay-sbx.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `emailConfirmed` (boolean) - `phoneNumberConfirmed` (boolean) - `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required. (nullable) _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`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/IdentityUserUpdateDto.md) Properties: - `userName` (string) required: (min length 0, max length 256) - `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.signapay-sbx.winkpg.io/docs/api/models/UserType.md)) required: (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) - `emailConfirmed` (boolean) - `phoneNumberConfirmed` (boolean) - `concurrencyStamp` (string): The concurrency stamp returned when the user was read. Required. (nullable) _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`](https://devportal.signapay-sbx.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.signapay-sbx.winkpg.io/docs/api/models/UserType.md)): (nullable) Values: - `Admin` - `Merchant` - `Reseller` - `resellerId` (string(uuid)): (nullable) - `merchantIds` (array): (nullable) ### 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.signapay-sbx.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.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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" ] } ] } } ``` ### 401 Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 403 Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 404 Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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 } } ``` ### 409 Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 501 Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.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 } } ``` ### Errors These statuses answer with the error envelope outlined below. - `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. - `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. - `403`: Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason. - `404`: Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found. - `409`: Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope. - `500`: Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`. - `501`: Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. - `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.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) Fields: - `code` (string): (nullable) - `message` (string): (nullable) - `details` (string): (nullable) - `data` (object): (nullable) - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable) _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" ] } ] } } ``` ## Authentication - `ApiKey` ## 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. These blocks send the Update Profile, Keep Roles and Organization Units example. The other examples follow under Other request examples. 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. ### 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(""" { "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() ``` ## Other request examples Each example below is one request, shown in every language with the same placeholders. ### 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. #### 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, "roleNames": [ "merchant-user" ], "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, "roleNames": [ "merchant-user" ], "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, "roleNames": [ "merchant-user" ], "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, "roleNames": [ "merchant-user" ], "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(""" { "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" ] } """); 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, "roleNames": [ "merchant-user" ], "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, "roleNames": [ "merchant-user" ], "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, "roleNames": [ "merchant-user" ], "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.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.