Skip to main content
PUT
/
platform
/
adminuser
/
accounts
/
{userId}
Error
A valid request URL is required to generate request examples
{
  "emailAddress": "<string>",
  "userName": "<string>",
  "phoneNumber": "<string>",
  "externalId": "<string>",
  "localeCode": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "password": "<string>",
  "optInToEmail": true,
  "optInToTextMessage": true,
  "id": "<string>",
  "systemData": {
    "isPasswordChangeRequired": true,
    "lastPasswordChangeOn": "2023-11-07T05:31:56Z",
    "isLocked": true,
    "lastLockedOn": "2023-11-07T05:31:56Z",
    "failedLoginAttemptCount": 123,
    "remainingLoginAttempts": 123,
    "firstFailedLoginAttemptOn": "2023-11-07T05:31:56Z",
    "lastLoginOn": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z"
  },
  "roles": [
    {
      "userId": "<string>",
      "assignedInScope": {
        "type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "roleId": 123,
      "roleName": "<string>",
      "roleResources": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "roleTags": [
        "<string>"
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "isActive": true,
  "identityProviderId": "<string>"
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

userId
string
required

Unique identifier of the user whose login information you want to change.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Details of the new user account. Required properties: EmailAddress, FirstName, LastName, and Password. Note that the site ID is passed in the request header.

emailAddress
string | null
userName
string | null
phoneNumber
string | null
externalId
string | null
localeCode
string | null
firstName
string | null
lastName
string | null
password
string | null
optInToEmail
boolean | null
optInToTextMessage
boolean | null
id
string | null
systemData
object
roles
object[] | null
isActive
boolean
identityProviderId
string | null

Response

Success

emailAddress
string | null
userName
string | null
phoneNumber
string | null
externalId
string | null
localeCode
string | null
firstName
string | null
lastName
string | null
password
string | null
optInToEmail
boolean | null
optInToTextMessage
boolean | null
id
string | null
systemData
object
roles
object[] | null
isActive
boolean
identityProviderId
string | null