Administering your SiteWise Monitor portals - Amazon IoT SiteWise
Changing a portal's name, description, branding, support email, and permissionsAdding or removing portal administratorsSending email invitations to portal administratorsAdding or removing portal usersDeleting a portal
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Administering your SiteWise Monitor portals

You might need to update portal details, change administrators, or add users to your portals. This section explains how you can complete these basic administrative tasks for your SiteWise Monitor portals.

  1. Sign in to the Amazon IoT SiteWise console.

  2. In the navigation pane, choose Monitor, Portals.

    Left navigation pane in the Amazon IoT SiteWise console with Portals highlighted.

  3. Choose a portal, and then choose View details (or choose the portal's Name).

  4. You can perform any of the following administrative tasks:

For information about how to create a portal, see Getting started with Amazon IoT SiteWise Monitor.

Changing a portal's name, description, branding, support email, and permissions

You can change a portal's name, description, branding, support email, and permissions.

  1. On the portal details page, in the Portal details section, choose Edit.

    Portal details section of the portal details page with Edit highlighted.

  2. Update the Name, Description, Portal branding, Support contact email, or Permissions.

  3. When you're finished, choose Save.

Adding or removing portal administrators

In a few steps, you can add or remove users as administrators for a portal. Based on the user authentication service, choose one of the following options.

IAM
Portal administrators section of the portal details page.

To add portal administrators

  1. On the portal details page, in the Portal administrators section, choose Assign administrators.

  2. On the Assign administrators page, do the following:

    • Choose IAM users, if you want to add an IAM user as your portal administrator.

    • Choose IAM roles, if you want to add an IAM role as your portal administrator.

  3. Select the check boxes for the users or roles that you want as your portal administrators. This adds the users or roles to the Portal administrators list.

  4. Choose Assign administrators.

Important

IAM users or roles must have the iotsitewise:DescribePortal permission to sign in to the portal.

The "Assign administrators" page.
The "Assign administrators" page.

To remove portal administrators

  • On the portal details page, in the Portal administrators section, select the check box for each user to remove, and then choose Remove from portal.

    Note

    Leaving a portal without a portal administrator is not recommended.

Sending email invitations to portal administrators

You can send email invitations to portal administrators.

  1. On the portal details page, in the Portal administrators section, select the check boxes for the portal administrators.

    Portal administrators section of the portal details page with "Send invitations" highlighted.

  2. Choose Send invitations. Your email client opens, and an invitation is populated in the message body.

    You can customize the email before you send it to your portal administrators.

Adding or removing portal users

You choose which users have access to your portals. Portal users appear in the list of users within a SiteWise Monitor portal. From this list, portal administrators can add project owners, and project owners can add project viewers.

Note

Your portal administrators and portal users might contact you through a portal's support email if they need you to add or remove a user.

Based on the user authentication service, choose one of the following options.

IAM
Portal administrators section of the portal details page.

To add portal users

  1. On the portal details page, in the Portal users section, choose Assign users.

  2. On the Assign users page, do the following:

    • Choose IAM users to add an IAM user as your portal user.

    • Choose IAM roles to add an IAM role as your portal user.

  3. Select the check boxes for the users or roles that you want to add as your portal users. This adds the users or roles to the Portal users list.

  4. Choose Assign users.

The "Assign users" page.
The "Assign users" page.

To remove portal users

  • On the portal details page, in the Portal users section, select the check box for the users to remove from the portal, and then choose Remove from portal.

Important

IAM users or roles must have the iotsitewise:DescribePortal permission to sign in to the portal.

Deleting a portal

You might delete a portal if you created it for testing purposes or if you created a duplicate of a portal that already exists.

Note

You must first manually delete all dashboards and projects in a portal before you can delete a portal. For more information, see Deleting projects and Deleting dashboards in the SiteWise Monitor Application Guide.

  1. On the portal details page, choose Delete.

    Important

    When you delete a portal, you lose all projects that the portal contains, and all dashboards in each project. This action can't be undone. Your asset data isn't affected.

    Portal details page with Delete highlighted.

  2. In the Delete portals dialog box, choose Remove admins and users.

    You must remove the administrators and users from a portal before you can delete it. If your portal doesn't have administrators or users, the button doesn't appear, and you can skip to the next step.

    "Delete portals" dialog box with "Remove administrators and users" highlighted.

  3. If you're sure that you want to delete the entire portal, enter delete in the field to confirm deletion.

    "Delete portals" dialog box with "Delete" highlighted.

  4. Choose Delete.