Update User Managed Accounts

This API can be used by MSPs to add or remove accounts for a user. Account update is asynchronous. Upon request submission, user record will be in "updating" status and will become "active" when update process finishes.

Path Variables

Field	Description	Type	Notes
userId	User metallic id	UUID

Request Body

Field	Description	Type	Required	Notes
action	Action for requested roles	String Enumeration. Allowed values: add / remove	True
managedAccounts	List of user managed account metallic Ids	UUID Array	True	Value "*" means user will manage all existing and future accounts under this MSP Partner.

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 managed accounts Request Body	Update User Managed Accounts - Request Body	See - Update User Managed Accounts - Request Body

Path Parameters

• userId string required

application/json

Request Body required

• action string required
• managedAccounts string[] required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Update User Managed Accounts - Success

---

Schema

• data object

  id string

  insertTs string

  updateTs string

  status string

  requestData object

  action string

  managedAccounts string[]

{
  "data": {
    "id": "537FBFE1-88F4-480F-9063-2F6426536684",
    "insertTs": "2022-01-19T19:23:44",
    "updateTs": "2022-01-19T19:28:18",
    "status": "updating",
    "requestData": {
      "action": "add",
      "managedAccounts": [
        "3B9B14B8-ECDD-4783-A92B-3B0EEF017A67",
        "628EF52D-AD52-4839-B6C3-03B6A43D7911"
      ]
    }
  }
}

{
  "data": {
    "id": "537FBFE1-88F4-480F-9063-2F6426536684",
    "insertTs": "2022-01-19T19:23:44",
    "updateTs": "2022-01-19T19:28:18",
    "status": "updating",
    "requestData": {
      "action": "add",
      "managedAccounts": [
        "3B9B14B8-ECDD-4783-A92B-3B0EEF017A67",
        "628EF52D-AD52-4839-B6C3-03B6A43D7911"
      ]
    }
  }
}

Loading...