Skip to content
v1.0.0
OpenAPI 3.0.3

Email Resources Permissions API

The Email Resources Permissions API ensures that only authorized users have the rights to edit email resources such as modules and images in your application. This feature helps prevent unauthorized access and ensures that the Stripo Plugin performs server-side operations only with your permission. To enable this feature, you need to implement the following backend endpoint on your server.

Server:https://{YOUR_RESOURCE_PERMISSIONS_CHECKER_URL}
No authentication selected
Client Libraries

Methods

​
Methods Operations

Check and grant permissions

​

Verifies and assigns necessary permissions to a user for accessing specific features or content within the Stripo platform. The editor sends a request to the customer's endpoint with the information from the metadata and expects to receive a set of granted permissions in response. This method ensures that users have the appropriate access levels required to work inside the editor, enhancing security and effective role-based management.

Body·

required
application/json
  • ID of the plugin requesting permissions

  • Array of permissions that plugin requests

    Properties: 4
  • The value of 'metadata' field from editor initialization parameters

    Properties: 1

Responses

  • Resources permissions

    • Properties: 4
    application/json
Request Example for post/
curl 'https://{YOUR_RESOURCE_PERMISSIONS_CHECKER_URL}/' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "pluginId": "YOUR_PLUGIN_ID",
  "uiData": {
    "additionalProperty": ""
  },
  "requestPermissions": [
    {
      "type": "BLOCKS",
      "action": "READ",
      "key": "pluginId_YOUR_PLUGIN_ID_emailId_123_id_456",
      "keyTemplate": "emailId_${emailId}_id_${someAnotherIdentifier}"
    }
  ]
}'
{
  "grantPermissions": [
    {
      "type": "BLOCKS",
      "action": "READ",
      "key": "pluginId_YOUR_PLUGIN_ID_emailId_123_id_456",
      "keyTemplate": "emailId_${emailId}_id_${someAnotherIdentifier}"
    }
  ]
}

Models

​
  • ID of the plugin requesting permissions

  • Array of permissions that plugin requests

    Properties: 4
  • The value of 'metadata' field from editor initialization parameters

    Properties: 1
​
  • Operation type. Supported values - READ, MODIFY

  • Key identifier that was configured in plugin settings with filled values

  • Key identifier that was configured in plugin settings

  • Operation subject. Supported values - BLOCKS, DOCS

​
  • Properties: 4