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 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
Electrification X
This API is an addon to Electrification X.
Share llms optimized content

Electrification X® combines the real and digital worlds in the Xcelerator IoT Software as a Service (SaaS) offering for Electrification & Automation to tackle the challenges of energy transition.

Setting up a machine user

In the Accounts application, you can create machine users. While you create machine users, the Client ID and Client secret key can be copied and sent to a user for further usage of the API.

Accounts application URLs

The Accounts application is available at the following URLs depending on your deployment region:

RegionAccounts application URL
EUeu.buildingx.siemens.com/accounts
USus.buildingx.siemens.com/accounts
Indiaap.buildingx.siemens.com/accounts

Machine users must belong to at least one machine user group with at least one machine user role assigned. All machine user roles start with Electrification X - Api. The group defines which roles and partitions the user can access. The full setup process is:

  1. Create the machine user
  2. Create a machine user group with the correct roles
  3. Assign the machine user group to the relevant partitions
  4. Add the machine user to the group

Requirements

  • You have the role Machine User Administrator

If you do not have the Machine User Administrator role, contact your organization's Electrification X administrator to request it. You can find your administrator on the overview page of the Accounts application for your tenant.

Creating a machine user

  1. Navigate to User management > Machine users.
    The page Machine users opens.
  2. Select the button +Create.
    The dialog Create machine user opens.
  3. Enter a name for the machine user.

    Entering the machine user name
    4. Select a user group. 5. Enter a description. 6. Select the button Create.
    The machine user is created and the Client ID and Client secret key are generated.

    Client ID and Client secret key
    7. Copy the Client ID and Client secret key. Select the button Copy details to copy the Client ID and Client secret key at once.

    Copy the Client secret key within the dialog Create machine user, as this is the only time you can see it. If you don't copy the Client secret key and close the dialog, you need to create another one later.

    Security: Do not share the Client Secret via unencrypted email or chat. Use a password manager or a secure credential sharing tool. Siemens recommends to store the Client ID and Client secret key in a safe location, for example, by using a password manager.

    Secret rotation: Client secrets do not expire automatically. However, Siemens recommends rotating secrets periodically as a security best practice. To rotate a secret, recreate it in the Accounts application, then update your application to use the new credentials.

  4. Select Save to close the dialog.

Creating a machine user group

A machine user group defines the roles and partition access for its members. A machine user must be in a group to get API access.

  1. Navigate to User management > User groups.
    The page User groups opens.
  2. Select the button +Create.
    The dialog Create group opens.
  3. Select the option Machine user group.
  4. Enter a name for the machine user group.
  5. Enter a description.
  6. Activate the check boxes for the desired roles. Machine user roles start with Electrification X - Api. Select at least one role to grant the machine user API access.

    Selecting roles
    7. Select the button Add.
    The machine user group is created.

Assigning a machine user group to a partition

  1. In the page User groups, select the desired machine user group.
  2. Switch to the tab Partition.
    The available partitions are shown.
  3. Activate the check boxes of the desired partitions.

    Selecting partitions
    4. Select the button Save.
    The machine user group is assigned to the selected partitions.

Adding machine users to a machine user group

  1. In the page User groups, select the desired machine user group.
  2. Switch to the tab Users.
    The already assigned machine users are shown.
  3. Select the link Manage users.
    The page Manage users opens.
  4. Select the machine users you want to add to the group on the left side of the page.

    Selecting machine users
    5. Select the right-arrow icon to add the selected machine users to the User group members list.
    6. Select the button Next.
    The page Manage users closes and the selected machine users are added to the list.
    7. Select the button Save.

    Selecting save

    The selected machine users are added to the selected machine user group.

Once the machine user is set up, share the Client ID and Client Secret with the API consumer so they can create an access token and start making API requests.