Skip to main content

Users

Overview#

Two types of users can log into Prismatic systems:

  • Organization users are team members who work at your company. They are responsible for building, deploying, and supporting integrations for your customers. They might include your developers, devops engineers, project managers, support technicians, etc.

    Organization users have permission to view information about your customers and their users, instances, and alert monitors. Depending on their role, some organization users have permission to manage customer resources, as well.

    A full list of organization team member permissions can be found below.

  • 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.

Organization Users#

Organization users are team members who work at your company. They are responsible for building, deploying, and supporting integrations for your customers, and can be granted a set of permissions based on the role they are assigned.

Organization Team Member Roles#

Organization users can be granted a variety of roles:

  • An organization owner is a super-user, and can manage all aspects of an organization (users, customers, integrations, billing, etc.).
  • An organization admin has all the permissions of an owner, except the ability to make changes to the organization and manage billing. This role is generally granted to user management teams (like your IT team).
  • An organization integrator can manage customers, integrations, and instances. Most developers, DevOps, implementation technicians, etc., will have this role.
  • An organization guest is a read-only user who can view information about customer instances, but cannot modify anything. This is a good role for a support technician who needs to view logs, but shouldn't necessarily be able to modify instance configuration.
  • An organization third-party user is used when you are integrating with a third-party app or service and would like to grant limited access to a user from that third-party to specific integrations, components, or customers. The third-party role is described in more detail below.
OwnerAdminIntegratorGuestThird-Party
View Customersxxxx?
View Customer Usersxxxx
View Customer Instancesxxxx
View Alert Monitorsxxxx
Manage Customersxxx
Manage Customer Usersxxx
Manage Componentsxxx?
Manage Instancesxxx?
Manage Integrationsxxx?
Manage Organization Usersxx
Manage Organizationx
Manage Billingx

Managing Organization Users#

Only organization users with admin or owner roles can manage organization users.

To manage organization users in the web app, click Settings on the left-hand sidebar, and select the Team Members tab.

Listing Organization Users#

Organization users are listed under the Team Members 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.

Adding Organization Users#

From the Team Members tab, click the + Team Member 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.

After creating the new user, they will receive a confirmation email with a link to set up their profile and set their password.

Changing an Organization User's Role, Name, Avatar Picture or Phone Number#

From the Team Members tab, click the name of a user. You can change the role of the user, or the user's name, phone number or avatar picture under the Summary tab. After modifying a team member be sure to click Save to save your changes.

Deleting Organization Users#

From the Team Members tab, click the name of a user. Select the Summary tab within that user's page and click the Delete Account link on the bottom of the page. Confirm the deletion by clicking the REMOVE ACCOUNT button.

Third-Party Users#

It's often helpful and necessary to get people from third-party vendors involved as you build, test, and debug your integrations with them. Granting third-party vendors the ability to view and test specific integrations and components allows you to develop your integrations much faster and lets you, them, and your customers stay "on the same page" with regards to development progress and the flow of data between your systems.

Creating Third-Party Users#

Organization users with admin or owner permissions can create new organization-level users with the third-party role. This role is very limited in scope - by default third-party users can only edit their own profile information and view built-in components. They cannot view information about your custom components, integrations, or customers. Once the user is created, they can be granted additional permissions to interact with specific resources.

You can create a third-party user as you would any other organization-level user, by clicking Settings on the left-hand sidebar and then clicking + TEAM MEMBER. Give the new user a role of Third-Party.

Granular Access for Third-Party Users#

To grant access to specific resources, like integrations, custom components or customers, click Settings on the left-hand sidebar and then Team Members. Select the third-party user you would like to grant access to, and click into the Granular Access tab.

From here, you can grant the user access to specific integrations, components, or customers by clicking the + PERMISSION button on the top-right.

Integration Access#

The most common use case for third-party users is to allow a third-party vendor to view, and possibly edit and test an integration. That way, they can test invoking an integration in Prismatic from their third-party service and can verify that the data the integration receives is in the format you agreed upon.

Giving integration access to a third-party vendor also allows you to see what sort of attempts are being made on their end to make sure the integration works. You can view logs of each test a third-party vendor performs to give you a sense of how their side of the integration development is progressing, and if and when you jump on calls with your mutual customer and the third party, you can test and debug issues quickly (rather than relying on email chains that drag on for weeks).

To grant a third-party vendor access to a specific integration, select Integration from the + PERMISSION dialogue, then search for and select the integration you want to give permissions for.

On the next screen select the types of permissions you would like to grant for that integration. If you would like to give read-only access to your integration, select View Integration. If you would like the third-party user to be able to edit the integration, select Edit Integration.

The third party user will then be able to see the integration that they've been granted permission to see, but all other integrations will remain hidden from them. This is handy if you are integrating with multiple competing vendors - the third-party vendors cannot see one another's integrations (or even know they exist).

You must grant access to relevant custom components, as well

If you give a third-party user access to an integration that uses custom components, you must also grant them access to those custom components, as well.

Component Access#

Similar to integrations, you can grant third-party users access to specific custom components. By default, third-party users have access to Prismatic built-in public components, but you may not want third-party vendors to see all of the custom components you've published (especially if you integrate with several competing vendors).

To grant a third-party user access to a custom component, select Component after opening the + PERMISSION dialogue, and then search for and select the component you would like to grant access to.

You can grant a variety of component-related permissions to a third-party user. If they are assisting in the development of the custom component, they will need the Edit Component permission. Otherwise, to use the component in an integration they will just need the View Component permission.

Custom components that are not granted to a user are not visible. This is once again handy if you are integrating with several competing companies, or your own competitors - their users will not be able to see what other custom components you've published.

Customer Access#

You can grant a third-party user access to a specific customer. This is handy if you and another vendor share a customer in common, and are working on an integration together for that customer.

To grant permissions to a specific customer, select Customer after clicking + PERMISSION and then select the customer you'd like to grant permissions for.

Next, select the permissions on this customer you would like to grant. There are a variety of options, each with a description below them. You can elect to let the third-party user view or manage the customer, the customer's users, and the instances deployed to the customer.

read-only access grants viewing of customer credentials

Note that if you grant the View Customer permission on a customer to a third-party user, that user can view the customer's saved credentials.

Permissions are scoped to a specific customer. That way, if you are developing an integration with a competing software vendor they will not be able to view information about the other customers in your system.

Customer Users#

Customer users are users who work for your customers. They are granted permissions to manage only the users and instances of integrations that have been deployed to them.

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 modify, enable/disable, or monitor 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 role, and is permitted to deploy and manage integrations that are deployed to them. Note: marketplace users are not assigned credentials and cannot log in to Prismatic, except through the embedded integration marketplace.
AdminMemberMarketplace
View Customer Usersxx
Manage Customer Usersx
View Instancesxxx
View Instance Logsxxx
Configure Instancesxx
Test Instancesxx
Configure Alertingx

Managing Customer Users#

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#

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.

Adding a Customer User#

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.

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 Summary tab. You can also change the user's name, avatar picture, or phone number under the Summary tab.

Deleting a Customer User#

From the specific customer's Users tab, click the name of a user. Open the Summary tab, and click the Delete Account button on the bottom of the page. Confirm the account removal by clicking the REMOVE ACCOUNT button.

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.

Managing Your Own User Profile#

You can update your name, password, phone number, avatar image, and light/dark mode preferences. Start by clicking the

icon on the top-right side of the screen. All user profile preferences are available in the Password and Summary tabs.

Updating Your Password#

After clicking the

icon on the top-right side of the screen and selecting Profile, open the Password tab. Enter your current password, and then select a new password. Your password must have:

  • At least 8 characters
  • At least one upper case letter
  • At least one lower case letter
  • At least one number

Resetting a Forgotten Password#

If you have forgotten your password, navigate to https://app.prismatic.io. If you are not logged out, do so by clicking the

icon on the top-right side of the screen and selecting Logout.

Click LOG IN, enter your email address, and then select Don't remember your password?. Enter your email address and then select SEND EMAIL >. You will be emailed a password reset link where you can create a new password.

Updating Your Name, Avatar Picture, or Phone Number#

After clicking the

icon on the top-right side of the screen, select the Summary tab. You can alter your name or phone number from this screen. If you provide a phone number, it can be used by your team members for monitoring and alerting purposes. If you alter your avatar image, the image you upload will be resized and cropped to 500 x 500 pixels. Transparent PNG avatar images tend to look the best.

Setting Light or Dark Mode#

By default, the web app will present light or dark mode so that it matches your operating system settings. If you would like to override the light/dark mode setting, click the

icon on the top-right side of the screen, select the Summary tab. Uncheck the Sync light/dark mode with OS setting checkbox, and toggle light / dark mode.

Light / dark mode settings follow your user, so if you set a preference on one computer, that preference will be remembered if you log in from another computer.

Syncing Customer Users to Prismatic Programmatically#

Similar to syncing customers programmatically, if you manage customer users in an external system you can sync those users to Prismatic programmatically. Though this tutorial is about syncing customers to Prismatic, the concepts are similar for syncing users: Syncing Customers to Prismatic.

To list customer users, use the users query, and give it the argument customer_Isnull: false to indicate that you want customer users:

users(customer_Isnull: false) {  edges {    node {      id      name      email      externalId    }  }}

To create new users, look up a customer's ID and the role that you want the user to have, and then invoke the createCustomerUser mutation along with the user's email, name, and optional phone number. You can also specify an externalId if you would like users in Prismatic to easily correspond to users in an external system.

To update customer users, use the updateUser mutation, and to delete a user use the deleteUser mutation.