{ "opencollection": "1.0.0", "info": { "name": "Microsoft Graph Admin Admin.admin directoryRoles.directoryRole API", "version": "1.0.0" }, "items": [ { "info": { "name": "directoryRoles.directoryRole", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Graph List directoryRoles", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directoryRoles", "params": [ { "name": "$top", "value": "50", "type": "query", "description": "Show only the first n items" }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the first n items" }, { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items" }, { "name": "$orderby", "value": "", "type": "query", "description": "Order items by property values" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "List the directory roles that are activated in the tenant. This operation only returns roles that have been activated. A role becomes activated when an admin activates the role using the Activate directoryRole API. Not all built-in roles are initially activated. When assigning a role using the Microsoft Entra admin center, the role activation step is implicitly done on the admin's behalf. To get the full list of roles that are available in Microsoft Entra ID, use List directoryRoleTemplates." }, { "info": { "name": "Microsoft Graph Activate directoryRole", "type": "http" }, "http": { "method": "POST", "url": "https://graph.microsoft.com/v1.0/directoryRoles", "body": { "type": "json", "data": "{}" } }, "docs": "Activate a directory role. To read a directory role or update its members, it must first be activated in the tenant. The Company Administrators and the implicit user directory roles (User, Guest User, and Restricted Guest User roles) are activated by default. To access and assign members to other directory roles, you must first activate it with its corresponding directory role template ID." }, { "info": { "name": "Microsoft Graph Get directoryRole", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directoryRoles/:directoryRole-id", "params": [ { "name": "directoryRole-id", "value": "", "type": "path", "description": "The unique identifier of directoryRole" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve the properties of a directoryRole object. The role must be activated in tenant for a successful response. You can use both the object ID and template ID of the directoryRole with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see Role template IDs." }, { "info": { "name": "Microsoft Graph Update entity in directoryRoles", "type": "http" }, "http": { "method": "PATCH", "url": "https://graph.microsoft.com/v1.0/directoryRoles/:directoryRole-id", "params": [ { "name": "directoryRole-id", "value": "", "type": "path", "description": "The unique identifier of directoryRole" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Microsoft Graph Update entity in directoryRoles" }, { "info": { "name": "Microsoft Graph Delete entity from directoryRoles", "type": "http" }, "http": { "method": "DELETE", "url": "https://graph.microsoft.com/v1.0/directoryRoles/:directoryRole-id", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "directoryRole-id", "value": "", "type": "path", "description": "The unique identifier of directoryRole" } ] }, "docs": "Microsoft Graph Delete entity from directoryRoles" }, { "info": { "name": "Microsoft Graph Get directoryRole", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId=':roleTemplateId')", "params": [ { "name": "roleTemplateId", "value": "", "type": "path", "description": "Alternate key of directoryRole" }, { "name": "$select", "value": "", "type": "query", "description": "Select properties to be returned" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand related entities" } ] }, "docs": "Retrieve the properties of a directoryRole object. The role must be activated in tenant for a successful response. You can use both the object ID and template ID of the directoryRole with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see Role template IDs." }, { "info": { "name": "Microsoft Graph Update entity in directoryRoles by roleTemplateId", "type": "http" }, "http": { "method": "PATCH", "url": "https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId=':roleTemplateId')", "params": [ { "name": "roleTemplateId", "value": "", "type": "path", "description": "Alternate key of directoryRole" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Microsoft Graph Update entity in directoryRoles by roleTemplateId" }, { "info": { "name": "Microsoft Graph Delete entity from directoryRoles by roleTemplateId", "type": "http" }, "http": { "method": "DELETE", "url": "https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId=':roleTemplateId')", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "roleTemplateId", "value": "", "type": "path", "description": "Alternate key of directoryRole" } ] }, "docs": "Microsoft Graph Delete entity from directoryRoles by roleTemplateId" }, { "info": { "name": "Microsoft Graph Get the number of the resource", "type": "http" }, "http": { "method": "GET", "url": "https://graph.microsoft.com/v1.0/directoryRoles/$count", "params": [ { "name": "$search", "value": "", "type": "query", "description": "Search items by search phrases" }, { "name": "$filter", "value": "", "type": "query", "description": "Filter items by property values" } ] }, "docs": "Microsoft Graph Get the number of the resource" } ] } ], "bundled": true }