Folders Requests

Assigning a User to a Folder With a Specified Role

POST

{OrchestratorURL}/odata/Folders/UiPath.Server.Configuration.OData.AssignUsers

Request headers

Key	Value
Authorization	Bearer

Request body

{
  "assignments": {
    "UserIds": [58571],
    "RolesPerFolder": [
      {
        "FolderId": 14091,
        "RoleIds": [25]
      }
    ]
  }
}

Response code

204 No Content

Getting All the Users in a Folder and Their Roles

GET

{OrchestratorURL}/odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key=14089,includeInherited=true)?$expand=UserEntity%2CRoles

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Response body

{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#UserRoles",
  "@odata.count": 2,
  "value": [
    {
      "Id": 52454,
      "UserEntity": {
        "UserName": "admin",
        "IsInherited": true,
        "Id": 52454
      },
      "Roles": [
        {
          "Name": "Administrator",
          "Origin": "Assigned",
          "Id": 13
        },
        {
          "Name": "Test",
          "Origin": "Assigned",
          "Id": 25
        }
      ]
    },
    {
      "Id": 58571,
      "UserEntity": {
        "UserName": "Petrix",
        "IsInherited": false,
        "Id": 58571
      },
      "Roles": [
        {
          "Name": "Test",
          "Origin": "Assigned",
          "Id": 25
        }
      ]
    }
  ]
}

Checking If a Folder Is a Personal Workspace

The IsPersonal boolean property in the response body of the \FolderNavigation\GetFolderNavigationContextForCurrentUser endpoint checks if the folder with the queried ID (for example, 302428) is a personal workspace.

GET

{OrchestratorURL}/api/FoldersNavigation/GetFolderNavigationContextForCurrentUser?folderId=302428

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Response body

{
    "Id": 302428,
    "DisplayName": "[e-mail]'s workspace",
    "IsSelectable": true,
    "IsPersonal": true,
    "ProvisionType": "Automatic",
    "Ancestors": [],
    "ChildrenPage": [],
    "ChildrenCount": 0
}