Folder Access API

{
  "folder_access": {
    "direct_groups": [
      {
        "id": 53,
        "name": "Documentation Group",
        "view_on_homepage": "Y",
        "available_in_api": "Y",
        "can_edit": "Y"
      }
    ],
    "direct_users": [
      {
        "id": 168,
        "username": "testuser@metricinsightstest.onmicrosoft.com",
        "display_name": "Test User"
      }
    ],
    "group_users": [
      {
        "id": 193,
        "username": "johnpowers.writer@metricinsights.com",
        "display_name": "John Powers",
        "group_id": 53
      }
    ]
  }
}

{
  "folder_sharing": {
    "direct_on_homepage": [
      {
        "id": 11,
        "username": "michael.turner",
        "display_name": "Michael Turner"
      }
    ],
    "group_on_homepage": [
      {
        "id": 22,
        "username": "sarah.collins",
        "display_name": "Sarah Collins",
        "group_id": 101
      }
    ],
    "direct_via_api": [
      {
        "id": 33,
        "username": "david.martin",
        "display_name": "David Martin"
      }
    ],
    "group_via_api": [
      {
        "id": 44,
        "username": "emily.harris",
        "display_name": "Emily Harris",
        "group_id": 202
      }
    ]
  }
}

• GET request to /api/group_folder returns all folder-to-group associations where Groups members have "Can Add/Remove Content" access to Folder.

1. Item: group_folder.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the group_folder data entry.
   • group: The ID of the Group.
   • folder: The ID of the Folder.
4. Enter an API Token
5. [Run request]

• POST request to /api/group_folder grants Group members "Can Add/Remove Content" access to the Folder.

1. Item: group_folder.
2. Method: POST.
3. Enter the ID of an existing group_folder data entry.
   • See Retrieve Groups That Have Edit Access to Folder for details.
4. Provide values for the request fields.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/group_folder/id/<id> removes "Can Add/Remove Content" access to the Folder from Group members.

1. Item: group_folder.
2. Method: DELETE.
3. Enter the ID of the group_folder data entry to be deleted.
   • See Retrieve Groups That Have Edit Access to Folder for details.
4. Enter an API Token.
5. [Run request]

• GET request to /api/group_folder_view returns all group-to-folder associations where Group members have "Display on homepage" access to Folders.

1. Item: group_folder_view.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the group_folder_view data entry.
   • group: The ID of the Group.
   • folder: The ID of the Folder.
4. Enter an API Token
5. [Run request]

• POST request to /api/group_folder_view grants "Display Folder on Homepage" access to Group members.

1. Item: group_folder_view.
2. Method: POST.
3. Enter the ID of an existing group_folder_view data entry.
   • See Retrieve Groups That Have Homepage View Access to Folder for details.
4. Provide values for the request.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/group_folder_view removes "Display Folder on homepage" access from Group members.                          

1. Item: group_folder_view.
2. Method: DELETE.
3. Enter the ID of group_folder_view data entry that needs to be deleted.
   • See Retrieve Groups That Have Edit Access to Folder for details.
4. Enter an API Token.
5. [Run request]

• GET request to /api/group_folder_api returns all group-to-folder associations where the Group members have the "Available in API Response" access to the Folder.

1. Item: group_folder_view.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the group_folder_api data entry.
   • group: The ID of the Group.
   • folder: The ID of the Folder.
4. Enter an API Token
5. [Run request]

• POST request to /api/group_folder_api grants "Available in API Response" access to group members.

1. Item: group_folder_api.
2. Method: POST.
3. Enter the ID of an existing group_folder_api data entry.
   • See Get Group_Folder Associations for details.
4. Modify the request by providing values.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/group_folder_api removes folder API response access from group members.                          

1. Item: group_folder_api.
2. Method: DELETE.
3. Enter the ID of group_folder_api data entry that needs to be deleted.
   • See Get Group_Folder_API Associations for details.
4. Enter an API Token.
5. [Run request]

• GET request to /api/user_folder returns all folders available to the group members.                            

1. Item: user_folder.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the user_folder data entry.
   • user: The ID of the User.
   • folder: The ID of the Folder.
4. Enter an API Token.
5. [Run request]

• POST request to /api/user_folder grants folder access to group members.

1. Item: user_folder.
2. Method: POST.
3. Enter the ID of an existing user_folder data entry.
   • See Get Group_Folder Associations for details.
4. Modify the request by providing values.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/user_folder/id/<ID> removes folder access from the selected user.

1. Item: user_folder.
2. Method: DELETE.
3. Enter the ID of the user_folder data entry to be deleted.
   • See Get User_Folder Associations for details.
4. Enter an API Token.
5. [Run request]

• GET request to /api/user_folder_view returns all user-to-folder associations where users can see the folder on their homepage.

1. Item: user_folder_view.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the user_folder_view data entry.
   • group: The ID of the Group.
   • folder: The ID of the Folder.
4. Enter an API Token.
5. [Run request]

• POST request to /api/user_folder_view grants "Display Folder on homepage" access to the selected user.                                    

1. Item: user_folder_view.
2. Method: POST.
3. Enter ID of an existing user_folder_view data entry.
   • See Get User_Folder_View Associations for details.
4. Modify the request by providing values.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/user_folder_view/id/<id> removes "Display Folder on homepage" access from the selected user.

1. Item: user_folder_view.
2. Method: DELETE.
3. Enter the ID of the user_folder_view data entry to be deleted.
   • See Get User_Folder_View Associations for details.
4. Enter an API Token.
5. [Run request]

• GET request to /api/user_folder_api returns all user-to-folder associations where the folder is available for the users in the API response.

1. Item: user_folder_api.
2. Method: GET.
3. Filter the results with the following parameters:
   • ID: The ID of the user_folder_api data entry.
   • user: The ID of the Group.
   • folder: The ID of the Folder.
4. Enter an API Token.
5. [Run request]

• POST request to /api/user_folder_api grants "Available in API Response" access to the selected user.                                    

1. Item: user_folder_api.
2. Method: POST.
3. Enter the ID of an existing user_folder_api data entry.
   • See Get User_Folder_API Associations for details.
4. Modify the request by providing values.
   • See Fields Description for details.
5. Enter an API Token.
6. [Run request]

• DELETE request to /api/group_folder_api removes folder API response access from group members.                          

1. Item: group_folder_api.
2. Method: DELETE.
3. Enter the ID of the group_folder_api data entry to remove.
   • See Get Group_Folder_API Associations for details.
4. Enter an API Token.
5. [Run request]