Users

A user is an administrator of an account.

Get Users

Get a list of all authorized users.

URL

GET https://mc10cloud.com/api/v1/accounts/{accountId}/users

Parameters

  • accountId: Account UUID

Sample Response

{
"items": [
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"accounts": [],
"createdTs": 1497373959976,
"email": "j.smith@example.com",
"firstName": "John",
"id": "814eca80-505b-11e7-85fd-0a87d285401b",
"isDisabled": false,
"lastName": "Smith",
"legaleseVersionAccepted": 1,
"legaleseVersionRequired": 1,
"locale": "en_US",
"timezone": "US/Eastern"
},
{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"accounts": [],
"createdTs": 1497390485047,
"disabledTs": 1558607181820,
"email": "j.jones@example.com",
"firstName": "Jim",
"id": "fb048470-5081-11e7-85fd-0a87d285401b",
"isDisabled": true,
"lastName": "Jones",
"legaleseVersionAccepted": 1,
"legaleseVersionRequired": 1,
"locale": "en_US",
"timezone": "US/Eastern"
}
],
"size": 2
}

Get User

Get a specific user by ID.

URL

GET https://mc10cloud.com/api/v1/users/{userId}

Parameters

  • userId: User UUID

Sample Response

{
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"accounts": [],
"createdTs": 1497373959976,
"email": "j.smith@example.com",
"firstName": "John",
"id": "814eca80-505b-11e7-85fd-0a87d285401b",
"isDisabled": false,
"lastName": "Smith",
"legaleseVersionAccepted": 1,
"legaleseVersionRequired": 1,
"locale": "en_US",
"timezone": "US/Eastern"
}

Create User

Create a user with a unique email address, first name, last name, locale ("en_US" or "ja_JP"), supported time zone and optional password (8-64 characters). If a password is not provided, the system will send the new user an email with instructions for setting a password.

URL

POST https://mc10cloud.com/api/v1/users/register/email

Sample Request Body

Note email address must be supplied twice.

{
"email": "j_doe@example.com",
"password": "pw_1!2@3#4$5%",
"user": {
"accountId": "5d3b5950-1b00-11e7-8464-0a624d7022db",
"email": "j_doe@example.com",
"firstName": "John",
"lastName": "Doe",
"locale": "en_US",
"timezone": "US/Eastern"
}
}

Sample Response

{
"id": "88896760-6841-11e9-94b9-e9750c9818f0",
"links": [
{
"href": "/v1/users/88896760-6841-11e9-94b9-e9750c9818f0",
"rel": "self"
}
]
}

Update User

Update some properties of a user (first name, last name and locale).

URL

PUT https://mc10cloud.com/api/v1/users/{userId}

Parameters

  • userId: User UUID

Sample Request Body

{
"firstName": "Jane",
"lastName": "Doe",
"locale": "en_US"
}

Sample Response

(No Content)

Delete User

Delete another user. (This operation does not actually delete a user from the system. Rather, the user is marked as disabled.)

URL

DELETE https://mc10cloud.com/api/v1/accounts/{accountId}/users/{userId}

Parameters

  • accountId: Account UUID

  • userId: User UUID

Sample Response

(No Content)