User Applications¶

API calls to work with user applications.

/user/application/list¶

Lists all existing user applications.

Response¶

{
  "success": true,
  "list": [
    {
      "id": 221,
      "label": "An application",
      "url_template": "https://domain.example/{language}",
      "enabled": true,
      "authorization": {
        "type": "user_session"
      },
      "display_method": "new_tab",
      "icon": "extension",
      "description": "A description"
    }
  ]
}

• list - array of Application. Unique ID of the created application.

Application¶

• id - int. Application's ID.
• label - string. Application's name.
• url_template - string. URL template (including variables).
• enabled - boolean. Determines visibility in the users' side menu. true by default.
• authorization - Application authorization. Authorization that will be used while accessing the URL. User session by default.
• display_method - Display method. Determines how the application will be opened. new_tab by default.
• icon - string. Application's icon identifier. extension by default.
• description - string. Longer plain text description is shown to users. Empty by default.

Application authorization¶

Display method¶

• new_tab - the application will be opened in a new tab.
• embedded - the application page will be embedded into the platform UI.

/user/application/create¶

Creates a new application.

Parameters¶

Create request¶

Response¶

{
  "success": true,
  "id": 779
}

• id - integer. Unique ID of the created application.

/user/application/update¶

Updates an existing application.

Parameters¶

Response¶

{
  "success": true
}

Errors¶

• 201 – Application not found.

/user/application/delete¶

Deletes a specified application by its unique identifier.

Parameters¶

Response¶

{
  "success": true
}

Errors¶

• 201 – Application not found.

/user/application/enabled/set¶

Toggles application visibility in the side menu.

Parameters¶

Response¶

{
  "success": true
}

Errors¶

• 201 – Application not found.