Update User Name

Select

SaaS

This API can be used by MSPs to edit a user's first name or last name. User name update is asynchronous. Upon request submission, user record will be in "updating" status and will become "active" when update process finishes.

Passing null or empty string will update the value correspondingly, so please provide the original value if no update.

Path Variables

Field	Description	Type	Notes
userId	User metallic id	UUID

Request Body

Field	Description	Type	Required	Notes
firstName	User Firstname	String	False
lastName	User Lastname	String	False

Response Body

Field	Description	Type	Notes
id	User metallic id	UUID
status	User status	String Enumeration - User Status Enumeration	Refer to User Status Enumeration. Value "updating" is returned in this case.
insertTs	User created time	Timestamp
updateTs	User last updated time	Timestamp
requestData	Update user name Request Body	Update User Name - Request Body	See - Update User Name - Request Body

Path Parameters

• userId string required

application/json

Request Body

• firstName string required
• lastName string required

Responses

• 200

---

OK

application/json

• Schema
• Update User Name

---

Schema

{
  "data": {
    "id": "537FBFE1-88F4-480F-9063-2F6426536684",
    "insertTs": "2022-01-19T19:23:44",
    "updateTs": "2022-01-19T19:28:18",
    "status": "updating",
    "requestData": {
      "firstName": "Jolin",
      "lastName": "Smith"
    }
  }
}

Loading...