unifiedRoleDefinition resource type

Namespace: microsoft.graph

A role definition is a collection of permissions in Azure Active Directory (Azure AD) listing the operations that can be performed and the resources against which they can performed.

Methods

Method Return Type Description
List unifiedRoleDefinition unifiedRoleDefinition collection Read a list of unifiedRoleDefinition objects, and their properties.
Get unifiedRoleDefinition unifiedRoleDefinition Read the properties of a unifiedRoleDefinition object.
Create unifiedRoleDefinition unifiedRoleDefinition Create a unifiedRoleDefinition object.
Update unifiedRoleDefinition unifiedRoleDefinition Update a unifiedRoleDefinition object.
Delete unifiedRoleDefinition None Delete a unifiedRoleDefinition object.

Properties

Property Type Description
description String The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.
displayName String The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).
id String The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, in).
isBuiltIn Boolean Flag indicating whether the role definition is part of the default set included in Azure Active Directory (Azure AD) or a custom definition. Read-only. Supports $filter (eq, in).
isEnabled Boolean Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.
resourceScopes String collection List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.
rolePermissions unifiedRolePermission collection List of permissions included in the role. Read-only when isBuiltIn is true. Required.
templateId String Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories.
version String Indicates version of the role definition. Read-only when isBuiltIn is true.

Relationships

Relationship Type Description
inheritsPermissionsFrom unifiedRoleDefinition collection Read-only collection of role definitions that the given role definition inherits from. Only Azure AD built-in roles (isBuiltIn is true) support this attribute. Supports $expand.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.unifiedRoleDefinition",
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isBuiltIn": "Boolean",
  "isEnabled": "Boolean",
  "resourceScopes": [
    "String"
  ],
  "rolePermissions": [
    {
      "@odata.type": "microsoft.graph.unifiedRolePermission"
    }
  ],
  "templateId": "String",
  "version": "String"
}