SHARING-PROFILES.md

Sharing Profiles

Manage sharing profiles.

Table of Contents

• List Sharing Profiles
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Details of Sharing Profile
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Create Sharing Profile
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
• Delete Sharing Profile
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body

List Sharing Profiles

GET /api/session/data/{{data_source}}/sharingProfiles

Headers

None.

Path Parameters

• data_source (string, required) - Data source

Query Parameters

• token (string, required) - Auth Token

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Details of Sharing Profile

Details of sharing profile.

GET /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}}

Headers

None.

Path Parameters

• data_source (string, required) - Data source
• sharing_profile (string, required) - Sharing profile identifier

Query Parameters

• token (string, required) - Auth Token

Request Body

None.

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Create Sharing Profile

Create a sharing profile.

POST /api/session/data/{{data_source}}/sharingProfiles

Headers

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

Path Parameters

• data_source (string, required) - Data source

Query Parameters

• token (string, required) - Auth Token

Request Body

@TODO

{
  "primaryConnectionIdentifier": "8",
  "name": "test",
  "parameters": {
    "read-only": ""
  },
  "attributes": {}
}

Response

Status Code

• 200 - OK

Response Body

@TODO

---

Delete Sharing Profile

Delete sharing profile.

DELETE /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}}

Headers

None.

Path Parameters

• data_source (string, required) - Data source
• sharing_profile (string, required) - Sharing profile identifier

Query Parameters

• token (string, required) - Auth token

Request Body

None.

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Back to Top