Skip to content
v1.0.0
OAS 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:
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
  • plugin​Id
    Type: string
    required

    ID of the plugin requesting permissions

  • request​Permissions
    Type: array ResourcePermission[]
    required

    Array of permissions that plugin requests

  • ui​Data
    Type: object
    required

    The value of 'metadata' field from editor initialization parameters

Responses
  • 200
    Type: object
    • grant​Permissions
      Type: array ResourcePermission[]
Request Example for post/
curl / \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "pluginId": "YOUR_PLUGIN_ID",
  "uiData": {
    "propertyName*": ""
  },
  "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