Customer Users

Customer users

Customer users are users at your customers' sites. Customer users' permissions are limited in scope. They can view and manage users and the instances of integrations that have been deployed to them, but they cannot view your other customers' resources.

Customer users can be granted permission to update instance configuration, so they can modify config variables and credentials tied to an instance on their own without requiring your direct support.

Customer user roles

Customer users can be granted one of two roles:

• A customer admin can manage their users and the instances that have been deployed to them. Grant a customer user this role if you would like them to be able to deploy, modify, enable or disable instances of integrations deployed to them.
• A customer member is a read-only account that can view information about users and instances that have been deployed to them. This is a good role for customer users who should be able to view logs, but who shouldn't be permitted to modify instances.
• A customer that is created through an Embedded Marketplace is automatically assigned the marketplace admin role, and is permitted to deploy and manage integrations that are deployed to them. A marketplace user only has the ability to configure their own User level configuration for an instance. Note: marketplace users are not assigned credentials and cannot log in to Prismatic, except through the embedded integration marketplace.

	Admin	Member	Marketplace Admin	Marketplace User
View Customer Users	x	x
Manage Customer Users	x
View Instances	x	x	x
View Instance Logs	x	x	x
Configure Instances	x		x
Test Instances	x		x
Configure ULC			x	x

Managing customer users

you do not need to create embedded customer users

Note that it is uncommon to create customer users manually, and you should only do so if you intend for your customer users to log in to Prismatic's web app.

Most of the time, your users will interact with Prismatic through an Embedded Marketplace. You do not need to create embedded users manually - a user will be automatically created when they authenticate within your app.

Only customer users with the admin role or organization users with integrator, admin, or owner roles can manage customer users.

To manage customers users in the web app, click Customers on the left-hand sidebar, select a customer from that list and open the customer's Users tab.

If you are a customer user with the admin role, click the Team Members link on the left-hand sidebar to manage your users.

Listing customer users

Web App

Users for a specific customer are listed on the main customer's Users tab. You can filter what users are shown by typing the name of a user into the search bar on the top of the page. You can also filter by email address by clicking the Filter link to the right of the search bar.

CLI

To list users with the Prismatic CLI tool, use the prism customers:users:list subcommand.

List all users of customer 'FTL Rockets'

# Get your customer's ID
CUSTOMER_ID=$(prism customers:list \
                --columns=id \
                --filter 'Name=^FTL Rockets$' \
                --no-header)

# List that customer's users
prism customers:users:list --customer ${CUSTOMER_ID}

 Name        Email
 ─────────── ───────────────────────────
 Jim Simms   james.simms@ftl-rockets.com
 Lisa Nguyen lisa.nguyen@ftl-rockets.com

API

To list all customers query customers, or query customer for a specific customer's users:

query {
  customers {
    nodes {
      name
      users {
        nodes {
          name
          email
        }
      }
    }
  }
}

Adding a customer user

Web App

From the customer's Users tab, click the + User button in the upper-right. Select an appropriate role for the new user (see above for permissions), and provide a name and email address for the user.

CLI

To add a new customer, use the customers:users:create subcommand. You can use customers:list to get a customer's ID, and customers:users:roles to get a desired role ID.

Add a new 'Admin' user for customer 'FTL Rockets'

# Get your customer's ID
CUSTOMER_ID=$(prism customers:list \
                --columns=id \
                --filter 'Name=^FTL Rockets$' \
                --no-header)

# Get the ID of the "Admin" role
ROLE_ID=$(prism customers:users:roles \
            --columns id \
            --no-header \
            --filter 'name=Admin')

# Create a user "Lisa Nguyen" that has the "Admin" role
prism customers:users:create \
    --email 'lisa.nguyen@ftl-rockets.com' \
    --name 'Lisa Nguyen' \
    --customer ${CUSTOMER_ID} \
    --role ${ROLE_ID}

API

To create a new customer user, use the createCustomerUser mutation. You will need to know the ID of the role you want to assign the user, as well as the ID of the customer:

mutation {
  createCustomerUser(
    input: {
      name: "Lisa Nguyen"
      email: "lisa.nguyen@ftl-rockets.com"
      role: "Um9sZTplMTRlZjUzNC0yOTZiLTQ4MjAtYjhmNS1jZjQ1Zjg4N2I0YjM="
      customer: "Q3VzdG9tZXI6ZDIyOGUwNjItYzc0NC00NDFkLWE0MDMtNjQ1NTU4MDQ1OTZk"
    }
  ) {
    user {
      id
    }
  }
}

Changing a customer user's role, name, avatar picture or phone number

From the customer's Users tab, click the name of a user. Like organization users, you can change the role of a customer user under the Details tab. You can also change the user's name, avatar picture, or phone number under the Details tab.

Deleting a customer user

Web App

From the specific customer's Users tab, click the name of a user. Open the Details tab, and click the Delete user button on the bottom of the page. Enter the Confirmation text and click the Remove user button to confirm the removal.

CLI

You can find the ID of the user to delete through the customers:users:list subcommand, and can delete the user with the customers:users:delete subcommand.

Delete customer user 'Lisa Nguyen'

USER_ID=$(prism customers:users:list \
            --customer EXAMPLEtZXI6NTRlNDQyMDgtNTJiNi00ZGVhLTgyODYtOWRkNDU4MTA2ZTYw \
            --columns id \
            --no-header \
            --filter 'Email=lisa.nguyen@ftl-rockets.com')

prism customers:users:delete ${USER_ID}

API

mutation {
  deleteUser(
    input: { id: "VXNlcjpmYjFiNDMyZC0zN2Y5LTQyZTUtOTljNy1hNjc1ZWIzZGUyNTA=" }
  ) {
    user {
      id
    }
  }
}

Searching all customer users

You can search for users on a per-customer basis from the customer's Users tab. To search users of all customers, click the Users link on the left-hand sidebar. To search for a user by name, enter their name in the search bar on the top of the page. To search for a user by email, click the Filter link on the top of the page.