The App Provision Object

The app_provision object contains the general setting information of one of your Space Plugins or Tool Plugins. To access this seeing information, use the OAuth token provided. With the OAuth token, your Space Plugin or Tol Plugin can send a request to retrieve the general setting information to the app_provisions endpoint.

You can find more information on how to get your OAuth token on our OAuth 2.0 Authorization Flow documentation. We mentioned an important endpoint, app_provisions and you can check examples in this section of our documentation.

Properties

public_config
string

Public configurations
session
string

Status of the session
slug
string

The slug specific to this Space Plugin or Tool Plugin
app_id
number

Space Plugin or Tool Plugin id
name
string

Space Plugin or Tool Plugin name
in_sidebar
boolean

A status in the sidebar if your plugin is Space Plugin
in_toolbar
boolean

A status in the toolbar if your plugin is Tool Plugin
sidebar_icon
string

Your Space Plugin sidebar icon image path
enable_space_settings
boolean

A status to show whether your Space Plugin or Tool Plugin is enabled for space level or not
space_level_settings
object

Space level settings

Example Object

{
  "app_provision": {
    "public_config": null,
    "session": null,
    "slug": "my-first-plugin",
    "app_id": 12345,
    "name": "My first plugin",
    "in_sidebar": true,
    "in_toolbar": false,
    "sidebar_icon": null,
    "enable_space_settings": true,
    "space_level_settings": {}
  },
  "granted": false
}

Prev The Plugin Object

Next Retrieve Settings