Create User (Reseller)

Create User (Reseller) #

Creates a new Reseller Account User assigned to a Reseller Account tenant.

POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/users

Remarks #

Whenever a new User is created they will be given the "account.user" role that allows them to login to the Reseller Portal. This will also send out an activation email to the address provided as soon as the User is created.

Example #

This request will create a new User with the following details:

  • Account: Within the Account tenant with id of {ACCOUNT_TENANT_ID}
  • Email: [email protected]
  • Display name: "New User",
  • Roles:
    • Website User (account.user)

Request # 

POST <https://api.na.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/users> HTTP/1.1
Content-Type: application/json
accept-charges: true
Authorisation: Bearer {TOKEN}
Connection: keep-alive
{
	"email": "[[email protected]](mailto:[email protected])",
	"displayName": "New User",
	"roles": ["account.user"]["account.user"]
}

Response # 

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Content-Length: xx
Location:  <https://api.na.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID}>
{
	"data": {
		"id": "{USER_ID}",
		"displayName": "New User",
		"email": "[[email protected]](mailto:[email protected])",
		"primaryTenant": "{ACCOUNT_TENANT_ID}",
		"roles": ["account.user"]["account.user"]
	},
	"status": "success",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired 

HTTP/1.1 401 Unauthorised

Bad Request #

When the provided tenant id is not in the correct format 

HTTP/1.1 400 Bad Request
Date: Thu, 06 Feb 2020 12:45:27 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 149
{
	"error": 400,
	"message": "The value '<tenant id>' is not valid.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

Not Found #

When there are no Accounts that have a matching tenant id 

HTTP/1.1 404 Not Found
Date: Thu, 06 Feb 2020 12:46:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 95
{
	"error": 404,
	"message": "Not Found",
	"status": "error",
	"timestamp": "2020-02-06T12:46:58.7669535Z"
}