Skip to main content

Generate an automation client for an XM Cloud environment


Describes how to generate an automation client for an environment in XM Cloud Deploy.

You can enable custom tools and integrations to access your XM Cloud environment API by generating an automation client.

To generate an automation client for an environment:

  1. On the menu bar of the XM Cloud Deploy App, click Authentication Clients.

  2. On the Authentication Clients page, on the Environment tab, click Generate, Automation client.

  3. In the Edge administration client dialog, in the Project drop-down menu, click or enter the project that contains the environment where you want to generate an automation client.

  4. In the Environment drop-down menu, click or enter the environment that you want.

  5. In the Label field, enter a label for the automation client.


    You can not use the following characters in the Label and Description fields: # @ " + & >

  6. Optionally, in the Description field, enter a description for the automation client.

  7. Click Generate.

  8. Save the client ID and client secret.


    The client secret is generated only one time and cannot be retrieved from the system or regenerated. If you lose the client secret, you must generate a new authentication client.