orchestrator
2023.10
false
  • Getting Started
  • Swagger Definition
  • Orchestrator APIs
UiPath logo, featuring letters U and I in white

Orchestrator API Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 18, 2024

Roles Requests

Retrieving Info About a Specific Role According to Its Id

This endpoint helps you retrieve details about a particular role based on its ID.

Note: This endpoint only returns folders and roles explicitly set for an auto-provisioned user. The ones inherited from the group configuration can be retrieved through the /api/DirectoryService/GetDirectoryPermissions?userId={userId} endpoint.

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Roles(259)

Request headers

Header

Value

Authorization

Bearer

Request body

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Roles/$entity",
    "Name": "TestRole",
    "DisplayName": "TestRole",
    "Groups": null,
    "IsStatic": false,
    "IsEditable": true,
    "Id": 259
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Roles/$entity",
    "Name": "TestRole",
    "DisplayName": "TestRole",
    "Groups": null,
    "IsStatic": false,
    "IsEditable": true,
    "Id": 259
}

Response code

200 OK

  • Retrieving Info About a Specific Role According to Its Id
  • Request headers
  • Request body
  • Response code

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.