EmbedThis

Appearance

User ​

User management.

Create ​

Create a new user

Endpoint

POST /user/create

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - email | string | yes role | string | yes sendInvite | boolean |

Response

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

Comment ​

Endpoint

POST /user/comment

Authorized User Role

user

Request Body

Field | Type | Required

  • | - | - subject | string | yes url | string | yes comments | string | yes email | string | yes account | string | yes

Get ​

Endpoint

POST /user/get

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - email | string | admin id | string | admin

Response

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

Find ​

Endpoint

POST /user/find

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - email | string | admin id | string | admin

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Paged response.

Field | Type | Notes

  • | - | - data | array | A token object. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.

User

An array of User items.

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

Init ​

Endpoint

POST /user/init

Authorized User Role

user

Request Body

A object.

Response

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

Login ​

Login the authenticated user

Endpoint

POST /user/login

Authorized User Role

public

Request Body

Field | Type

  • | - invite | string

Response

A user object.

Field | Type

  • | - account | object cache | object user | object versions | object

LookupUser ​

Endpoint

POST /user/lookupUser

Authorized User Role

support

Request Body

Field | Type | Required

  • | - | - email | string | yes

Response

A string.

Jobs ​

Endpoint

POST /user/jobs

Authorized User Role

public

Request Body

Field | Type | Required

  • | - | - details | object | yes

Prefetch ​

Endpoint

POST /user/prefetch

Authorized User Role

user

Request Body

A object.

Response

Prefetched account and user objects.

Field | Type

  • | - account | object user | object cache | object local | boolean versions | object

Account

Field | Type

  • | - activity | date billing | object closed | boolean created | date email | string id | string metrics | object name | string suspended | boolean

Billing

Field | Type

  • | - address | string agreement | boolean cardId | string canWire | boolean company | string country | string credit | number error | string invoiceEmail | string memo | string order | string renew | date renewing | boolean stripeId | string subject | string terms | number wire | boolean

Metrics

Field | Type

  • | - agents | array balance | number connected | number clouds | number customer | boolean dashboards | number devices | number developer | number emails | object interest | array notifications | number plans | number products | number software | number support | number users | number

User

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

Remove ​

Endpoint

POST /user/remove

Authorized User Role

admin

Request Body

Field | Type

  • | - email | string id | string

Update ​

Update a user identity

Endpoint

POST /user/update

Authorized User Role

user

Request Body

Field | Type

  • | - email | string first | string id | string last | string preferences | object

Response

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string

UpdateRole ​

Endpoint

POST /user/updateRole

Authorized User Role

admin

Request Body

Field | Type | Role

  • | - | - id | string | role | string | admin sendInvite | boolean |

Response

Field | Type

  • | - accountId | string activity | date email | string first | string id | string invite | string last | string preferences | object role | string state | string