Add EDP User Permissions Endpoint

Overview

This endpoint allows you to grant the database user access to tables or views without needing to sign in to Appian.

• Header: Content-Type: application/json
• HTTP request method: PATCH
• Endpoint: /cloud-database-management/v1/edp-permissions/add

This endpoint is accessible only when Enhanced Data Pipeline is enabled.

This page describes how to make API calls to add permissions for an EDP database user and troubleshoot common errors.

Usage

When the Enhanced Data Pipeline (EDP) is enabled for your instance, Appian Support creates a database user with read-only access to all tables and views in the schemas you specify. To ensure this user's access is limited to only required data, you can update its permissions by completing the following steps:

1. Use the removeAllEdpUserPermissions stored procedure to reset the EDP database user's permissions.
2. Use this endpoint to add just the permissions needed for the application using EDP.

If the database user's permissions need to change, you can use the Remove EDP User Permissions endpoint to remove one or more of the permissions you've already granted.

Request

Each PATCH request's body must include a JSON object with three key-value pairs identifying the update you want to make.

1
2
3
4
5
6
7
{
  "username": "<edp_database_user>",
  "schema": "<schema_name>",
  "tables": {
    "<table_name1>"
  }
}

Request example

Request

1
PATCH https://mysite.appiancloud.com/suite/cloud-database-management/v1/edp-permissions/add

JSON object example

1
2
3
4
5
6
7
8
9
10
{
  "username": "appianReplicationViewer",
  "schema": "Appian",
    "tables": {
      "AT_CUSTOMER",
      "AT_CUSTOMER_EVENT_TYPE",
      "AT_ORDER",
      "AT_ORDER_EVENT_TYPE"
    }
}

cURL example

If you're calling the API from a command line interface, you can use cURL to make a request. The cURL command with the above JSON object and its corresponding files looks like:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --location --request \
PATCH 'https://mysite.appiancloud.com/suite/cloud-database-management/v1/edp-permissions/add' \
--header 'appian-api-key: <API key>' \
--header 'Action-Type: import' \
--form json='{
    "username": "appianReplicationViewer",
    "schema": "Appian",
    "tables": {
        "AT_CUSTOMER",
        "AT_CUSTOMER_EVENT_TYPE",
        "AT_ORDER",
        "AT_ORDER_EVENT_TYPE"
    }
   }' \

Response

Successful response

Response example

1
2
3
4
{
  "resource": "/suite/cloud-database-management/v1/edp-permissions/add",
  "message": "Access to tables [<list of tables>] on schema [<schema name>] granted to user [<edp user>]"
}

Partially successful response

Response example

1
2
3
4
{
  "resource": "/suite/cloud-database-management/v1/edp-permissions/add",
  "message": "The following tables were not found in the provided schema: [<list of tables>]. The rest of the table permissions were updated successfully."
}

Errors

The following table describes errors you may encounter when using this endpoint.

Feedback