Skip to main content

Application services

The Application Services page contains tabs that control various technical aspects of applications that operate in the Here™ environment.

  • API Keys: Keys used by applications to access Here™ cloud services APIs

  • Roles: Collections of permissions used to control access to applications

  • Permissions: Control access to functions within applications

  • App Config: Configurations used by custom applications, for specific applications

API keys​

An API key is a secret, unique identifier used to authenticate an application to a server. Create API keys for applications that need access to Here™ cloud services APIs. As a best practice, handle API keys securely, sending them only over secure connections, and do not hard-code them into scripts or applications.

Generate an API key​

  1. In the API Keys tab of the Application Services page, click Generate API Key. The New API key dialog appears.

  2. Enter a Name for the API key. As a best practice, choose a descriptive name based on the purpose of the key.

  3. Click Generate API Key. The dialog displays the API key, obscured by default. This is the only time that the API key is displayed. You will not be able to access the API key again after you close this dialog.

  4. (Optional) Click Reveal (eye icon) to display the key in plain text.

  5. Click Copy (clipboard icon). A confirmation message indicates that the key has been copied to the clipboard. Be sure to paste the value to a secure location.

  6. Click Close to close the dialog.

Suspend an API key​

It might become necessary to suspend an API key temporarily. While an API key is suspended, no application can use it to access cloud services APIs. Before suspending an API key, be sure to communicate with users and developers of the application that uses it.

  1. In the API Keys tab of the Application Services page, use the search bar to find the API key by its name. You can also scroll through the list of API keys to locate the one you want to suspend.

  2. Click the Action ⋮ menu on the right end of the API key's row.

  3. Select Suspend API Key. A confirmation dialog appears.

  4. If you are sure you want to suspend the API key, click Suspend. Otherwise, click Cancel to avoid suspending the API key. If you confirm, the API key's Status changes to Suspended and it cannot be used until it is unsuspended. A success message appears, confirming that the API key has been suspended.

Unsuspend an API key​

  1. In the API Keys tab of the Application Services page, use the search bar to find the API key by its name. You can also scroll through the list of API keys to locate the one you want to unsuspend.

  2. Click the Action ⋮ menu on the right end of the API key's row.

  3. Select Unsuspend API Key. A confirmation dialog appears.

  4. If you are sure you want to unsuspend the API key, click Unsuspend. Otherwise, click Cancel to avoid unsuspending the API key. If you confirm, the API key's Status changes to Active and it can be used normally. A success message indicates that the API key has been unsuspended.

Delete an API key​

It might become necessary to delete an API key. For example, if you know or suspect that the key has leaked to an unauthorized party, delete that API key. Before deleting an API key, be sure to communicate with the developers of the application that uses it.

If you delete an API key, it is permanently deleted from the system, and cannot be recovered. You can generate a new key for the application, but each generated key has a unique value, different from every other API key.

  1. In the API Keys tab of the Application Services page, use the search bar to find the API key by its name. You can also scroll through the list of API keys to locate the one you want to delete.

  2. Click the Action ⋮ menu on the right end of the API key's row.

  3. Select Delete API Key. A confirmation dialog appears.

  4. If you are sure you want to delete the API key, click Delete. Otherwise, click Cancel to avoid deleting the API key. If you confirm, the API key is permanently deleted from the system. A success message indicates that the API key has been deleted.

Roles​

Roles apply one or more permissions to a set of users or groups. Therefore, before creating roles, you must create some Permissions.

Create a role​

  1. In the Roles tab of the Application Services page, click Create New Role. The Create Role dialog appears.

  2. Enter a Name for the role.

  3. Enter an ID for the role. The ID value must be unique across all roles in your platform.

  4. (Optional) Enter a Description of the role.

  5. Click Select Permissions. The Select Permissions dialog appears.

  6. Use the search box to search for permissions by name or ID. You can also scroll through the list to find permissions. All the permissions defined on the Permissions tab are available.

  7. Select the checkbox next to each permission you want to add to the role.

  8. Click the right-arrow button (→ icon) to add the selected permissions to the Selected Permission(s) list.

  9. If you select any permissions by mistake, you can select their checkboxes and then click the left-arrow button (← icon) to remove them from the Selected Permission(s) list.

  10. When the Selected Permission(s) list contains exactly the permissions you want to add to this role, click Select Users. The Select Users dialog appears.

  11. Use the search field to search for users or groups by name or ID.

    • To add items, select the checkbox next to the names of the users or groups you wish to add.

    • To remove items, clear the checkbox next to the users or groups you wish to remove from the role.

  12. When the settings, permissions, and users or groups are correct, click Create Role. The role is added to the list of roles.

Edit a role​

  1. In the Roles tab of the Application Services page, use the search bar to find the role by its name or ID. You can also scroll through the list of roles to locate the one you want to edit.

  2. Click the Action ⋮ menu on the right end of the role's row.

  3. Select Edit. The Edit Role dialog appears.

  4. Modify the settings, permissions, and users or groups, as needed. The sequence of dialog boxes is the same as in [Create a role](#create-a-role).

  5. When the settings, permissions, and users or groups are correct, click Update Role. A success message indicates that the role is updated.

Delete a role​

If a role is no longer needed, you can permanently remove it from the platform. Keep in mind that deleting a role is irreversible. After a role is deleted, it is no longer accessible to applications, and all associated settings are also removed. If you need to restore it later, you must recreate it.

Ensure that deleting the role will not disrupt critical workflows for users. As a best practice, verify that no applications rely on the role before proceeding.

  1. In the Roles tab of the Application Services page, use the search bar to find the role by its name or ID. You can also scroll through the list of roles to locate the one you want to delete.

  2. Click the Action ⋮ menu on the right end of the role's row.

  3. Click Delete. A confirmation dialog appears.

  4. If you are sure you want to delete the permission, click Delete. Otherwise, click Cancel to avoid deleting the role. If you confirm, the role is permanently removed from the system. A success message indicates that the role has been deleted.

Permissions​

Permissions provide the ability to perform actions in web applications. Applications can query permissions to determine whether the current user is allowed to perform a specific operation.

Create a permission​

  1. In the Permissions tab of the Application Services page, click Create Permission. The Create Permission dialog appears.

  2. Enter a Name for the permission.

  3. Enter an ID for the permission. The ID value must be unique across all permissions in your platform.

  4. To associate this permission with specific content items, click Manage Content Tagging. The Manage Content Tags dialog appears. Note that you can add content tags only when creating a permission; you cannot add them later.

    1. Use the search bar to find content items to associate with this permission. All the content items defined on the Content page are available.

    2. Select the checkbox next to each content item you want to associate with the permission.

    3. Click the right-arrow button (→ icon) to add the selected content items to the Selected Content list.

    4. If you select any content items by mistake, you can select their checkboxes and then click the left-arrow button (← icon) to remove them from the Selected Content list.

    5. When the Selected Content list contains all the content items you want to associate with this permission, and none that you don't want, click Add Content Tag.

  5. (Optional) Enter a Description of the permission.

  6. Click Create Permission. A success message indicates that permission has been created.

Edit a permission​

  1. In the Permissions tab of the Application Services page, use the search bar to find the permission by its name or ID. You can also scroll through the list of permissions to locate the one you want to edit.

  2. Click the Action ⋮ menu on the right end of the permission's row.

  3. Select Edit. The Edit Permission dialog appears.

  4. Modify the Name, ID, or Description fields, as needed.

  5. Click Save.

Delete a permission​

If a permission is no longer needed, you can permanently remove it from the platform. Keep in mind that deleting a permission is irreversible. After a permission is deleted, it is no longer accessible to applications, and all associated settings are also removed. If you need to restore it later, you must recreate it.

Ensure that deleting the permission will not disrupt critical workflows for users. As a best practice, verify that no applications rely on the permission before proceeding.

  1. In the Permissions tab of the Application Services page, use the search bar to find the permission by its name or ID. You can also scroll through the list of permissions to locate the one you want to delete.

  2. Click the Action ⋮ menu on the right end of the permission's row.

  3. Click Delete. A confirmation dialog appears.

  4. If you are sure you want to delete the permission, click Delete. Otherwise, click Cancel to avoid deleting the permission. If you confirm, the permission is permanently deleted from the system. A success message indicates that the permission has been deleted.

App config​

An application configuration (app config), also known as an application manifest, defines settings that are used by the Here™ platform when launching and running a web application. You can define app configs for content items, based on the users, groups, or roles that can access them. Such an app config overrides the default configuration for the application. An app config consists of JSON-formatted text. You can learn more about app configs in Manifest settings.

App configs are managed on the App Config tab of the Application Services page.

Create an app config​

  1. In the search box, search for a user, group, or role by name or ID.

  2. Select the item that you want to define an app config for. The App Config dialog opens. It displays the content items associated with the selected user, group, or role.

  3. In the search box, search for content items by name.

  4. For each content item that you want to create an app config for:

    1. Select the content item on the left side of the dialog box.

    2. In the Advanced Editor text box, enter an app config definition, in JSON format.

    3. Click Save Changes. If the content of the editor is not valid JSON, an error message appears; in this case, you must fix the JSON content to be valid. If the content is valid JSON, it is saved.

  5. Click Cancel to close the App Config dialog.

Delete an app config​

  1. In the search box, search for a user, group, or role by name or ID.

  2. Select the item that you want to delete an app config for. The App Config dialog opens.

  3. On the left side of the dialog, select the content item whose app config you want to delete.

  4. Delete all the text in the Advanced Editor text box.

  5. Click Save Changes.

  6. Click Cancel to close the **App Config **dialog.

Table of Contents