Microsoft Graph Scoped Role Memberships

Microsoft Graph Scoped Role Memberships let you programmatically assign and manage Azure AD (Microsoft Entra ID) directory roles with a limited scope to an administrative unit, rather than tenant-wide. Exposed through the scopedRoleMembership resource, these assignments delegate administrative permissions (for example, User Administrator or Helpdesk Administrator) so that the assignee’s authority applies only to the users, groups, or other objects contained in a specific administrative unit.

OpenAPI Specification

scopedrolememberships-openapi-original.yml Raw ↑
openapi: 3.1.0
info:
  title: Microsoft Graph Scopedrolememberships
  description: Needs a description.
paths:
  /scopedRoleMemberships:
    description: >-
      Provides operations to manage the collection of scopedRoleMembership
      entities.
    get:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Get entities from scopedRoleMemberships
      operationId: scopedRoleMemberships.scopedRoleMembership.ListScopedRoleMembership
      parameters:
        - $ref: '#/components/parameters/top'
        - $ref: '#/components/parameters/skip'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/count'
        - name: $orderby
          in: query
          description: Order items by property values
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
        - name: $select
          in: query
          description: Select properties to be returned
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
        - name: $expand
          in: query
          description: Expand related entities
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
      responses:
        2XX:
          $ref: >-
            #/components/responses/microsoft.graph.scopedRoleMembershipCollectionResponse
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Add new entity to scopedRoleMemberships
      operationId: scopedRoleMemberships.scopedRoleMembership.CreateScopedRoleMembership
      requestBody:
        description: New entity
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
        required: true
      responses:
        2XX:
          description: Created entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /scopedRoleMemberships/{scopedRoleMembership-id}:
    description: >-
      Provides operations to manage the collection of scopedRoleMembership
      entities.
    get:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Get entity from scopedRoleMemberships by key
      operationId: scopedRoleMemberships.scopedRoleMembership.GetScopedRoleMembership
      parameters:
        - name: $select
          in: query
          description: Select properties to be returned
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
        - name: $expand
          in: query
          description: Expand related entities
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
      responses:
        2XX:
          description: Retrieved entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Update entity in scopedRoleMemberships
      operationId: scopedRoleMemberships.scopedRoleMembership.UpdateScopedRoleMembership
      requestBody:
        description: New property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Delete entity from scopedRoleMemberships
      operationId: scopedRoleMemberships.scopedRoleMembership.DeleteScopedRoleMembership
      parameters:
        - name: If-Match
          in: header
          description: ETag
          schema:
            type: string
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    parameters:
      - name: scopedRoleMembership-id
        in: path
        description: The unique identifier of scopedRoleMembership
        required: true
        schema:
          type: string
        x-ms-docs-key-type: scopedRoleMembership
  /scopedRoleMemberships/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - scopedRoleMemberships.scopedRoleMembership
      summary: Microsoft Graph Get the number of the resource
      operationId: scopedRoleMemberships.GetCount-dcc4
      parameters:
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
components:
  schemas:
    microsoft.graph.scopedRoleMembership:
      allOf:
        - $ref: '#/components/schemas/microsoft.graph.entity'
        - title: scopedRoleMembership
          required:
            - '@odata.type'
          type: object
          properties:
            administrativeUnitId:
              type: string
              description: >-
                Unique identifier for the administrative unit that the directory
                role is scoped to
            roleId:
              type: string
              description: Unique identifier for the directory role that the member is in.
            roleMemberInfo:
              $ref: '#/components/schemas/microsoft.graph.identity'
            '@odata.type':
              type: string
      x-ms-discriminator-value: '#microsoft.graph.scopedRoleMembership'
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  examples: {}
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
tags:
  - name: scopedRoleMemberships.scopedRoleMembership