Domains

Magistrala CLI provides a simple and efficient way to manage domains. Below are the key commands to manage domains within your system.

Create Domain

To create a new domain:

magistrala-cli domains create <domain_name> <domain_alias> <user_token>

In this command:

<domain_name> is the name you want to give to the new domain.
<domain_alias> is the unique alias for the new domain.
<user_token> is your user token.

Here's an example creating a new domain with the name mydomain and the alias myalias with the user access token stored in the token environment variable:

magistrala-cli domains create "mydomain" "myalias" token

After running the command, you should see output similar to this:

{
  "alias": "myalias",
  "created_at": "2025-02-12T18:36:44.284205Z",
  "created_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b",
  "id": "16a4ad70-a385-45c5-b50a-6d7e48d768d7",
  "name": "mydomain",
  "status": "enabled",
  "updated_at": "0001-01-01T00:00:00Z"
}

Get Domain

To view a single domain:

magistrala-cli domains get <domain_id> <user_token>

where:

<domain_id> is the unique identifier of the domain you want to retrieve information about.
<user_token> is your user token.

For example

magistrala-cli domains get 16a4ad70-a385-45c5-b50a-6d7e48d768d7 token

The ouptut should look like:

{
  "alias": "myalias",
  "created_at": "2025-02-12T18:36:44.284205Z",
  "created_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b",
  "id": "16a4ad70-a385-45c5-b50a-6d7e48d768d7",
  "name": "mydomain",
  "status": "enabled",
  "updated_at": "0001-01-01T00:00:00Z"
}

Get Domains

To list all domains:

magistrala-cli domains get all <user_token>

For example

magistrala-cli domains get all token

After running this command, you will receive information about all domains. The output should look something like this:

{
  "domains": [
    {
      "alias": "Domain1",
      "created_at": "2025-02-12T09:45:58.269568Z",
      "created_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b",
      "id": "9879f314-8b0a-4a11-b157-8523491ffa81",
      "name": "domain1",
      "status": "enabled",
      "updated_at": "0001-01-01T00:00:00Z"
    },
    {
      "alias": "myalias",
      "created_at": "2025-02-12T18:36:44.284205Z",
      "created_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b",
      "id": "16a4ad70-a385-45c5-b50a-6d7e48d768d7",
      "name": "mydomain",
      "status": "enabled",
      "updated_at": "0001-01-01T00:00:00Z"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total": 2
}

Update Domain

To update a domain’s name, alias, and metadata:

magistrala-cli domains update <domain_id> '{"name" : "<new_domain_name>", "alias" : "<new_domain_alias>", "metadata" : "<new_metadata>"}' <user_token>

In this command:

<domain_id> is the unique identifier of the domain you want to update.
<new_domain_name> is the new name you want to give to the domain.
<new_domain_alias> is the new alias for the domain.
<new_metadata> is the new metadata for the domain.
<user_token> is your user token.

Here's an example in which we're updating the domain with the ID 16a4ad70-a385-45c5-b50a-6d7e48d768d7 to have the name domain_name instead of mydomain, the alias domain_alias instead of myalias, and adding new metadata {"location" : "london"}.

magistrala-cli domains update 16a4ad70-a385-45c5-b50a-6d7e48d768d7 '{"name" : "domain_name", "alias" : "domain_alias", "metadata" : {"location" : "london"}}' token

After running the command, you should see an output similar to this:

{
  "alias": "domain_alias",
  "created_at": "2025-02-12T18:36:44.284205Z",
  "created_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b",
  "id": "16a4ad70-a385-45c5-b50a-6d7e48d768d7",
  "metadata": {
    "location": "london"
  },
  "name": "domain_name",
  "status": "enabled",
  "updated_at": "2025-02-12T18:44:12.799923Z",
  "updated_by": "6ccaf13c-ef88-4cf2-8e3a-c7c04c5eaf9b"
}

Disable domain

To change a domain status from enabled to disabled:

magistrala-cli domains disable <domain_id> <user_token>

In this command:

<domain_id> is the unique identifier of the domain you want to disable.
<user_token> is your user token.

For example,

magistrala-cli domains disable 16a4ad70-a385-45c5-b50a-6d7e48d768d7 token

Expect the result to be an ok response.

Enable domain

To enable a domain:

magistrala-cli domains enable <domain_id> <user_token>

In this command:

<domain_id> is the unique identifier of the domain you want to enable.
<user_token> is your user token.

For example,

magistrala-cli domains enable 16a4ad70-a385-45c5-b50a-6d7e48d768d7 token

List Domain users

magistrala-cli domains users <domain_id>  <user_token>

For example, if your domain ID is 16a4ad70-a385-45c5-b50a-6d7e48d768d7 and your user token is stored in the token environment variable, you would type:

magistrala-cli domains users 16a4ad70-a385-45c5-b50a-6d7e48d768d7 token

After you run this command, the system will show you a list of users in the domain, like this:

{
  "limit": 10,
  "offset": 0,
  "total": 2,
  "users": [
    {
      "created_at": "2024-03-21T08:06:55.232067Z",
      "credentials": {
        "identity": "user1@email.com"
      },
      "id": "6a8c0864-1d95-4053-a335-a6399c0ccb0a",
      "metadata": {
        "location": "london"
      },
      "name": "user1",
      "status": "enabled",
      "tags": [
        "male",
        "developer"
      ],
      "updated_at": "2024-03-25T10:31:26.557439Z"
    },
    {
      "created_at": "2024-03-25T09:21:03.821017Z",
      "credentials": {
        "identity": "user3@example.com"
      },
      "id": "78411c55-adfe-4940-bbbf-e973d60a4e14",
      "name": "user3",
      "status": "enabled",
      "updated_at": "0001-01-01T00:00:00Z"
    }
  ]
}

This output tells you that there are currently 2 users in the domain.

Create Domain

Get Domain

Get Domains

Update Domain

Disable domain

Enable domain

List Domain users

On this page