Loading...
Overview

Account

Represents an account in the digital customer platform, used to organize customers, subaccounts, users, assets, and related configuration.

Attributes

These are all attributes that can be read and updated through the API

Name Description Permissions
id Unique identifier for the account record. READ ONLY
name Display name of the account. READ AND UPDATE
description Human-readable details about the account. READ AND UPDATE
applicable_user_group_filters Short description not available from the provided information. READ ONLY
user_group_filter Short description not available from the provided information. READ ONLY
user_group_inheritable Short description not available from the provided information. READ ONLY

Get Account by ID

GEThttps://fe97afc396.autonoma.cloud/connect/v1/resources/account/[ID]

Returns a specific Account by ID.


Get Relations

It is possible to get related objects from Accounts.

GEThttps://fe97afc396.autonoma.cloud/connect/v1/resources/account/[ID]/[RELATION]

This table shows all available resources that can be queried

Relation Objecttype Relationtype
users User Not available Show details
assets Asset 1:many Show details
metadatas Metadata many:many Show details
gateways Gateway 1:many Show details

Invite a new account user

Creates an invitation for a new user account using the provided identity and role information.

POSThttps://fe97afc396.autonoma.cloud/connect/v1/resources/account/[ID]/call/invite

This table shows all available parameters

Name Description Required
firstname The first name of the user to invite. required
lastname The last name of the user to invite. required
email The email address of the user to invite. required
roles The role relation assigned to the invited user. required

Update Account

POSThttps://fe97afc396.autonoma.cloud/connect/v1/resources/account/[ID]

Update fields of Account by ID. The fields must be sent as x-www-form-urlencoded parameter.


Create Account

PUThttps://fe97afc396.autonoma.cloud/connect/v1/resources/account

Create a new Account.


Delete Account

DELETEhttps://fe97afc396.autonoma.cloud/connect/v1/resources/account/[ID]

Delete the resource Account by ID.

Top Top