EmbedThis

Appearance

Manager ​

Device Manager UI.

CheckDomain ​

Endpoint

POST /manager/checkDomain

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - domain | string | yes

Response

A boolean.

Create ​

Create a device manager

This call created a device manager object. This must be paired with a cloud object using the same ID.

Endpoint

POST /manager/create

Authorized User Role

admin

Request Body

Field | Type

  • | - app | string cloudId | string domain | string logo | string name | string region | string title | string version | string

Response

A manager object.

Field | Type

  • | - accountId | string app | string logo | string certArn | string cloudFront | string cloudId | string distributionId | string domain | string error | string id | string name | string priorDomain | string provisioned | date region | string title | string type | string version | string

Find ​

Get a list of device managers

Endpoint

POST /manager/find

Authorized User Role

user

Request Body

Field | Type

  • | - id | string

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 list of cloud records. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.

Manager

An array of Manager items.

Field | Type

  • | - accountId | string app | string logo | string certArn | string cloudFront | string cloudId | string distributionId | string domain | string error | string id | string name | string priorDomain | string provisioned | date region | string title | string type | string version | string

Get ​

Get a manager object

Endpoint

POST /manager/get

Authorized User Role

user

Request Body

Field | Type | Required

  • | - | - id | string | yes

Response

A manager object.

Field | Type

  • | - accountId | string app | string logo | string certArn | string cloudFront | string cloudId | string distributionId | string domain | string error | string id | string name | string priorDomain | string provisioned | date region | string title | string type | string version | string

Init ​

Endpoint

POST /manager/init

Authorized User Role

user

Request Body

A object.

Response

A manager object.

Field | Type

  • | - accountId | string app | string logo | string certArn | string cloudFront | string cloudId | string distributionId | string domain | string error | string id | string name | string priorDomain | string provisioned | date region | string title | string type | string version | string

Provision ​

Endpoint

POST /manager/provision

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - id | string | yes assets | object |

Query String Options

Field | Type

  • | - invoke | string

ProvisionAsync ​

Endpoint

POST /manager/provisionAsync

Authorized User Role

service

Request Body

Field | Type | Required

  • | - | - id | string | yes accountId | string | yes assets | object |

Remove ​

Endpoint

POST /manager/remove

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - id | string | yes

Query String Options

Field | Type

  • | - invoke | string

RemoveAsync ​

Endpoint

POST /manager/removeAsync

Authorized User Role

service

Request Body

Field | Type | Required

  • | - | - accountId | string | yes id | string | yes

Update ​

Endpoint

POST /manager/update

Authorized User Role

admin

Request Body

Field | Type

  • | - app | string cloudId | string domain | string id | string logo | string name | string priorDomain | string region | string title | string version | string

Response

A manager object.

Field | Type

  • | - accountId | string app | string logo | string certArn | string cloudFront | string cloudId | string distributionId | string domain | string error | string id | string name | string priorDomain | string provisioned | date region | string title | string type | string version | string

GetSignedUrl ​

Endpoint

POST /manager/getSignedUrl

Authorized User Role

admin

Request Body

Field | Type

  • | - id | string clean | boolean filename | string mimeType | string

Response

A signed URL string.