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
account_id Identifier of the parent or related account. READ ONLY
mfa_policy Configured multi-factor authentication policy for the account. READ AND UPDATE
mfa_methods Multi-factor authentication methods enabled for the account. READ AND UPDATE
effective_mfa_policy MFA policy currently applied after inheritance and overrides. READ ONLY
effective_mfa_methods MFA methods currently applied after inheritance and overrides. READ ONLY
mfa_inherited_from_account_id Account ID from which the MFA settings are inherited. READ ONLY

Get Account by ID

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

Returns a specific Account by ID.


Relations

It is possible to get related objects from Accounts.

GEThttps://3aa60a474b.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

Update Account

POSThttps://3aa60a474b.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://3aa60a474b.autonoma.cloud/connect/v1/resources/account

Create a new Account.


Delete Account

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

Delete the resource Account by ID.

Top Top