PATCH v2/LocalUsers/{identityId}/Password

User roles allowed to make this request: DomainAdministrator

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

Edits local user password.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
identityId

string

Required

Body Parameters

ChangePasswordLocalUserRequestModel
NameDescriptionTypeAdditional information
Password

User password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Password": "sample string 1"
}

application/xml, text/xml

Sample:
<ChangePasswordLocalUserRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Password>sample string 1</Password>
</ChangePasswordLocalUserRequestModel>

application/x-www-form-urlencoded

Sample:
Password=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"
}

application/xml, text/xml

Sample:
<ChangePasswordLocalUserResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Id>sample string 1</Id>
</ChangePasswordLocalUserResponseModel>