PATCH api/v1/admin/users/{id}/status

Unlocks the specified user which allows them to use the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The user to promote or demote.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The new status of the user.

ResponseOfString
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfString

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ResponseOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>sample string 2</Detail>
  </ResponseData>
</ResponseOfString>