PERMISSIONS.md

Permissions

Manage permissions.

Table of Contents

• Assign System Permissions to User
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Revoke System Permissions from User
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Assign Connection Groups to User
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Revoke Connection Group from User
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Assign Connection Groups to User Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Revoke Connection Group from User Group
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body

Assign System Permissions to User

Assign system permissions to an user.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• username (string, required) - Username

Query Parameters

• token (string, required) - Auth token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/userPermissions/test1",
    "value": "UPDATE"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_USER"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_USER_GROUP"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION_GROUP"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_SHARING_PROFILE"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "ADMINISTER"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Revoke System Permissions from User

Revoke system permissions from an user.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• username (string, required) - Username

Query Parameters

• token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/userPermissions/test1",
    "value": "UPDATE"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_SHARING_PROFILE"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION_GROUP"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_USER_GROUP"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_USER"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "ADMINISTER"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Assign Connection Groups to User

Assign connection groups to an user.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• username (string, required) - Username

Query Parameters

• token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/connectionGroupPermissions/{{connection_group}}",
    "value": "READ"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Revoke Connection Group from User

Revoke connection groups from an user.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• username (string, required) - Username

Query Parameters

• token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/connectionGroupPermissions/{{connection_group}}",
    "value": "READ"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Assign Connection Groups to User Group

Assign connection groups to an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• user_group (string, required) - User group identifier

Query Parameters

• token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/connectionGroupPermissions/{{connection_group}}",
    "value": "READ"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Revoke Connection Group from User Group

Revoke connection groups from an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

• Content-Type (string, required) - application/json

Path Parameters

• data_source (string, required) - Data source
• user_group (string, required) - User group identifier

Query Parameters

• token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/connectionGroupPermissions/{{connection_group}}",
    "value": "READ"
  }
]

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Back to Top