SmartApps

Update an app's install metadata

Changed on

Update an app's install metadata. Install metadata is used to alter the system behavior during app installation into a user's account. For example, flagging an App as certified: "true" would allow the system to allow any user to install that App.

put/smartapps/{appNameOrId}/install-metadata

Request

Path parameters

appNameOrIdstring required

The appName or appId field of an app.

Headers

Authorizationstring string required

OAuth token

Request body

certifiedboolean

Whether or not the app has been certified.

maxInstallsinteger

Maximum times the app may be installed within a region. -1 indicates no limit.

assumedRoleCanInstallboolean

Whether or not the app can be installed by an assumed role.

maxContentLengthBytesnumber

Maximum payload content length in bytes that this service will return.

restrictedMembersCanViewboolean

If true, then don't hide associated installed smart app from restricted members.

Example request

{
  "certified": true,
  "maxInstalls": 100,
  "assumedRoleCanInstall": false,
  "maxContentLengthBytes": 64000,
  "restrictedMembersCanView": false
}

Response

A response containing an App's metadata.

certifiedboolean

Whether or not the app has been certified.

maxInstallsinteger

Maximum times the app may be installed within a region. -1 indicates no limit.

assumedRoleCanInstallboolean

Whether or not the app can be installed by an assumed role.

maxContentLengthBytesnumber

Maximum payload content length in bytes that this service will return.

restrictedMembersCanViewboolean

If true, then don't hide associated installed smart app from restricted members.

Example response

{
  "certified": true,
  "maxInstalls": 100,
  "assumedRoleCanInstall": false,
  "maxContentLengthBytes": 64000,
  "restrictedMembersCanView": false
}

Changes