The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
Accounts API
This API is an addon to Building X.

Discover calling entity properties like usergroups, partitions or roles.

Accounts API¶

The Accounts API enables you, or rather the calling entity, the machine user to discover in which partitions it has access.

The Accounts API is organized around Customers, Partitions, UserGroups and Roles.

Concepts & Glossary¶

TermDescription
CustomerA Customer represents a company which owns resources like Machine Users and Partitions.
PartitionA Partition represents a logical segmentation of a Customer. It can be used to group a number of Buildings together.
RolesA Role is a set of permissions representing which actions a machine user with a given Role can perform in the system.
UserGroupUser groups allow users to organize Partitions and user access in a fine-grained way. UserGroups can be used to group machine users to give them access to one or multiple Partitions by acting in a certain Role.