Account API


Account API


Create Account

Create Account creates a child account for the parent account in the Embedded Cloud product.

Request

POST https://cloud.cdata.com/api/poweredby/account/create

{
    "externalId": "MyExternalId"
}

Payload Parameters

Name Description
externalId The external Id of the account to be created.

Response

HTTP 200 OK

{
    "accountId": "8744e71e-ee33-4d4e-916f-0a21eba65902",
    "externalId": "MyExternalId",
    "createdTime": "2024-07-10T19:10:52.139Z"
}

Fields

Name Description
accountId The internal CData Connect Cloud account Id.
externalId The customer’s identifier.
createdTime The time when the account was created.

List Accounts

List Accounts lists the child accounts within the parent account.

Request

GET https://cloud.cdata.com/api/poweredby/account/list

Response

HTTP 200 OK

{
    "accounts": [
       {
          "id": "fee1ce9d-c40c-4ef6-8f8c-77461315713d",
          "externalId": "ExternalId",
          "created": "2023-07-13T20:42:56.317Z"
       },
       {
          "id": "c6cc4c16-35c8-4657-90c6-f93d401b0ae9",
          "externalId": "GlobeInc",
          "created": "2024-07-16T18:03:19.622Z"
       }    
    ]
}    

Fields

Name Description
id The internal CData Connect Cloud account Id.
externalId The Embedded Cloud external account identifier.
created The time this account was created.

Delete Account

Delete Account deletes a child account from the Embedded Cloud product.

Request

DELETE https://cloud.cdata.com/api/poweredby/account/delete/{id}

Path Parameters

Name Description
id The child account Id.

Response

HTTP 200 OK