Create User

Select

SaaS

This API can be used by MSP Partners to provision a new user in Metallic. Each user has roles assigned and can manage different accounts.

User creation is asynchronous. Upon request submission, user record will be in "provisioning" status and will become "active" when creation process finishes.

Request Body

Field	Description	Type	Required	Notes
email	Contact email	String	True	Needs to be unique in metallic.
firstName	Contact firstname	String	True
lastname	Contact lastname	String	True
roles	List of user role Ids	String Array	True	See - Available Roles
managedAccounts	List of user managed account metallic Ids	UUID Array	False	User cannot manage accounts without Service Administrator role or Account Manager role. 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 "provisioning" is returned in this case.
insertTs	User created time	Timestamp
updateTs	User last updated time	Timestamp
requestData	Create User Request Body	Create User - Request Body	See - Create User - Request Body

application/json

Request Body required

• firstName string required
• lastName string required
• email string required
• roles string[] required
• managedAccounts string[]

Responses

• 201

---

Created

application/json

• Schema
• Example (from schema)
• Create User - Success - Account Manager Managing All Accounts
• Example

---

Schema

• data object

  id string

  insertTs string

  updateTs string

  status string

  requestData object

  firstName string

  lastName string

  email string

  roles string[]

  managedAccounts string[]

{
  "data": {
    "id": "583E575B-4657-40A4-B63A-9F85E3AFCC58",
    "insertTs": "2022-01-14T23:48:40",
    "updateTs": "2022-01-14T23:48:40",
    "status": "provisioning",
    "requestData": {
      "firstName": "Sam",
      "lastName": "Smith",
      "email": "sam@abcinc.com",
      "roles": [
        "ROLE_MSP_ADMIN"
      ]
    }
  }
}

{
  "data": {
    "id": "583E575B-4657-40A4-B63A-9F85E3AFCC58",
    "insertTs": "2022-01-14T23:48:40",
    "updateTs": "2022-01-14T23:48:40",
    "status": "provisioning",
    "requestData": {
      "firstName": "Sam",
      "lastName": "Smith",
      "email": "sam@abcinc.com",
      "roles": [
        "ROLE_ACCOUNT_MANAGER"
      ],
      "managedAccounts": [
        "*"
      ]
    }
  }
}

{
  "data": {
    "id": "583E575B-4657-40A4-B63A-9F85E3AFCC58",
    "insertTs": "2022-01-14T23:48:40",
    "updateTs": "2022-01-14T23:48:40",
    "status": "provisioning",
    "requestData": {
      "firstName": "Sam",
      "lastName": "Smith",
      "email": "sam@abcinc.com",
      "roles": [
        "ROLE_MSP_ADMIN"
      ]
    }
  }
}

Loading...