Using the Administration Console

The BlackBerry IoT Platform has a simple, web-based application to manage the BlackBerry IoT Platform. The web application is called the administration console. You can access the administration console at https://bbryiot.com/admin. If you manage more than one organization, you can go to the Dashboard and change organization that you want to manage.

Note: The web browsers that the administration console supports are Google Chrome, Mozilla Firefox, and Apple Safari. Microsoft Internet Explorer isn't supported.

Both administrators and developers can use the administration console. Administrators typically use the administration console to manage a production environment for an organization, while developers use it for testing their applications. Here are the typical tasks that administrators and developers use the administration console for:

As you use the administration console to perform various tasks, these are the common user-interface elements that you may see:

Note: Everything that you can do in the administration console can performed using one or more BlackBerry IoT Platform REST APIs. If the BlackBerry IoT Platform administration console doesn't fit into your organization's work flows, you can to build your own administration console using the REST APIs.

Manage organizations

When you first log in to the the administration console, the Dashboard appears. If you don't belong to any organizations, you can request to belong to one or create your own. If you have existing organizations created or belong to other organizations, you can select the organization that you want to manage. After you select an organization, you can create and manage applications, devices, etc. based on your capabilities (permissions). When you want to change your context and manage another organization, you can come back to the Dashboard and select another organization.

Create an organization

You can create one more organizations and then add users to your organizations.

  1. In the administration console, under the MY ORGANIZATIONS area, click Create Organization.
  2. In the Create Organization dialog box, in the Name box, type the name of the organization and click Create. The name of your organization must be at least four characters in length.

After you create an organization, the following is completed for you:

The capabilities given to the Admin tag are transposed to the user who created the organization. The capabilities are required to manage entities (applications, firehoses, devices, users, and tags) and capabilities in that organization. For more information about capabilities, exposing tags, non-exposing tags, see Working with Capabilities and Tags.

Switching to another organization

You can change or switch organizations to which you belong. You may switch to another organization to manage entities that belong to that organization. The organizations that you belong to are listed on the Dashboard under MY ORGANIZATIONS.

  1. While logged in to an existing organization, on the right-hand corner of the page, click your login name and then select Dashboard.
  2. Select the name of the organization that you want to manage.

Configure capability grants and create associations

You can configure the capabilities that can be given to applications, devices, or users and set up whether a capability is inherited by entities that belong to the same organization or the same user. Capabilities control what information is shared and what actions can be performed.

  1. In the administration console, select the organization you want to manage.
  2. In the top-right corner, click your name and then select Organization or click the Organization in the set of tabs.
  3. Click Capabilities and ensure that Given Capabilities is selected.
  4. Click the Add button ("+").
  5. In the Grant Capability On dialog box, in the Action drop-down list, select the capability to grant. You type the name of a capability and suffix it with a period and a string to extend a capability. For information details about the capabilities, see Extended capabilities.
  6. In the Grant Type drop-down list, select the entity to grant the capability to. Select one of the following:
    • Device: To grant capabilities to a specific device.
    • App: To grant capabilities all devices running the specific application.
    • User: To grant capabilities to a specific user.
    • Tag: To grant capabilities to a tag in the system.
  7. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Device was selected, select the instance of a device running the application in the
    • drop-down list.
    • If App was selected, select the name of application.
    • If User was selected, select the email of the user from your organization.
    • If Tag was selected, select the name of the tag.
  8. (Optional) In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  9. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. You must choose a date and time that's in the future.
  10. Click Grant.

View devices associated to your account

In the MY DEVICES section of the Dashboard, you view all the devices that are associated to your account and see an overview of the capabilities given to other users, applications, or devices. Devices become associated with account when you login to them. Devices that don't use an account to login (such as devices that use device-based authentication) don't appear in this list.

You can unlink a device to remove it from your MY DEVICES list. When you unlink a device, it disassociates your account from the device. To re-add a device to your list, you simply relogin to the device using your account information.

Note: If you want to modify the capabilities given by the device, you must manage them in Devices. See Granting capabilities for more information.

View all devices associated with your account

  1. Log in to the administration console.
  2. On the Dashboard, under the MY DEVICES area, you should see a list of the devices associated to your account.
  3. Click the drop-down icon to expand the device and to see the capabilities given to other users, applications, and other devices.

Disassociate a device from your account

To remove a device from your MY DEVICES list, you unlink it. Unlinking the device doesn't modify the capabilities to the device or remove the device entity from the BlackBerry IoT Platform.

  1. In the administration console, on the Dashboard, under MY DEVICES area, select the device you want to disassociate.
  2. Click Unlink and click Yes in the confirmation dialog box to remove all access to the devices; otherwise, click No.

Manage users

The Users section of the administration console allows you to manage which users are part of your organization as well as grant them capabilities to perform certain actions such as create applications, read device data, etc. For more information about managing capabilities, see Working with Capabilities and Tags.

Invite a user to an organization

You can use the administration console to add users to your organization, and they can be part of multiple organizations with the same account. To add a user, they must already have a BlackBerry IoT Platform account and you need to know their email address. For more information about accounts, see First time with this Platform.

  1. In the administration console, click Users.
  2. Click the Add button ("+").
  3. In the Invite User to Organization dialog box, in the Email box, type the email address of the user to add to your organization.
  4. Click Invite.

Manage applications

An application is code that runs on a device, it can be written in any language such as JavaScript, C, Java, etc. Applications running on devices identify themselves with the API KEY and API SECRET.

An API KEY and API SECRET are generated after an application is added in the administration console along with that applications unique ID called app_id. You can get the API KEY and API SECRET from the administration console. The developer must add both keys into the code of the application. The API KEY and API SECRET are required for an application to authenticate. See Understanding Authentication.

After you add an application in the administration console, you can:

For more information about applications, see Application entities.

Create an application

Note: If you haven't created any tags, you won't be able to select a tag in step 5.

  1. In the administration console, select Applications.
  2. Click the Add button ("+").
  3. In the Create Application dialog box, in the Name box, type a name for your application.
  4. In the Description box, enter a description for the application.
  5. (Optional) From the Tag drop-down list, select a tag.
  6. Click Create.

Configure data-retention

You can configure the data stored by an application in the BlackBerry IoT Platform. In particular, you configure state information, alarms, logs stored for your application, and the version of the application. As part of the data-retention configuration, you can configure the category. The category refers to the type of data you want to add. For more information about categories, see Working with Data.

A piece of data stored in the cloud is represented as a data object. The data object maps to a current piece of data on a device. For more information about data objects, see Working with data. For more information on how device data works and guidelines for configuring data-retention, see Data retention.

  1. In the administration console, select Applications.
  2. Select the application you want to modify the data-retention policy for.
  3. Click Data-Retentions.
  4. Click the Add button ("+").
  5. In the Create Data Retention dialog box, in the Category drop-down list, select the category you want.
  6. In the Name box, type the name of the data object. You can specify '*' to include all data objects in the specified category.
  7. In the Retention list, choose the length of time the data should be retained. You can select these values:
  8. Days: The number of days of data to retain as a integer value.
  9. Forever: All data since the data started being retained.
  10. Last value only: The current data only.
  11. Click Create.

View application security

For applications to interact with the BlackBerry IoT Platform, each application must authenticate using an API KEY and API SECRET. After you add an application in the administration console, the API Key and API SECRET are generated. Developer must add the API KEY and API SECRET to their application's code.

For more information about the API KEY, API SECRET, and authentication, see Authentication.

  1. In the administration console, select Applications.
  2. Select the application you want to see the API KEY and API SECRET for.
  3. Click Keys/Secrets.
  4. Make note of the API SECRET and API KEY and pass the information to the developer in a secure manner.

Give capabilities and create associations for applications

You can give capabilities to devices, applications, users, and tags. Capabilities control what information is shared and what actions can be performed. You can also list all the capabilities that any of these entities have. For guidelines on configuring capabilities and details about the available capabilities, see Working with Capabilities and Tags.

You can also create an association to allow applications belonging to the same user to automatically be given one or more capabilities. For more information about associations, see Using associations to simplify capability management.

  1. In the administration console, select Applications.
  2. Select the application you want to modify the capabilities for.
  3. Click Capabilities and ensure that the Given Capabilities is selected.
  4. Click the Add button ("+").
  5. In the Grant Capability On dialog box, in the Action drop-down list, select the capability to grant. You type the name of a capability and suffix it with a period and a string to extend a capability. For information details about the capabilities, see Extended capabilities.
  6. In the Grant Type drop-down list, select the entity to grant the capability to.
    • Device: To grant capabilities to a specific device.
    • App: To grant capabilities all devices running the specific application.
    • User: To grant capabilities to a specific user.
    • Tag: To grant capabilities to a tag in the system.
  7. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Device was selected, select the instance of a device running the application in the
    • drop-down list.
    • If App was selected, select the name of application.
    • If User was selected, select the email of the user from your organization.
    • If Tag was selected, select the name of the tag.
  8. (Optional) In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  9. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. You must choose a date and time that's in the future.
  10. Click Grant.

You should see the capabilities given to your application when you the capabilities.

View the application capabilities

You can view the capabilities that have been given to your application or the capabilities that your application gives other entities. This information is useful for understanding how your application can interact with the rest of the system. You may find the information useful to understand how data is exchanged and shared between applications, users, and devices.

  1. In the administration console, select Applications.
  2. Select the application you want to modify the capabilities for.
  3. Click Capabilities.
  4. Select Received Capabilities or Given Capabilities.

The list shows the capabilities that have been given to your application. Optionally, you click each column to sort by the name of the capability, application name, or user's email.

View devices running an application

You can view the devices that are running instances of a particular application.

  1. In the administration console, select Applications.
  2. Select the application that you want to view the capabilities and permissions of.
  3. Click Devices.

Note: The page changes to the Devices page, which is the same page as in View devices.

Manage devices

Devices are the instances of applications. Unlike applications, devices can authenticate and perform API calls. For example you may have phone applications, where each phone that uses that application would be a device. For more information about devices, see Device entities.

Devices can authenticate in one of two ways:

For more information about device-based authentication, see Understanding Authentication.

After a device has been created in the system, you can also perform the following tasks:

Create a device

You typically create a device entity for a device that will authenticate without a user, and you wouldn't do this if it is user sign- in based. For more information about device-based authentication, see Device-based authentication.

Before you can start these steps, you should have a certificate signing request (CSR) file created. For more information about how to generate a CSR, see Use tools to generate CSR and key.

Note: If you haven't created any tags, you won't be able to select a tag in step 7.

  1. In the administration console, select Devices.
  2. Click the Add button ("+").
  3. In the Create Device dialog box, in the Application drop-down list, select the name of the application you want to create a device from.
  4. In the Name box, type a descriptive name.
  5. In the Identifier box, type an identifier for the device. For example, if the device is a cell phone, use the device identifier or if the device is a factory machine, use its serial number. Ideally, this identifier is unique and helps you to tie this device to other database systems you may use.
  6. In the Description box, type descriptive information about the device.
  7. In the Certificate Request box, paste your certificate signing request from the CSR file. The contents of what you paste should include the -----BEGIN CERTIFICATE REQUEST----- string, the PEM-encoded CSR, and the -----END CERTIFICATE REQUEST----- string.
  8. (Optional) In the Tags drop-down menu, select a tag. You can type part of the name to search for the tag.
  9. Click Create.

After you successfully create the device, a window appears with the certificate, which you can copy and paste to a file. In addition, a PEM file (which contains the certificate) is automatically downloaded through the browser to your computer.

Generate certificates

You must generate a X.509 certificate for device-based authentication. The certificates are PEM-encoded use secp256r1 (prime256v1) for the elliptical curve. For information about device-based authentication, see Overview of device-based authentication.

  1. In the administration console, select Devices.
  2. Click the name of the device to add a certificate to. Optionally, you can select the application type to filter the list of devices.
  3. Click Certificates.
  4. Paste the contents from your certificate signing request file to the Signing Request box and click Request Certificate.
  5. Click Save your certificate to download the certificate to your computer.

You can use the generated certificate to authenticate a device with the BlackBerry IoT Platform.

Revoke certificates

You can revoke certificates to prevent devices from using that certificate to authenticate or perform operations on the BlackBerry IoT Platform.

  1. In the administration console, select Devices.
  2. Click the name of the device to revoke a certificate for. Optionally, you can select the application type to filter the list of devices.
  3. Under Certificates, there is a list of certificates, including information about the name and validity period.
  4. Identify the certificate and click the Revoke button to revoke it.

After the certificate is revoked, devices require a new certificate to authenticate with the BlackBerry IoT Platform.

View device data

You can view the data associated with a device.

  1. In the administration console, select Devices.
  2. Select the name of the device you want to see.
  3. Click Data.
  4. You can view the data in the list and click state, alarm, log, or component to filter the data in the list.

View device capabilities

You can see the capabilities that are assigned to a device.

  1. In the administration console, select Devices.
  2. Click on the device that you want see the capabilities for.
  3. Click Capabilities.

You should see the capabilities that are assigned to the device. You can click Given Capabilities to see the list of capabilities that the device grants to other applications, users, tags, or devices.

View device information

You can view the devices that are running instances of a particular application and a map of where the device is located.

  1. In the administration console, select Devices.
  2. Near the right-hand side, filter the devices based on the type of application.
  3. In the list, click the device to see the name, identifier, and application entity UUID.

View certificates for a device

You can view the certificates that are available for a device. If you need to generate a certificate, see Generate certificates.

  1. In the administration console, select Devices.
  2. Near the right-hand side, filter the devices based on the type of application.
  3. In the list, click the device that you want to see the certicates for.
  4. Click Certificates to see the list of certificates.

Use Log Analysis

You can view the log data that has been collected for a device using our Log Analysis module. The module uses Kibana to view the log data collected for the device.

  1. In the administration console, select Devices.
  2. Near the right-hand side, filter the devices based on the type of application.
  3. In the list, click the device that you want to see the certicates for.
  4. Click Log Analysisto to see your log data in a separate browser tab.

Grant capabilities and create associations for devices

You can grant capabilities to other devices, applications, tags, and users. Capabilities control what information is shared and what actions can be performed. You can also list all the capabilities that any of these entities have. For guidelines on configuring capabilities and details about the available capabilities, see Working with Capabilities and Tags.

You can also an association to allow other devices belonging to the same user to automatically be given the same capabilities. For more information about associations, see Using associations to simplify capability management.

  1. In the administration console, select Devices.
  2. Select the device you want to modify the capabilities for.
  3. Click Capabilities and ensure that the Given Capabilities is selected.
  4. Click the Add button ("+").
  5. In the Grant Capability On dialog box, in the Action drop-down list, select the capability to grant. You type the name of a capability and suffix it with a period and a string to extend a capability. For information details about the capabilities, see Extended capabilities.
  6. In the Grant Type drop-down list, select the entity to grant the capability to. Select one of the following:
    • Device: To grant capabilities to a specific device.
    • App: To grant capabilities all devices running the specific application.
    • User: To grant capabilities to a specific user.
    • Tag: To grant capabilities to a tag in the system.
  7. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Device was selected, select the instance of a device running the application in the
    • drop-down list.
    • If App was selected, select the name of application.
    • If User was selected, select the email of the user from your organization.
    • If Tag was selected, select the name of the tag.
  8. (Optional) In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  9. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. You must choose a date and time that's in the future.
  10. Click Grant.

Manage tags

Tags provide you a way to group capabilities together and assign them to users, applications, files, devices, etc. By default, applications can't access information of other applications or even share information unless capabilities are assigned. Tags provide the mechanism to make it easy to assign multiple capabilities at once to different entities. When you create a tag, it can be an exposing tag or non-exposing tag. For more information about tags, see Using tags to simplify permission management.

Create a tag

You can create tags to assign a group of capabilities to entities in your organization. You can even select a color for the tag to make it easy to visually express what entities have the tag applied.

  1. In the administration console, select Tags.
  2. Click the Add button ("+").
  3. In the Create Tag dialog box, in the Tag Name box, type a name for your tag. The name must be at least four characters long and contain alphanumeric characters. This tag doesn't need to be unique.
  4. In the Tag Description box, type information about that tag, such as what the tag is used for, when it should be applied, and purpose for the tag.
  5. (Optional) In the Tag Color box, click it and select a color from the color pallet.
  6. In the Tag Type option, select one of the following options:
    • Exposing: Capabilities can be applied to the tag, allowing you to expose additional capabilities to entities that have been associated with the tag.
    • Non-exposing: Additional capabilities can't be applied to tag.
  7. In the Belongs To option, select one of the following options:
    • Myself: To limit the use of the tag to you.
    • My organization: To allow others that administer the organization to use the tag.
  8. Click Create.

You should see a tag added to your list of existing tags.

View existing tags

You can see the tags that are available.

  1. In the administration console, select Tags.
  2. In the list that appears, you can see all the tags that are available in your organization.
  3. (Optional) Type a value in the Search box and click the Search button to filter the tags that are visible in the list.

Grant capabilities and create associations for tags

You can grant capabilities to a tag and then apply that tag to specify the same capabilities on the tagged item. For more information about configuring tags and capabilities, see Working with Capabilities and Tags.

You can only grant capabilities to Exposing tags. If your tag is a non-exposing tag, you can't grant permissions for it.

  1. In the administration console, select Devices.
  2. Click the device you want to modify the capabilities for.
  3. Click Capabilities and ensure that the Given Capabilities is selected.
  4. Click the Add button ("+").
  5. In the Grant Capability On dialog box, in the Action drop-down list, select the capability to grant. You type the name of a capability and suffix it with a period and a string to extend a capability. For information details about the capabilities, see Extended capabilities.
  6. In the Grant Type drop-down list, select the entity to grant the capability to. Select one of the following:
    • Devices: To grant capabilities to a specific device.
    • Apps: To grant capabilities all devices running the specific application.
    • Users: To grant capabilities to a specific user.
    • Tags: To grant capabilities to a tag in the system.
  7. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Devices was selected, select the instance of a device running the application in the
    • drop-down list.
    • If Apps was selected, select the name of application.
    • If Users was selected, select the email of the user from your organization.
    • If Tags was selected, select the name of the tag.
  8. (Optional) In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  9. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. You must choose a date and time that's in the future.
  10. Click Grant.

Manage files

BlackBerry IoT Platform allows you to manage files that are associated with device entities. You can manage files in the following ways:

Upload a file

You can upload files to the cloud. Optionally, you can add metadata for files as JSON-formatted data. Having a good understand of how to format JSON data is essential. You can specify your JSON data as text values (property/values), objects, arrays, or references.

  1. In the administration console, select Devices.
  2. Select the device that you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select or you can use the search functionality to help find your device.
  3. Click the Files button.
  4. Click the Add button ("+").
  5. In the Upload File dialog box, drag the file you want to upload to the area where it says Drop File Here. Alternatively, click Upload File and navigate to the file located on your computer. The file that you select or drag should appear in the File to Upload box.
  6. (Optional) In the Description box, type a short description about your file.
  7. (Optional) In the Metadata area, click the Add button ("+") to add metadata. The metadata is built as a JSON object want your data to be formatted.
    • In the Name box, type the name of the JSON value.
    • In the Text drop-down menu, select the JSON type, which can be text, object, an array, or a reference.
    • In the Value box, type the JSON value.
    • Click Add to create the JSON object; otherwise click Cancel. If you select array, object, or reference, you can expand and add additional JSON objects to create a nested JSON structure. You also the *Trash can icon to delete any objects you don't want.
  8. Click Upload.

View existing files

You can view the files that have been updated for your devices.

  1. In the administration console, select Devices.
  2. Select the device you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select.
  3. Click the Files button.
  4. In the list that appears, you should see all the files that belong to that device.
  5. (Optional) Type a value in the Search box to filter the files that are visible in the list.

Delete a file

You can delete a file that's stored in the cloud.

  1. In the administration console, select Devices.
  2. Select the device you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select.
  3. Click the Files button.
  4. In the list, click the file you want to delete.
  5. Click Delete and then click Yes to delete the file; otherwise click No.

Update a file

You can update the metadata or description for a file that you previously uploaded to the cloud.

  1. In the administration console, select Devices.
  2. Select the device you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select.
  3. Click the Files button.
  4. In the list, click the file you want to delete.
  5. Make the changes to the Description box or add or remove objects in the Metadata area, then click Update.

Download a file

You can download a file that you previously uploaded to the cloud.

  1. In the administration console, select Devices.
  2. Select the device you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select.
  3. Click the Files button.
  4. In the list of files, select the file that you want to download.
  5. Click Download.

The file should be downloaded to the default location your browser puts downloaded file.

Grant capabilities and create associations for files

You can grant capabilities to file that you have uploaded to the cloud. For more information about configuring tags and capabilities, see Working with Capabilities and Tags.

  1. In the administration console, select Devices.
  2. Select the device you want to manage files on. In the list of applications on the left panel, you can filter the list of devices based on the application you select.
  3. Click the Files button.
  4. Select the file you want to grant capabilities for.
  5. Click Capabilities and ensure that the Given Capabilities is selected.
  6. Click the Add button ("+").
  7. In the Grant Capability On dialog box, in the Action drop-down list, select the capability to grant. You type the name of a capability and suffix it with a period and a string to extend a capability. For information details about the capabilities, see Extended capabilities.
  8. In the Grant Type box, select the entity to grant the capability to. Select one of the following:
    • Devices: To grant capabilities to a specific device.
    • Apps: To grant capabilities all devices running the specific application.
    • Users: To grant capabilities to a specific user.
    • Tags: To grant capabilities to a tag in the system.
  9. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Devices was selected, select the instance of a device running the application in the
    • drop-down list.
    • If Apps was selected, select the name of application.
    • If Users was selected, select the email of the user from your organization.
    • If Tags was selected, select the name of the tag.
  10. (Optional) In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  11. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. You must choose a date and time that's in the future.
  12. Click Grant.

You should see the capabilities given to the file.

Manage firehoses

Firehoses provide a method by which events within the BlackBerry IoT Platform can be streamed and consumed. Subscriptions are added to firehoses. Subscriptions specify the event data to stream to a firehose.

For information using firehoses, see Working with Firehoses.

Create a firehose

You create a firehose to stream event data from one or more sources. Other devices can attach to the firehose to get event-driven data. For more information about firehoses, see Working with Firehoses.

  1. In the administration console, within your organization, select Firehoses.
  2. Click the Add button ("+").
  3. On the Create Firehose dialog box, in the Name box, type the name of the firehose. The name of your firehose must be at least four characters in length.
  4. In the Description box, enter a description that's at least four characters in length and then click Create.

You should see a new firehose.

Create a subscription

You can create a subscription that specifies the event data to send to the firehose. A firehose can have multiple subscriptions. The firehose won't stream any events until there's at least one subscription.

For more information about subscriptions, see Create subscriptions.

  1. In the administration console, within your organization, select Firehoses.
  2. From the list of firehoses, select the firehose you want to add a subscription to.
  3. Click Subscriptions.
  4. Click the Add button ("+").
  5. In the Create Subscription dialog box, in the Scope Type list, select one of the following values:
    • App: To stream all events from the devices of a particular application.
    • Device: To stream events from a particular device.
  6. In the Scope To box, based on what you selected in the previous step, choose the device or application from the list.
  7. In the Subscription Type box, select one of the following values:
    • Data: To add data event for the device or application. When this option is selected, the Match box appears where you can type a regular expression to indicate events to stream to the firehose.
    • File: To add file events for the device or application.
    • Life Cycle: To add life cycle changes for an application.
    • * : To add data, files, and life cycle to the subscription.
  8. Click Create.

You should see the new subscription.

Grant capabilities and create associations for firehoses

You can grant capabilities to other entities to access a firehose. The capabilities can allow other entities to read data from the firehose, manage it, add and remove subscriptions, and list what firehoses are available. You can grant specific capabilities to allow other entities to work with firehoses and manage subscriptions.

For more information about the firehose capabilities, see Supported capabilities.

  1. In the administration console, select Firehoses.
  2. In the list of firehoses, select the firehose you want to add a capability to.
  3. Click Capabilities.
  4. Click the Add button ("+").
  5. In the Grant Capability On box, in the Action drop-down list, select the capability to grant. For information details about the capabilities, see Supported capabilities.
  6. In the Grant Type box, select the entity to grant the capability to. Select one of the following:
    • Devices: To grant capabilities to a specific device.
    • Apps: To grant capabilities all devices running the specific application.
    • Users: To grant capabilities to a specific user.
    • Tags: To grant capabilities to a tag in the system.
  7. In the Grant To drop-down list, select the appropriate information based on what was selected in step 6:
    • If Devices was selected, select the instance of a device running the application in the
    • drop-down list.
    • If Apps was selected, select the name of application.
    • If Users was selected, select the email of the user from your organization.
    • If Tags was selected, select the name of the tag.
  8. (Optional)In the Association drop-down list, select Same User. This option grants the capability that you specified in step 5 to the devices and applications belonging to the same user.
  9. (Optional) In the Expires On box, click the Calendar button to indicate whether the capability you are about to grant expires. If no value is selected, by default the capability that you grant never expires.
  10. Click Grant.

You should see the capabilities given to the entities that you specified.