Customers

Overview

When we reference customers, we're talking about your customers. Your organization creates integrations, and then deploys instances of your integrations to your customers. You can create users for your customers and assign them roles so that they can have insight into the instances that you deploy to them.

Like all Prismatic resources, customers can be managed via Prismatic's CLI tool, prism, or through the web app by clicking the Customers link on the left-hand sidebar.

Creating New Customers

Web App

After clicking on the Customers link on the left-hand sidebar, click the + Customer button on the upper-right. Enter an appropriate name and description for your customer.

CLI

To create new customers, use the prism customers:create subcommand.

prism customers:create \    --name 'FTL Rockets' \    --description 'Faster-Than-Light Rocket Inc'

API

Create a new customer using the createCustomer mutation:

mutation {  createCustomer(    input: { name: "FTL Rockets", description: "Faster-Than-Light Rocket Inc" }  ) {    customer {      id    }  }}

Searching Customers

Web App

After clicking the Customers link on the left-hand sidebar, you can enter a portion of a customer's name into the search bar to filter customers by name. To filter customers by description instead, click the Filters button to the right of the search bar.

CLI

You can list customers using prism customers:list, and can --filter or --sort the results:

prism customers:list --filter "Name=Smith Rocket Company"

API

Query customers for a list of customers:

query {  customers {    nodes {      id      name      description    }  }}

Modifying Customers

After clicking the Customers link on the left-hand sidebar, you will be presented with a list of your customers.

Clicking the name of any customer will bring you to the customer's page. This page contains a menu with options to manage instances assigned to the customer, alert monitors, logs, credentials, customer users, and file attachments.

Editing Customer Name, Description and Logo

Web App

From the customer's page click the customer's name on the top of the page to change the customer's name. To modify the longer description of the customer, click into the Summary tab. To modify the customer's avatar icon, click the customer's avatar on the top of the page next to the customer's name. The avatar icon you upload will be resized and cropped to 500 x 500 pixels. Transparent PNG images tend to look the best.

CLI

Update the customer name or description from the command line using the prism customers:update subcommand with the customer's ID:

prism customers:update \    Q3VzdG9tZXI6OWQxYzBmODEtY2Q4My00ZTBhLWE1NGEtMjM5EXAMPLE \    --name "New Customer Name" \    --description "New Customer Description"

API

Use the updateCustomer mutation to update a customer:

mutation {  updateCustomer(    input: {      id: "Q3VzdG9tZXI6ZDIyOGUwNjItYzc0NC00NDFkLWE0MDMtNjQ1NTU4MDQ1OTZk"      name: "New Customer Name"      description: "New customer description"    }  ) {    customer {      id    }  }}

Deploying Instances to a Customer

An instance of an integration is a versioned copy of an integration that is configured and deployed to a specific customer. Config variables and credentials that are unique to the customer can be applied to an instance.

For more information on attaching config variables and credentials, see the instances page.

Web App

From the customer's page select the Instances tab. There, you will see any instances currently deployed to your customer, with information on when they were last run, what versions are deployed, etc.

To deploy a new instance, click the + Instance button on the top-right corner. Select the integration you wish to deploy, and give the instance an appropriate name and description.

Once the instance is created, you will be prompted to configure any config variables and credentials required by the integration.

CLI

To deploy an instance to a customer, use the prism instances:create subcommand.

# Get the Customer IDCUSTOMER_ID=$(    prism customers:list \        --columns id \        --filter 'name=FTL Rockets' \        --no-header)
# Get the Integration IDINTEGRATION_ID=$(    prism integrations:list \        --columns id \        --filter 'name=Fabricate 3D Model' \        --no-header)
# Create the instanceprism instances:create \    --customer ${CUSTOMER_ID} \    --integration ${INTEGRAION_ID} \    --name 'Fabricate 3D Model for FTL Rockets' \    --description 'Queue the 3D printing job for a model rocket'

API

Use the createInstance mutation to deploy an instance of an integration to a customer:

mutation {  createInstance(    input: {      name: "My Instance"      description: "Deployment of my integration"      integration: "SW50ZWdyYXRpb246ZDgwZjkyYmEtNTEyZS00N2IxLWEzMzgtZTAxOGE1OGNkMDRi"      customer: "Q3VzdG9tZXI6MmM4YmUxZDgtOTU5Ny00MTI3LWI5MTUtYjBmMjc3Y2YyNWYw"    }  ) {    instance {      id    }  }}

For More Information: Instances and Configuration-Driven Integration Quickstart

Managing Alert Monitors

Alert monitors allow you to send alerts to your team when an alert trigger fires on an instance.

For example, you may want to your DevOps team to be alerted via text message when an instance fails to run, or you may want your project management team to be emailed when an instance is enabled.

Web App

From the customer's page select the Monitors tab. There, you will see any monitors currently deployed to your customer, with information on if/when it was last triggered, which instance it is associated with, and what triggers the monitor.

To deploy a new monitor, click the + Monitor button on the top-right corner. Give the monitor a name and select the instance to attach to, and trigger that will activate this alert.

After creating the new monitor, select the users to alert or webhooks to invoke when the monitor is triggered from the Summary tab. You can add additional triggers that will trigger an alert. When you are finished editing the alert, be sure to click Save to save your changes.

CLI

To create an alert monitor on an instance, identify the alert trigger ID, instance ID, and groups, users, or webhooks you want to alert.

# Create an alert monitor for Alex if the "Fabricate 3D Model" instance failsprism alerts:monitors:create \    --users "[\"$(prism customers:users:list --columns id --no-header --filter 'Email=alexander.cooper@progix.io')\"]" \    --name 'Alert Alex on Execution Failure' \    --instance $(prism instances:list --columns id --filter 'name=Fabricate 3D Model' --no-header) \    --triggers "[\"$(prism alerts:triggers:list --columns id --filter 'name=Execution Failed' --no-header)\"]"

API

To create an alert monitor for an instance, you will need to query alertTriggers and select which types of triggers should result in an alert:

query listTriggers {  alertTriggers {    nodes {      id      name    }  }}

You will also need the ID of the instance you want to attach the alert to, and the IDs of any users or groups who should be notified. Then, use the createAlertMonitor mutation to create the alert monitor:

mutation(  $name: String!  $instance: ID!  $triggers: [ID]!  $groups: [ID]  $users: [ID]) {  createAlertMonitor(    input: {      name: $name      instance: $instance      triggers: $triggers      groups: $groups      users: $users    }  ) {    alertMonitor {      id    }  }}

Query Variables

{  "name": "Alert Alex and DevOps on Execution Failure",  "instance": "SW5zdGFuY2U6OTc1YzgyMTEtYTIxZi00OTg1LThhODYtMTUxMTczM2ZiYTJh",  "triggers": [    "QWxlcnRUcmlnZ2VyOjhiOTg3YmYxLTk4YmMtNDViNy1hZDFkLTEwNWY0YTExZjdlOA==",    "QWxlcnRUcmlnZ2VyOjdlOWEzMDA2LTQxODItNDQ0MC1iYzE2LTFiNjNjMzI2NzkwZA=="  ],  "groups": ["QWxlcnRHcm91cDo5MDQyYmM1ZC1hYTU5LTQ3Y2EtOWE4NC00NWIxNDBmZjYzYmQ"],  "users": ["VXNlcjo4MzBjZTZmYS1iNDFlLTQ2MTQtODgzNi04NjA1MTcyY2IyOTc="]}

For More Information: Alert Monitors

Accessing Customer Logs

At Prismatic we believe verbose and searchable logs are critical to any software ecosystem. Logs of all instance invocations are stored for all customers, and are searchable and filterable.

To access logs of instances for a specific customer, open the customer's page and select the Logs tab.

You can search log messages using the search bar on the top of the page.

Logs can be filtered by clicking the Filter button to the right of the search bar. You can filter logs by:

• Log Severity (Error, Warn, Info, or Debug)
• Date/time Range
• Integration Name

Clicking on a log line will open a pane with the full message of the log.

For More Information: Logging, Log Retention, Logging from Custom Components

Viewing Instance Execution Results

It's useful for debugging purposes to be able to see execution results of instance invocations. Click the Executions tab from a customer's page to see the logs and step outputs of all instances deployed to that customer.

Managing Customer Credentials

Credentials store login information for the services your integrations interact with. For example, a customer might have Dropbox OAuth2 tokens or AWS access keys in their credential store.

Web App

From the customer's page select the Credentials tab. You will see a list of credentials that are saved for that customer.

To add new credentials for a customer, click the + Credential button. Enter the authorization method appropriate for your use case.

After selecting the authorization method, and clicking add you will be prompted to enter username, password, or API key values, etc., depending on the authorization method you chose. Be sure to click Save after editing a credential to save your changes.

Credentials can be deleted by clicking the credential from the credentials tab and clicking the Delete Credential button.

CLI

To list all credentials associated with a customer, use the prism customers:credentials:list subcommand.

# Get your customer's IDCUSTOMER_ID=$(    prism customers:list \        --columns=id \        --filter 'Name=FTL Rockets' \        --no-header)
# List that customer's credentialsprism customers:credentials:list --customer ${CUSTOMER_ID}

To add a new credential set to a customer, identify the authorization method for the credentials you want to create, then use the prism customers:credentials:create subcommand.

# Get your customer's IDCUSTOMER_ID=$(    prism customers:list \        --columns=id \        --filter 'Name=FTL Rockets' \        --no-header)
# Get the ID for the 'basic' authorization typeAUTH_METHOD_ID=$(    prism authorizationMethods:list \    --columns id \    --filter 'Key=basic' \    --no-header)
# Create basic auth credentialsprism customers:credentials:create \    --label 'User/pass for website.com/resource' \    --authorizationMethod ${AUTH_METHOD_ID} \    --customer ${CUSTOMER_ID} \    --fields '{"username": "myuser", "password": "MyP@$sW0Rd!"}'

API

To create a new set of credentials for your a customer, first find the ID of the authentication method (basic, api_key, etc), that you want to add:

query {  authorizationMethods {    nodes {      id      key      label    }  }}

Then, use the ID to create a new customer credential using the createCustomerCredential mutation:

mutation(  $customer: ID!  $label: String!  $authorizationMethod: ID!  $values: [InputCredentialFieldValue]) {  createCustomerCredential(    input: {      customer: $customer      label: $label      authorizationMethod: $authorizationMethod      values: $values    }  ) {    credential {      id    }  }}

Query Variables

{  "customer": "Q3VzdG9tZXI6MmM4YmUxZDgtOTU5Ny00MTI3LWI5MTUtYjBmMjc3Y2YyNWYw",  "label": "User/pass for website.com/resource",  "authorizationMethod": "QXV0aG9yaXphdGlvbk1ldGhvZDo0OWUwMTUzYS00OGM0LTQxYzktYWY1YS1kNzIxODhkN2UyNDU=",  "values": [    { "key": "username", "value": "myuser" },    {      "key": "password",      "value": "MyP@$sW0Rd!"    }  ]}

For More Information: Credentials

Managing Customer Users

Customer users are users at your customer locations who have access to instances deployed to them. Depending on the role you assign to the user, the user might have read or write access to their instances. That means that you can grant permission to your customers to update instances that are deployed to them, so they can do things like update config variables or credentials to third-party APIs without needing you to intervene.

Customer users' accounts are limited in scope. They cannot view instances belonging to your other customers, nor see organization-level resources.

Web App

Users for your customers are managed by opening a customer's page and selecting the Users tab.

New users can be added by clicking the +User button. Enter the user's name and email address and give the user an appropriate role. More information about customer user roles can be found on the users page.

When users are added, they receive an email confirmation that will prompt them to log in and set their password and optional phone number.

To delete a user, select the user from the Users tab. Click the Delete Account on the bottom of the page.

CLI

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

# Get your customer's IDCUSTOMER_ID=$(    prism customers:list \        --columns=id \        --filter 'Name=FTL Rockets' \        --no-header)
# List that customer's usersprism customers:users:list --customer ${CUSTOMER_ID}

To add a new customer, use the prism customers:users:create subcommand. More information about user roles can be found on the users page.

# Get your customer's IDCUSTOMER_ID=$(    prism customers:list \        --columns=id \        --filter 'Name=FTL Rockets' \        --no-header)
# Get the ID of the "Admin" roleROLE_ID=$(prism customers:users:roles \            --columns id \            --no-header \            --filter 'name=Admin')
# Create a user "Lisa Nguyen" that has the "Admin" roleprism customers:users:create \    --email 'lisa.nguyen@ftl-rockets.com' \    --name 'Lisa Nguyen' \    --customer ${CUSTOMER_ID} \    --role ${ROLE_ID}

API

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

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

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    }  }}

Delete a user using the deleteUser mutation:

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

For More Information: Users

Using Customer Attachments

Attachments are a place to store documents that both customers and your team members can reference. After opening a customer's page select the Attachments tab.

Documents can be added using the +ADD ATTACHMENT button, and deleted by clicking the

delete icon.

Deleting Customers

Deleting a Customer is Permanent

When a customer is deleted, all associated users, credentials, and instances are also deleted. Use caution when deleting customers.

Web App

After clicking on the Customers link on the left-hand sidebar, click the name of the customer you would like to delete, and then select the Summary tab.

Verify that the name shown matches the customer you wish to delete, and click the Delete Customer button. Confirm your choice by typing the customer name exactly, and then click REMOVE CUSTOMER.

CLI

To delete a customer, use the prism customers:delete subcommand.

# Get the customer's IDCUSTOMER_ID=$(prism customers:list \                --columns id \                --filter 'name=FTL Rockets' \                --no-header)
prism customers:delete ${CUSTOMER_ID}

API

Delete a customer using the deleteCustomer mutation:

mutation {  deleteCustomer(    input: {      id: "Q3VzdG9tZXI6ZDIyOGUwNjItYzc0NC00NDFkLWE0MDMtNjQ1NTU4MDQ1OTZk"    }  ) {    customer {      id    }  }}