PATCH v2/LocalUsers/{identityId}

User roles allowed to make this request: DomainAdministrator

Permissions required to make this request: User.Write User.Read

Edits properties of a local user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
identityId

string

Required

Body Parameters

EditLocalUserRequestModel
NameDescriptionTypeAdditional information
FirstName

First name of user

string

None.

LastName

Last name of user

string

None.

Email

Email of the user

string

None.

UserRole

Role of the user

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "UserRole": "sample string 4"
}

application/xml, text/xml

Sample:
<EditLocalUserRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Email>sample string 3</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <UserRole>sample string 4</UserRole>
</EditLocalUserRequestModel>

application/x-www-form-urlencoded

Sample:
FirstName=sample&LastName=sample&Email=sample&UserRole=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "LastLogonDate": "2024-06-14T01:31:15.3134877+00:00",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Email": "sample string 5",
  "UserRole": "sample string 6"
}

application/xml, text/xml

Sample:
<LocalUserResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Email>sample string 5</Email>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <UserRole>sample string 6</UserRole>
  <Id>sample string 1</Id>
  <LastLogonDate>2024-06-14T01:31:15.3134877+00:00</LastLogonDate>
  <Name>sample string 2</Name>
</LocalUserResponseModel>