Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt
This page describes the web management interface facilities for Apps management.
Table of Contents
maxLevel3

Manage app

To access the App management pages you must follow the steps below. From an Administrator account, you must go to Unified Communications -> Integrations -> SystemAPI & UnifiedAPI. Using a Service Provider, Organization, User account, go to the homepage of the user and click the SystemAPI & UnifiedAPI button. Then choose the type of API which the App will use:

  • For Apps that use SystemAPI, select the SystemAPI tab
  • For Apps that use UnifiedAPI, choose the UnifiedAPI tab
Note
If you are using a Service Provider account, you will not be able to manage Apps for UnifiedAPI.

The following options are available in the page that opens:

OptionDetails
S

The status of the App:

Enabled: suspend the authorized App with a click on this icon; a pop-up window is displayed, allowing you to choose the proper action.
A disabled App is not able to make any more requests to the system.
Disabled: reactivate the authorized App with a click this icon.
A pop-up window is displayed, allowing you to choose the proper action.

AppThe name of the third-party App. Click the link if you want to modify its parameters. For more details, check out the Register App section.
You can click the icon which opens the App's homepage in a new window.
DescriptionDetails of the third-party App. If it is too long, a hint with the complete text will be displayed on mouse-over.
Access TokensThe number of access_tokens currently associated with the App and the current user.
When at least one token exists, if you click the link, a pop-up window is displayed, allowing you to visualize its details or to remove it.
ConfiguredThe date the App was configured.

De-authorize app

There are multiple methods that you can use to revoke the authorization granted to an App, but each has its own consequences as detailed below:

Remove access tokens

Anchor
app-tkn-rem
app-tkn-rem

To remove an access token, you must navigate to the App management page corresponding to your account type and click on the link under Access Tokens.

A pop-up window will display the following details:

The token details that are listed are described in the following table:

OptionDetails
ExpiresDate and time the token expires.
User Agent
User agent that was used to generate the access token.

You can remove any access_token by selecting the corresponding checkbox and clicking the Remove Selected button. You can remove all access tokens available for an App at a given moment in time by selecting the checkbox placed in the header of the table and then clicking the Remove Selected button.

Note
titleSecurity
An App cannot use the removed access tokens to make new requests. Removing the access token does not however forbid the App from requesting a new access token. This method is useful when the access token was compromised.

Remove app

To remove an App, you must navigate to the App management page corresponding to your account type. Using the table displayed, you can remove any App by selecting the corresponding checkbox and clicking the Remove Selected button.

Note
titleSecurity
Once the App has been removed, it cannot generate new access_tokens or make any other requests.

Enable/Disable app

To enable/disable an App, you must navigate to the its management page corresponding to your account type. Once in that page, you must click the icon under the S column corresponding to the App.

Note
titleSecurity
Once the App has been disabled, it cannot generate new access_tokens, use old access_tokens or make any other requests, until it is enabled. If they did not expire, old access_tokens still work, even after the App has been enabled.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.