Jump to main content
Expand
Package Permissions

Package Permissions

package_permissions

Introduced in version 16

Summary: POST /internal/v1/package-permissions

Return permissions for specified packages for the authenticated user.

This is an internal API intended to be used from devicegw - even though it does require full regular PublisherGW user authentication.

Currently only enabled in on-prem scenarios and only for snaps.

Request JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "filters": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "enum": [
              "snap"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "filters"
  ],
  "type": "object"
}

Response JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "account": {
      "additionalProperties": false,
      "properties": {
        "display-name": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "email": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "username": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "validation": {
          "type": "string"
        }
      },
      "required": [
        "display-name",
        "id",
        "username"
      ],
      "type": "object"
    },
    "packages": {
      "items": {
        "properties": {
          "allowed-by-revision": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "type": {
            "enum": [
              "snap"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id",
          "allowed-by-revision"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "account",
    "packages"
  ],
  "type": "object"
}