Orchestrator API guide

DELIVERY:

Last updated Feb 13, 2025

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}/odata/Roles(259)

Request headers

Header	Value
Authorization	Bearer

Request body

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