Skip to main content

Organization management via CLI

This document explains howto manage end-customer organizations using the inctl command-line interface.

Prerequisites​

Before you begin, ensure that you have a working development environment and have authenticated to your organization using inctl. Additionally, you need to have the orgCreator role for your solution-builder organization. Intrinsic will provide the initial setup for you through customer support.

Create an end-customer organization​

The following command creates a new end-customer org that your solution-builder org will manage. The entire creation workflow can take up to 10 minutes to complete.

inctl customer create --display-name="Test EC Customer" --org=<your-org>

Running the command will produce output similar to the following:

Creating organization with random identifier (display name: "Test EC Customer").
Waiting for operation ("operations/d3r...") to complete (600.0 seconds timeout, 5s poll interval).
Waited 295.1 seconds for operation.
Created organization with identifier "d3samnj1ap7c72rgeptg".

Please take a note of the identifier as subsequent commands will require it.

You will receive an email confirmation shortly after completion.

List organizations​

inctl customer list --org=<your-org>

Look for the Name column in the output table — it contains the organization identifier you'll need when running inctl commands for that organization.

Manage members​

Once you have created an organization, you can add users that can work in the context of the new organization.

inctl customer add-user --email=<email> --customer=<customer-org> --org=<your-org>

The above command will send an invitation to the user by email, allowing the recipient to verify the email and join the organization.

We can list the members of the organization, including their membership status. The status field will tell us whos invitation is still pending.

inctl customer list-users --customer=<customer-org> --org=<your-org>
Email              Roles Status  Token
<email-1>                active
<email-2>                pending 5f3aa404-2058-41e6-aff4-9252ba6d62e7

Finally, you can also remove users from the organization.

inctl customer remove-user --customer=<customer-org> --email=email>

Next steps​

You can find additional commands in the documentation of the inctl customer command.