> For the complete documentation index, see [llms.txt](https://docs.energyweb.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/acquiring-an-enterprise-user-role.md).

# Acquiring an enterprise user role

{% hint style="warning" %}
Before continuing with this section, please ensure that an [EWC Account](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/creating-and-funding-an-ewc-account.md) has been prepared and that it has enough [EWT to fund](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/creating-and-funding-an-ewc-account.md#funding-an-ewc-account) the on-chain transactions.
{% endhint %}

It is important to identify in advance which roles are actually required when setting-up the DDHub Client GW.

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F6vWnIg2Kp57vXeW0GdwX%2Fimage.png?alt=media&amp;token=fd4a6eae-a840-44ba-845a-963810cee2ba" alt="" width="563"><figcaption><p>Enterprise User Role Categories</p></figcaption></figure>

There will be two (2) enterprise user role categories to keep in mind:

1. DDHub Message Broker Role
2. Application-level Enterprise User Role

## DDHub Message Broker Role

In order to gain basic access to the DDHub Message Broker, the following roles are needed:

* `user.roles.mb.apps.ddhub.energyweb.auth.ewc` - basic role requirement in order to gain access to the message broker
* `topiccreator.roles.mb.apps.ddhub.energyweb.auth.ewc` - *<mark style="color:purple;">optional</mark>* role in order to gain write access to the topic management APIs of the message broker

## Application-level Enterprise User Role

{% hint style="info" %}
The enterprise user must acquire first the DDHub Message Broker role for these application-level enterprise user roles to take effect in the Digital Spine ecosystem.
{% endhint %}

Application-level enterprise user roles are necessary to gain access to the data schemas of the target applications or projects. These roles must be identified in advance and must be created by the application or project owner/s.

Please refer to [ENS in Digital Spine Ecosystem](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/energy-web-name-service-ens/ens-in-digital-spine-ecosystem.md#enterprise-namespaces) for more details on the creation of these roles.

## Acquiring enterprise user roles

To acquire enterprise user roles, there are two (2) options available:

1. [Request via DDHub Client GW UI using the Role Management module](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/acquiring-an-enterprise-user-role/request-role-using-ddhub-client-gateway-ui.md)
2. [Request via Switchboard](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/acquiring-an-enterprise-user-role/request-role-using-switchboard.md)

{% hint style="success" %}
For DDHub Message Broker `user` role, the DDHub Client GW Admin can request it right [after setting-up the private key](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/acquiring-an-enterprise-user-role/request-user-role-after-setting-up-the-private-key.md) using the DDHub Client GW UI.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/ddhub-client-gateway/deployment-guide/preparing-to-set-up-a-client-gateway/acquiring-an-enterprise-user-role.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
