Grant or revoke app access

POST /assetapi/user/app_access

Overview

This API grants or revokes app access.

Currently supported SnapLogic apps are:
  • IIP
  • AutoSync
  • Flows
  • Pattern Management
Note: This API manages only the SnapLogic apps or features that the Environment/Org is subscribed to.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 POST https://{controlplane_path}/api/1/rest/public/assetapi/user/app_access

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

   {
    "org_path" : "...",
    "users" : [
      {
        "username" : "...",
        "app_access" : {
          "..." : true,
          "..." : false,
          ...
        }
      },
      ...
    ]
  }
Key Type Description
org_path string Required. The path to the SnapLogic Environment/Org.

Format: /{env_org}

users array An array of objects comprised of:
  • the username
  • the app_access object with a list of app names with Boolean values
Valid app names:
  • intelligent_integration_platform
  • autosync
  • flows
  • pattern_management

To grant the user access to a specific app, set the value to true for that app.

To revoke the user's access to a single app, set the value to false for that app.

To revoke the user's access to all apps, set "app_access" : {}.

Response

Response Body

 {
  "response_map": [
    {
      "..." : "success"
    },
    {
      "..." : "success"
    }
  ],
  "http_status_code": 200
}

Each key for each key-value pair in response_map is the username. If the value is success, the update was successfully completed for that user.